Back to Kinetic Platform Integrations
Handler · Version 1

Kinetic Request CE Format Answers

Download GitHub

About

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

Configurations
Name Description Sample
api_server Kinetic Request CE API Web Application http://server:port/kinetic
api_username Username for an account that has permission to use the API
api_password Password for the API user *********
space_slug The space slug (can also be set as a parameter).
enable_debug_logging Enable debug logging if the value is set to 'Yes'. No
Parameters
Name Description Sample
Error Handling Determine what to return if an error is encountered. Error Message
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. bc682e61-3f2a-11e7-8718-876ea99e5150
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.** Some
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). Other Information,Requested By,Requested For,Number of People Expected,Date and Time Needed
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). Observing Teams
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. 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.
Download GitHub

On This Page

Looking for a workflow engine? Learn more about the Kinetic Data Enterprise Workflow Platform. Check it out
Return to Top