Retrieve All Document Workflows

Retrieve all available document workflows that can be initiated on a set of documents which:

The authenticated user has permissions to view or initiate
Can be initiated through the API

GET/api/{version}/objects/documents/actions

Headers

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

Query Parameters

Name	Description
`loc`	When localized (translated) strings are available, retrieve them by setting `loc` to `true`.

Request

curl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v24.1/objects/documents/actions

Response

{
   "responseStatus": "SUCCESS",
   "data": [
       {
           "name": "Objectworkflow.clinical_study_report_approval__c",
           "label": "Clinical Study Report Approval",
           "type": "multidocworkflow",
           "cardinality": "OneOrMany"
       },
       {
           "name": "Objectworkflow.medical_docs_review_and_approval__c",
           "label": "Medical Docs Review and Approval",
           "type": "multidocworkflow",
           "cardinality": "OneOrMany"
       }
   ]
}

Response Details

On SUCCESS, the response lists all available document workflows and includes the following:

Name	Description
`name`	The workflow name.
`label`	UI Label for the workflow.
`type`	Type of workflow.
`cardinality`	Indicates how many contents (`One`, `OneOrMany`) can be included in a workflow.

For users without the Workflow: Start permission, the response returns an INSUFFICIENT_ACCESS error.