Kinetic Request CE Datastore Submission Retrieve VERSION 1


This handler retrieves a datastore submission by either id or query. If retrieving by query, the query parameter allows anything that can be passed into the query parameter in the datastore submissions endpoint of the Request CE API (including the q= parameter). Before being sent to the Request CE instance, the query is escaped by running the URI.escape() command on the inputted query string. The query that is used to return back a submission should be a query unique enough to bring back one record, although if it is not unique the handler will not currently fail and will instead just return the first submission returned. If searching by id, only the id needs to be inputted to return that submission.


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).
Retrieve ByHow to retrieve the submission. Id or Query.
Datastore Form SlugSlug of the form to query
IndexThe index to use for the search/retrieval
QueryA query that will retrieve a single submission
Datastore Submission IdThe id of the submission being retrieved.

Sample Configuration

NameDescription
Error HandlingError Message
Space Slug
Retrieve ById
Datastore Form Slugcars
Index
Query
Datastore Submission Id29f141f3-f00c-11e7-9a71-0506559f5412

Results

NameSample Result
Handler Error MessageError message if an error was encountered and Error Handling is set to "Error Message".
IDID of the submission that was entered.
LabelLabel of the submission.
HandleHandle of the submission.
Core StateStatus: Draft, Submitted, or Closed.
Current PageName of the current page.
Submitted AtSubmitted Date/Time
Submitted ByThe submitter's User ID
Updated AtClosed Date/Time
Updated ByUser ID for Last Updated
Created AtCreated Date/Time
Created ByUser ID that created the submission
Form DescriptionDescription on the submission's form
Form NameName of the submission's form
Form NotesNotes on the submission's form
Form SlugSlug of the submission's form
Form StatusStatus of the submission's form
Values JSONA JSON representation of the values found on the submission

Changelog

Kinetic Request CE Datastore Submission Retrieve 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 Datastore Submission Retrieve V1 (2018-05-03)

* Initial version. See README for details.