Kinetic Request CE Datastore Submission Search VERSION 1


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

NameDescription
Error HandlingDetermine what to return if an error is encountered.
Space SlugThe Space the submission is being retrieved from (defaults to info value if not provided).
Datastore Form SlugThe slug of the Datastore Form to search for submissions in.
IndexThe index to use for the search.
QueryThe query that will be used to search the submissions. Ex: values[company]=Kinetic
LimitAn integer representing the max results that the search can return.
Return TypeThe format that the results should be returned in.

Sample Configuration

NameDescription
Error HandlingError Message
Space Slug
Datastore Form Slugcars
Indexvalues[Make]
Queryvalues[Make]="Ford"
Limit100
Return TypeJSON

Results

NameSample Result
Handler Error MessageError message if an error was encountered and Error Handling is set to "Error Message".
CountThe number of submissions that have been returned.
ResultList of submissions that match the query --JSON,XML, or ID List

Changelog

No Changelog Available.