Kinetic Request CE Submission Search Version 1

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.
Query The query that will be used to search the submissions. Ex: values[company]=Kinetic
Return Type The format that the results should be returned in.

Sample Configuration

Name Description
Error Handling Error Message
Space Slug
Kapp Slug catalog
Form Slug test-form
Query include=values&limit=100&q=values[Any Text] IN ("Testing","String")
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

Changelog

Kinetic Request CE Submission Search V1.1 (2018-05-25)

  • API Server Info Value changed to allow ${space} in the url for subdomain support

(ie. https://${space}.localhost:8080/kinetic)

Kinetic Request CE Submission Search V1 (2017-11-08)

  • Initial version. See README for details.


Related Handlers

Kinetic Request CE Attachment Create
Creates a plaintext attachment and uploads it to a Kinetic Request CE Form.
Kinetic Request CE Attachment Upload
Retrieves a an attachment from Kinetic Filehub and uploads it to a Request CE form.
Kinetic Request CE Attribute Values Retrieve
Returns attributes for the provided slugs.
Kinetic Request CE Bridge Model Create
Creates a Bridge Model in Kinetic Request CE.
Kinetic Request CE Cascading Attribute Value Retrieve
Returns the matched value of the "Property to Return" parameter for the given scope. If the Context is Submission, this handler will search for a matching submission value, if none found, it will search the form, then kapp, then space for a match.
Kinetic Request CE Datastore Submission Activity Create
Creates a submission activity record in Kinetic Request CE.
Kinetic Request CE Datastore Submission Activity Update
Updates a submission activity record in Kinetic Request CE.
Kinetic Request CE Datastore Submission Delete
Deletes a Datastore Submission record in Kinetic Request CE for the specified space.
Kinetic Request CE Datastore Submission Update
Updates a Datastore Submission record in Kinetic Request CE for the specified space.
Kinetic Request CE Form Retrieve
Retrieves a form record in Kinetic Request CE for the specified space.
Kinetic Request CE Form Update
Updates a form in Kinetic Request CE for the specified space, kapp and form.
Kinetic Request CE Kapp Retrieve
Retrieves a Kapp record in Kinetic Request CE.
Kinetic Request CE Password Change
Changes the password for a User record for the specified space in Kinetic Request CE.
Kinetic Request CE Space Delete
Deletes a Space in Kinetic Request CE.
Kinetic Request CE Space Update
Retrieves a Space record in Kinetic Request CE.
Kinetic Request CE Submission Activity Retrieve
Retrieves a submission activity record in Kinetic Request CE.
Kinetic Request CE Submission Clone
Clones a Submission record in Kinetic Request CE for the specified space and orig submission.
Kinetic Request CE Submission Get Answers
Retrieves all answers for a given submission and formats them into a name value pair result list and json/dataset result. Allows for including, excluding, and or aliasing fields.
Kinetic Request CE Submission Retrieve Associated Attributes
Retrieves a Submission record including all associated values, form attributes, kapp attributes and space attributes.
Kinetic Request CE Submission Retrieve
Retrieves a Submission record in Kinetic Request CE for the specified space.
Kinetic Request CE Submission Update
Updates a Submission record in Kinetic Request CE for the specified space.
Kinetic Request CE Team Create
Creates a team record in Kinetic Request CE for the specified space.
Kinetic Request CE Team Membership Create
Adds the given user to the given team.
Kinetic Request CE Team Membership Delete
Removes the given user from the given team.
Kinetic Request CE Team Retrieve
Retrieves a team in Kinetic Request CE in the specified space.
Kinetic Request CE Team Update
Updates a Team record in Kinetic Request CE for the specified space.
Kinetic Request CE User Create
Creates a User record in Kinetic Request CE for the specified space.
Kinetic Request CE User Retrieve
Retrieves a User record in Kinetic Request CE for the specified space.
Kinetic Request CE User Update
Updates a User record in Kinetic Request CE for the specified space.