Skip to main content
Kinetic Community

Kinetic Request CE Datastore Submission Search

Searches a Datastore 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_datastore_submission_search_v1.zip

Detailed Description

Given a Request CE Space and Datastore Form, searches for submissions with a given query. The query, index, and limit parameters are used to build the full query that will be passed to the datastore submissions endpoint of the Request CE API (all requests will also add ?include=values,form,details to the query). 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).
Datastore Form Slug The slug of the Datastore Form to search for submissions in.
Index The index to use for the search.
Query The query that will be used to search the submissions. Ex: values[company]=Kinetic
Limit An integer representing the max results that the search can return.
Return Type The format that the results should be returned in.

Sample Configuration

Parameter Example Configuration
Error Handling Error Message
Space Slug
Datastore Form Slug cars
Index values[Make]
Query values[Make]="Ford"
Limit 100
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.
Result List of submissions that match the query --JSON,XML, or ID List

Change Log

Version Date Description
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 2018-05-03 * Initial version. See README for details.