Skip to main content
Kinetic Community

Kinetic Request CE Submission Retrieve

Retrieves a Submission record in Kinetic Request CE for the specified space.

Downloads

By downloading this file, you acknowledge that you agree to our Terms of Service

kinetic_request_ce_submission_retrieve_v2.zip

Detailed Description

This handler retrieves a submission by either id or query. If retrieving by query, the handler queries the given space/kapp/form in the form of q={inputted_query}. 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.
Kapp Slug Slug of the kapp to query
Form Slug Slug of the form to query
Query A query that will retrieve a single submission
Submission Id The id of the submission being retrieved.

Sample Configuration

Parameter Example Configuration
Error Handling Error Message
Space Slug
Retrieve By Query
Kapp Slug test-kapp
Form Slug test-form
Query values[Unique Field]="unique value"
Submission Id

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 (last 6 of ID)
Origin Originating ID. This is typically the ID of a different submission.
Parent Parent ID.
Submitted At Submitted Date/Time
Submitted By User that submitted the submission
Type
Updated At Closed Date/Time
Updated By User ID for Last Updated
Closed At Closed Date/Time
Core State Status: Draft, Submitted, or Closed
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
Kapp Name Name of the submission's kapp
Kapp Slug Slug of the submission's kapp
Current Page The Current Page of the submission
Values JSON JSON Result of submission's Values

Change Log

Version Date Description
2.3 2018-06-11 * Added support for submission searching at the Kapp level without a Form Slug.
* Updated handler to return a submissions values as well as a JSON map (ie. searching by kapp fields)
2.2 2018-05-25 * API Server Info Value changed to allow ${space} in the url for subdomain support (ie. https://${space}.localhost:8080/kinetic)
2 2017-11-19 * Added the ability to retrieve by query while also keeping the search by id option
1.1 2017-01-30 * Change the origin/parent to return a JSON string.
1 2016-04-25 * Initial version. See README for details.
* Added Kapp Name and Kapp Slug to results