Initiate Object Action on a Single Record

Use this request to initiate an action on a specific object record.

POST/api/{version}/vobjects/{object_name}/{object_record_id}/actions/{action_name}

Headers

Name	Description
`Content-Type`	`application/x-www-form-urlencoded`
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`object_name`	The object `name__v` field value.
`object_record_id`	The object record `id` field value from which to retrieve user actions.
`action_name`	The name of the `Objectaction` or `Objectlifecyclestateuseraction` to initiate. You can retrieve this from the Retrieve User Actions request. The format for `action_name` is `Objectaction.{vobject}.{action}` or `Objectlifecyclestateuseraction.{vobject}.{state}.{action}`. For example, `Objectlifecyclestateuseraction.country__v.active_state__c.start_wf_useraction__c`.

Body Parameters

Include any parameters required to initiate the action as name-value pairs in the request body. You can retrieve the required parameters for your action by Retrieving Object User Action Details.

Name	Description
`{participant_group_name}.assignment_type__c` conditional	The participant group assignment type for a workflow task, either `assigned` or `available`. Required if the workflow initiator must select either Assigned to every user or Available to any user when assigning participants to a task in the workflow start step. For example, `part_reviewers__c.assignment_type__c=assigned`.
`storyEventKey` optional	The ID of the target Story Event object record when executing the Apply Milestone Template action. This is only applicable in Clinical Operations Vaults.

Values in Required Field Prompts

When providing values for field prompts on a start step, task step, or verdict, required fields cannot be omitted, set as blank, or defaulted to their existing value.

To preserve the existing value of a required field prompt, submit the existing value as the new value.

Request

curl -X POST -H "Authorization: {SESSION_ID}" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d 'due_date__c=2020-03-01T08:00:00.000Z' \
-d 'product__v.generic_name__c=nitroprinaline oxalate' \
-d 'product__v.internal_name__c=Nyaxa' \
-d 'product__v.compound_id__c=CC-127' \
-d 'approvers__c=user:10001399' \
https://myvault.veevavault.com/api/v25.1/vobjects/product__v/00P000000000301/actions/Objectlifecyclestateuseraction.product__v.active_state__c.start_workflow_useraction__c

Response

{
    "responseStatus": "SUCCESS"
}