Retrieve Bulk Workflow Action Details

Once you’ve retrieved the available workflow actions, use this request to retrieve the details for a specific workflow action.

GET/api/{version}/object/workflow/actions/{action}

Headers

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

URI Path Parameters

Name	Description
`action`	The `name` of the workflow action. To get this value, Retrieve Bulk Workflow Actions.

Request

curl -L -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v25.3/object/workflow/actions/cancelworkflows

Response

{
   "responseStatus": "SUCCESS",
   "data": {
       "name": "cancelworkflows",
       "controls": [
           {
               "prompts": [
                   {
                       "multi_value": true,
                       "label": "Workflow Ids",
                       "required": true,
                       "name": "workflow_ids"
                   }
               ],
               "type": "field",
               "label": "Fields"
           }
       ]
   }
}

Response Details

On SUCCESS, the response returns metadata for the specified workflow action, including the fields required to execute the action.

For each control, the following data may be returned:

Name	Description
`label`	UI label for the control.
`type`	Type of control.
`prompts`	The input prompts which accept values when initiating a workflow action.

For each prompt, the following data may be returned:

Name	Description
`multi_value`	If `true`, indicates that the field accepts multiple values.
`label`	UI label for the prompt.
`required`	If `true`, indicates that the field is required to initiate the workflow action.