Retrieves a Datastore Submission record in Kinetic Request CE for the specified space.
Detailed Description
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
| 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). |
| Retrieve By |
How to retrieve the submission. Id or Query. |
| Datastore Form Slug |
Slug of the form to query |
| Index |
The index to use for the search/retrieval |
| Query |
A query that will retrieve a single submission |
| Datastore Submission Id |
The id of the submission being retrieved. |
Sample Configuration
| Parameter |
Example Configuration |
| Error Handling |
Error Message |
| Space Slug |
|
| Retrieve By |
Id |
| Datastore Form Slug |
cars |
| Index |
|
| Query |
|
| Datastore Submission Id |
29f141f3-f00c-11e7-9a71-0506559f5412 |
Results
| Name |
Description |
| Handler Error Message |
Error message if an error was encountered and Error Handling is set to "Error Message". |
| ID |
ID of the submission that was entered. |
| Label |
Label of the submission. |
| Handle |
Handle of the submission. |
| Core State |
Status: Draft, Submitted, or Closed. |
| Current Page |
Name of the current page. |
| Submitted At |
Submitted Date/Time |
| Submitted By |
The submitter's User ID |
| Updated At |
Closed Date/Time |
| Updated By |
User ID for Last Updated |
| Created At |
Created Date/Time |
| Created By |
User ID that created the submission |
| Form Description |
Description on the submission's form |
| Form Name |
Name of the submission's form |
| Form Notes |
Notes on the submission's form |
| Form Slug |
Slug of the submission's form |
| Form Status |
Status of the submission's form |
| Values JSON |
A JSON representation of the values found on the submission |
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. |
