Retrieve Workflow Actions

Retrieve all available workflow actions that can be initiated on a specific object workflow.

GET/api/{version}/objects/objectworkflows/{workflow_id}/actions

Headers

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

URI Path Parameters

Name	Description
`{workflow_id}`	The workflow `id` field value.

Query Parameters

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

Request

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

Response

{
  "responseStatus": "SUCCESS",
  "data": [
    {
      "name": "startApproval",
      "label": "Start Approval"
    },
    {
      "name": "cancel",
      "label": "Cancel"
    }
  ]
}

Response Details

On SUCCESS, the response lists all available workflow actions that can be initiated on the object record. Each action includes the following fields:

name - The workflow action name used to initiate the workflow in the request below.
label - The workflow action label as seen in the UI.