Complete a Form Task (v7 only)
| name | type | required | description |
|---|---|---|---|
| process_sid | string | yes | Unique Identifier for the Process |
| task_sid | string | yes | Unique Identifier for the Process task, found in the Task list for the process |
| instance_sid | string | no | Unique Identifier for the Request if completing a form task that is already in progress. Must be supplied as a query string parameter |
| reciptask_sid | string | no | Unique Identifier for the Recipient Task if completing a form task that is already in progress. Must be supplied as a query string parameter |
| parent_sid | string | no | Unique Identifier for the Parent Req1uest if any |
| client_sid | string | no | Unique Identifier for the User SID to submit on behalf of |
| request_name | string | no | Name for the request |
| isDraft | boolean | no | specify if this is a save darft or submit |
| body | object | yes | Initialization data to fill the questions of the form task in the process and request options for IsDraft, request_name, parent_sid and client _sid (see above). The best place to retrieve the key (ID), dom_id (Client ID), label (Label), and QuestionType (Field Type) values for your questions is from the Fields To Capture section in the Advanced Settings tab of the form task. |
Append your key and the token obtained from either Access/exchange-token or Access/impersonate to the querystring (key=mykey&token=kj123khb123hb123hb123jh123) or to the headers (Authorization:Bearer kj123khb123hb123hb123jh123) of your request.
{
"isDraft": false,
"parent_sid": "optional",
"request_name": "optional",
"client_sid": "optional",
"questions":[
{
"key":"1532703431041",
"label":"question2: ",
"value":"hello there",
"QuestionType":"ShortText",
"dom_id":"txtQuestion2",
"type":"string"
},
{
"key":"1532703420919",
"label":"question1: ",
"value":"1",
"QuestionType":"Number",
"dom_id": "numQuestion1",
"type":"Numeric"
},
{
"key":"1540239046936",
"label":"question3: ",
"value":"Option1|Option2",
"QuestionType":"DbCheckbox",
"dom_id": "chkQuestion3",
"type":"string"
}
]
}
{
"instance_sid": "5b6bf03b-5929-4a28-af23-53b522ebd5c1111",
"next_tasks": []
}