Retrieve Binder User Actions
Retrieve all available user actions on a specific version of a binder which:
- The authenticated user has permission to view or initiate.
- Can be initiated through the API. See supported user actions.
- Is not currently in an active workflow.
GET
/api/{version}/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/lifecycle_actionsHeaders
Section link for Headers| Name | Description |
|---|---|
Accept | application/json (default) or application/xml |
URI Path Parameters
Section link for URI Path Parameters| Name | Description |
|---|---|
{binder_id} | The id field value of the binder from which to retrieve available user actions. |
{major_version} | The major version number of the binder. |
{minor_version} | The minor version number of the binder. |
Request
Section link for Requestcurl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v25.2/objects/binders/17/versions/0/1/lifecycle_actionsResponse
Section link for Response{
"responseStatus": "SUCCESS",
"responseMessage": "Success",
"lifecycle_actions__v": [
{
"name__v": "request_content__c",
"label__v": "Send to Content Creator",
"lifecycle_action_type__v": "workflow",
"lifecycle__v": "job_processing__c",
"state__v": "draft__c",
"executable__v": true,
"entry_requirements__v": "https://myvault.veevavault.com/api/v25.2/objects/binders/152/versions/0/1/lifecycle_actions/request_content__c/entry_requirements"
},
{
"name__v": "submit_for_review__c",
"label__v": "Submit for Review",
"lifecycle_action_type__v": "workflow",
"lifecycle__v": "job_processing__c",
"state__v": "draft__c",
"executable__v": true,
"entry_requirements__v": "https://myvault.veevavault.com/api/v25.2/objects/binders/152/versions/0/1/lifecycle_actions/submit_for_review__c/entry_requirements"
},
{
"name__v": "review_annotate__c",
"label__v": "Review & Annotate",
"lifecycle_action_type__v": "workflow",
"lifecycle__v": "job_processing__c",
"state__v": "draft__c",
"executable__v": true,
"entry_requirements__v": "https://myvault.veevavault.com/api/v25.2/objects/binders/152/versions/0/1/lifecycle_actions/review_annotate__c/entry_requirements"
}
]
}Response Details
Section link for Response DetailsThe response lists all available user actions (lifecycle_actions__v) that can be initiated on the specified version of the binder.