Skip to main content

IMPORTANT - Product End of Life Statement - IMPORTANT

Request RE, Survey, and Calendar 1.5 Support Ending December 31, 2020
Contact Kinetic Data Support with Questions
Kinetic Community

Kinetic Request CE Submission Search

Searches a kapp or form for submissions and returns any matching submission objects in the specified return format.

Downloads

By downloading this file, you acknowledge that you agree to our Terms of Service

kinetic_request_ce_submission_search_v2.zip

Detailed Description

Given a Request CE Space, Kapp, and optional Form, searches for submissions with a given query. The query parameter allows anything that can be passed into the query parameter in the /submissions endpoint of the Request CE API (including the limit= and q= parameters). Before being sent to the Request CE instance, the query is escaped by running the URI.escape() command on the inputted query string. After all the submissions that match the query have been returned, the handler formats it into one of three possible output formats: a JSON string, an XML string, or an XML list of submission ids.

If ID List is selected as the Return Type, the output looks like:

f4cd6acf-e552-11e5-9c32-97bbc6bf7f84bbc6bf7f-...

Note: The limit by default for submissions in 25, so if you want to retrieve more submissions than that add a limit=n (where n is an integer representing the new limit) to the query string

Parameters

Name Description
Error Handling Determine what to return if an error is encountered.
Space Slug The Space the submission is being retrieved from (defaults to info value if not provided).
Kapp Slug The slug of the Kapp to search for submissions in.
Form Slug The slug of the Form to search for submissions in.
Include Comma-separated list of properties to include in the response. Options include 'details', 'activities', 'children', 'descendants', 'form', 'origin', 'parent', 'type', 'values', 'values.raw', and 'values[FIELD NAME]'. Note: Ignored if return type is ID List
Core State Searches for submissions that have a core state that matches this parameter. Options are 'Draft', 'Submitted', 'Closed'. If no value is provided, the results will contain submissions in all core states.
Timeline Date property to search by. Options are 'createdAt','submittedAt','updatedAt', and 'closedAt'. The default value is 'createdAt'.
Direction Result Set sorting direction. Options are 'ASC' and 'DESC' The default value is descending (DESC).
Start Start date/time of the timeline. This value should be used to both refine and limit the search results. Format: yyyy-MM-ddTHH:mm:ssZ
End End date/time of the timeline. This value should be used to both refine and limit the search results. Format: yyyy-MM-ddTHH:mm:ssZ
Limit Limit the number of results returned. If not provided, the server will limit the results to 25 submissions. Maximum value 1000.
Query The query that will be used to search the submissions. Ex: values[Company]="Kinetic"
Page Token The value to use as the offset for the page of submissions to return. The submission that matches this value will not be included in the results.
Return Type The format that the results should be returned in.

Sample Configuration

Parameter Example Configuration
Error Handling Error Message
Space Slug
Kapp Slug catalog
Form Slug test-form
Include
Core State
Timeline
Direction
Start
End
Limit 1000
Query include=values&limit=100&q=values[Any Text] IN ("Testing","String")
Page Token 70b37e5f-d64c-11e8-bbc0-ebb51a7fa935
Return Type JSON

Results

Name Description
Handler Error Message Error message if an error was encountered and Error Handling is set to "Error Message".
Count The number of submissions that have been returned.
Next Page Token The ID of the last submission retrieved by the API if the Limit input is reached. This can be used in a subsequent call to continue retrieve results.
Result List of submissions that match the query --JSON,XML, or ID List

Change Log

Version Date Description
2 2019-01-14 * Updated handler to include all API options as input and Next Page Token as an output.
1.1 2018-05-25 * API Server Info Value changed to allow ${space} in the url for subdomain support (ie. https://${space}.localhost:8080/kinetic)
1 2017-11-08 * Initial version. See README for details.