Complete Multi-item Workflow Task

Complete an open workflow task for a multi-item workflow. This endpoint does not support initiating task actions requiring eSignatures (where esignature is true). To provide multiple verdicts for items without completing an open workflow task, use Manage Multi-item Workflow Content.

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

Headers

Name	Description
`Content-Type`	`application/json`
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`{task_id}`	The task `id` field value.

Body Parameters

Controls with required=true 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, a specific verdict may prompt for comments, reasons, or capacities.

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.

In the body of the request, upload parameters as a JSON file. This request may require the following body parameters:

Name	Description
`verdict_public_key__c` conditional	The verdict name. Retrieve possible verdict `name` values by sending a request to Retrieve Workflow Task Action Details.
`reason__c` conditional	The reason name. Retrieve possible reason `name` values by sending a request to Retrieve Workflow Task Action Details.
`capacity__c` conditional	The capacity name. Retrieve possible capacity `name` values by sending a request to Retrieve Workflow Task Action Details.

Request: Single Verdict

curl -X POST -H "Authorization: {SESSION_ID}" \
--data-raw '[
    {
        "verdict_public_key__c": "verdict_not_approved__c",
        "verdict_not_approved_comment__c": "Needs to be redone."
    }
]' \
https://myvault.veevavault.com/api/v26.1/objects/objectworkflows/tasks/9626/actions/mdwcomplete

Request: Multiple Verdicts

curl -X POST -H "Authorization: {SESSION_ID}" \
--data-raw '[
    {
        "task_comment__v": "Some of these batches need to be reprocessed.",
        "contents__sys": [
            {
                "object__v": "batch__v",
                "record_id__v": "0BA000000000101",
                "verdict_public_key__c": "verdict_not_approved__c",
                "verdict_not_approved_comment__c": "Needs to be redone."
            },
            {
                "object__v": "batch__v",
                "record_id__v": "0BA000000002001",
                "verdict_public_key__c": "verdict_approved__c"
            },
            {
                "object__v": "batch__v",
                "record_id__v": "0BA000000002002",
                "verdict_public_key__c": "verdict_not_approved__c",
                "verdict_not_approved_comment__c": "Does not meet standards."
            }
        ]
    }
]' \
https://myvault.veevavault.com/api/v26.1/objects/objectworkflows/tasks/9626/actions/mdwcomplete

Response

{
    "responseStatus": "SUCCESS"
}

Response Details

On SUCCESS, Vault completes the workflow task on behalf of the authenticated user.