Kinetic Request CE Format Answers
Version 1
Builds an XML of the fields on the form. For example, if the form held two fields, color and size, the response might look like this:
{"color":"Red","size":"Small"}
<table><tr><th>Field</th><th>Answer Value</th></tr><tr><td>color</td><td>Red</td></tr><tr><td>size</td><td>Small</td></tr></table>
color: Red\nsize: Small\n
Red
Small
Parameters
| Name |
Description |
| Error Handling |
Determine what to return if an error is encountered. |
| JSON Answer Set |
JSON Answer set to format. Either this or submission ID needs to be specified. |
| Space Slug |
The Space the submission is being retrieved from (defaults to info value if not provided). |
| Submission ID |
The id of the submission to retrieve answers for. Either this or submission ID needs to be specified. |
| Mode |
If 'All' the entire set of fields will be used. If 'Some' the fields listed in the 'Included Fields' parameter will be used. **In both cases, fields listed in the 'Excluded Fields' parameter will never be included in the generated output.** |
| Included Fields |
A comma separated list of field names that should be explicitly included in the field list. This is only required if the 'Mode' parameter is set to 'Some'. Whitespace matters; ensure there are no spaces after a comma separating the field names (unless the field names includes a preceding space). |
| Excluded Fields |
A comma separated list of field names that should be explicitly excluded from the field list. Fields included in this list will be excluded even if they are included in the 'Included Fields' parameter. Whitespace matters; ensure there are no spaces after a comma separating the field names (unless the field name includes a preceding space). |
| Field Aliases |
A specially formatted mapping of field names in the answer hash to labels to be used in the answer set. This is necessary when an answer should be forwarded via answer set, but the field name varies from form to form. The alias format is as follows: OldQuestionLabel=NewQuestionLabel,RequesterFirstName=FirstName. |
Sample Configuration
| Name |
Description |
| Error Handling |
Error Message |
| Space Slug |
|
| Submission ID |
bc682e61-3f2a-11e7-8718-876ea99e5150 |
| JSON Answer Set |
|
| Mode |
Some |
| Included Fields |
Other Information,Requested By,Requested For,Number of People Expected,Date and Time Needed |
| Excluded Fields |
Observing Teams |
| Field Aliases |
Other Information=Details,Date and Time Needed=Lunch Time |
Results
| Name |
Description |
| Handler Error Message |
Error message if an error was encountered and Error Handling is set to "Error Message". |
| JSON |
|
| HTML |
|
| List |
|
| ### Placeholder for field name ### |
|
Changelog
Kinetic Request CE Format Answers 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 Format Answers V1 (2017-05-25)
- Initial version. See README for details.
Related Handlers
- Kinetic Request CE Attachment Copy
- This handler is used to copy an attachment from one submission to another.
- Kinetic Request CE Attachment Create
- Creates a plaintext attachment and uploads it to a Kinetic Request CE Form.
- Kinetic Request CE Attachment Temp Link Retrieve
- Retrieves file attachment information for a submitted attachment field in Kinetic Request CE. This information also contains the URL for each attachment so the file can be downloaded from the file store.
- Kinetic Request CE Attachment Upload
- Retrieves a an attachment from Kinetic Filehub and uploads it to a Request CE form.
- Kinetic Request CE Attribute Definition Create
- Creates an Attribute Definition in Kinetic Request CE.
- 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 Bridge Update
- Updates a Bridge 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 Create Password Reset Token
- Creates a password reset token for a user.
- Kinetic Request CE Datastore Submission Activity Create
- Creates a submission activity record in Kinetic Request CE.
- Kinetic Request CE Datastore Submission Activity Retrieve
- Retrieves 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 Create
- Creates a Datastore Submission record in Kinetic Core for the specified space.
- Kinetic Request CE Datastore Submission Delete
- Deletes a Datastore Submission record in Kinetic Request CE for the specified space.
- Kinetic Request CE Datastore Submission Retrieve
- Retrieves a Datastore Submission record in Kinetic Request CE for the specified space.
- Kinetic Request CE Datastore Submission Search
- Searches a Datastore Form for submissions and returns any matching submission objects in the specified return format.
- Kinetic Request CE Datastore Submission Update
- Updates a Datastore Submission record in Kinetic Request CE for the specified space.
- Kinetic Request CE Form Create
- Creates a form record in Kinetic Request CE for the specified space. If the form exists, nothing happens
- Kinetic Request CE Form Retrieve
- Retrieves a form record in Kinetic Request CE for the specified space.
- Kinetic Request CE Form Type Create
- Creates a Form Type in Kinetic Request CE.
- 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 Kapp Update
- Updates a Kapp in Kinetic Request CE for the specified space.
- Kinetic Request CE Password Change
- Changes the password for a User record for the specified space in Kinetic Request CE.
- Kinetic Request CE Space Admin Retrieve
- Retrieves a User record in Kinetic Request CE for the specified space.
- Kinetic Request CE Space Delete
- Deletes a Space in Kinetic Request CE.
- Kinetic Request CE Space Retrieve
- Retrieves a Space record in Kinetic Request CE.
- Kinetic Request CE Space Update
- Retrieves a Space record in Kinetic Request CE.
- Kinetic Request CE Submission Activity Create
- Creates a submission activity record in Kinetic Request CE.
- Kinetic Request CE Submission Activity Retrieve
- Retrieves a submission activity record in Kinetic Request CE.
- Kinetic Request CE Submission Activity Update
- Updates 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 Create
- Creates a Submission record in Kinetic Core for the specified space.
- Kinetic Request CE Submission Delete
- Deletes a Submission record in Kinetic Request CE for the specified space.
- 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 Reset
- Reset a Submission record in Kinetic Request CE for the specified space.
- 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 Children
- Returns a submissions children as an ID List, JSON, or XML
- Kinetic Request CE Submission Retrieve
- Retrieves a Submission record in Kinetic Request CE for the specified space.
- Kinetic Request CE Submission Search
- Searches a kapp or form for submissions and returns any matching submission objects in the specified return format.
- 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.
1-651-556-1030
sales@kineticdata.com
