Initiate Workflow Task Action

Initiate a workflow task action. Note that the API does not support initiating task actions requiring eSignatures (where esignature is true).

POST/api/{version}/objects/objectworkflows/tasks/{task_id}/actions/{task_action}

Headers

Name	Description
`Content-Type`	`application/json` or `application/x-www-form-urlencoded`
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`{task_id}`	The task `id` field value.
`{task_action}`	The name of the task action retrieved from Retrieve Workflow Task Actions.

Body Parameters

Required parameters depend on the action being initiated. Controls marked as required in the Retrieve Workflow Task Action Details response must be provided. If a control (such as verdict) defines a set of required fields, those must also be provided.

For example, the following request parameters may apply to the complete action:

Name	Description
`verdict`	The verdict name returned in Retrieve Workflow Task Action Details.
`reason`	The reason name returned in Retrieve Workflow Task Action Details.
`capacity`	The capacity name returned in Retrieve Workflow Task Action Details.

The cancel action doesn't require any parameters.

For workflows where type is set to multidocworkflow and cardinality is set to One, Vault pre-populates document field values in field prompts. If you include keys for field prompts without values, Vault submits a blank field value on the document.

Request

curl -X POST -H "Authorization: {SESSION_ID}" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json" \
--data-urlencode "verdict_public_key__c=verdict_impact_assessment_complete__c" \
--data-urlencode "capacity__c=capacity_0_0__c" \
--data-urlencode "reason__c=reason_0_0__c" \
https://myvault.veevavault.com/api/v23.1/objects/objectworkflows/tasks/502/actions/complete

Response

{
    "responseStatus": "SUCCESS"
}