Version 1
Connector Overview: This page documents all 343 actions for the Veevaconnector v1.
Audit History (2)
GET Retrieve Complete Audit History for a Single Document
/objects/documents/{doc_id}/audittrail
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Audit_History
Retrieve complete audit history for a single document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Complete Audit History for a Single Object Record
/vobjects/{object_name}/{object_record_id}/audittrail
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Audit_History
Retrieve complete audit history for a single object record.
Vault does not audit individual field values for newly created records. For example, the audit trail for a new Product record would only include a single entry, and the Event Description would be “Product: CholeCap created”. We recommend exporting the current record along with the audit trail to ensure a complete export of all values. When a user deletes an object record, the audit trail captures all field values.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Audit (3)
GET Retrieve Audit Details
/audittrail/{audit_trail_type}
https://developer.veevavault.com/api/23.1/#Retrieve_Audit_Details
Retrieve all audit details for a specific audit type. This request supports optional parameters to narrow the results to a specified date and time within the past 30 days.
You can run a full audit export with the same formatting as exports you initiate in the UI once per day per audit type. To execute a full audit export, set all_dates to true, leave start_date and end_date blank, and set format_result to csv. When the job is complete, you will receive an email containing links to a zipped file for each year.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Audit Metadata
/metadata/audittrail/{audit_trail_type}
https://developer.veevavault.com/api/23.1/#Retrieve_Audit_Metadata
Retrieve all fields and their metadata for a specified audit trail or log type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Audit Types
/metadata/audittrail
https://developer.veevavault.com/api/23.1/#Retrieve_Audit_Types
Retrieve all available audit types you have permission to access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Authentication (6)
POST Authentication Type Discovery
/discovery
https://developer.veevavault.com/api/23.1/#Discovery
Discover the authentication type of a user. With this API, applications can dynamically adjust the login requirements per user, and support either username/password or OAuth2.0 / OpenID Connect authentication schemes.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST OAuth 2.0 / OpenID Connect
/oauth/session/{oath_oidc_profile_id}
https://developer.veevavault.com/api/23.1/#OAuth2_OIDC_Auth
Authenticate your account using OAuth 2.0 / Open ID Connect token to obtain a Vault Session ID. Learn more about OAuth 2.0 / Open ID Connect in Vault Help.
When requesting a sessionId, Vault allows the ability for Oauth2/OIDC client applications to pass the client_id with the request. Vault uses this client_id when talking with the introspection endpoint at the authorization server to validate that the access_token presented by the application is valid. Learn more about Client ID in the REST API Documentation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve API Versions
/
https://developer.veevavault.com/api/23.1/#Retrieve_Versions
Retrieve all supported versions of the Vault REST API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Session Keep Alive
/keep-alive
https://developer.veevavault.com/api/23.1/#Keep_Alive
Given an active sessionId, keep the session active by refreshing the session duration.
A Vault session is considered active as long as some activity (either through the UI or API) happens within the maximum inactive session duration. This maximum inactive session duration varies by Vault and is configured by your Vault Admin. The maximum active session duration is 48 hours, which is not configurable. Learn more about best practices for session management.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST User Name and Password
/auth
https://developer.veevavault.com/api/23.1/#Basic_Auth
Authenticate your account using your Vault user name and password to obtain Vault Session ID. Vault limits the number of Authentication API calls based on the user name and the domain name used in the API call. To determine the Vault Authentication API burst limit for your Vault or the length of delay for a throttled response, check the response headers or the API Usage Logs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Your Vault user name assigned by your administrator. |
|
|
Your Vault password associated with your assigned vault user name. |
GET Validate Session User
/objects/users/me
https://developer.veevavault.com/api/23.1/#Validate_Session
Given a valid session ID, this request returns information for the currently authenticated user. If the session ID is not valid, this request returns an INVALID_SESSION_ID error type. This is similar to a whoami request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Binder Documents (3)
POST Add Document to Binder
/objects/binders/{binder_id}/documents
https://developer.veevavault.com/api/23.1/#Add_Document_to_Binder
Add a document to a binder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
[Required] ID of the document being added to the binder. |
PUT Move Document in Binder
/objects/binders/{binder_id}/documents/{section_id}
https://developer.veevavault.com/api/23.1/#Move_Document_in_Binder
Move a document to a different position within a binder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Document from Binder
/objects/binders/{binder_id}/documents/{section_id}
https://developer.veevavault.com/api/23.1/#Remove_Document_from_Binder
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Binder Relationships (3)
POST Create Binder Relationship
/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships
https://developer.veevavault.com/api/23.1/#Create_Binder_Relationship
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
Set the target_doc_id__v to the document id of the “target document” to which a relationship will be established with the binder. |
|
|
Set the relationship_type__v to the field value of one of the desired relationshipTypes from the “Documents Relationships Metadata” call. |
|
|
If you’re creating a relationship with a specific version of the target document, set the target_major_version__v to the major version number of the target document. |
|
|
If you’re creating a relationship with a specific version of the target document, set the target_minor_version__v to the minor version number of the target document. |
DELETE Delete Binder Relationship
/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id}
https://developer.veevavault.com/api/23.1/#Delete_Binder_Relationship
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Binder Relationship
/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Binder_Relationship
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Binder Sections (5)
POST Create Binder Section
/objects/binders/{binder_id}/sections
https://developer.veevavault.com/api/23.1/#Create_Binder_Section
Create a new section in a binder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
[Required] Specify a name for the new section. |
DELETE Delete Binder Section
/objects/binders/{binder_id}/sections/{section_id}
https://developer.veevavault.com/api/23.1/#Delete_Binder_Section
Delete a section from a binder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Binder Sections
/objects/binders/{binder_id}/sections/{section_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Binder_Sections
Retrieve all sections (documents and subsections) in a binder's top-level root node or sub-level node.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Binder Version Section
/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/sections/{section_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Binder_Version_Section
For a specific version, retrieve all sections (documents and subsection) in a binder's top-level root node or sub-level node.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Binder Section
/objects/binders/{binder_id}/sections/{node_id}
https://developer.veevavault.com/api/23.1/#Update_Binder_Section
Update a section in a binder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Binder Templates (10)
POST Create Binder Template
/objects/binders/templates
https://developer.veevavault.com/api/23.1/#Create_Binder_Template
Create a new binder template in your Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The label of the new binder template. This is the name users will see among the available binder templates in the UI. |
|
|
The name of the document type to which the template will be associated. |
|
|
Set to true or false to indicate whether or not the new binder template should be set to active, i.e., available for selection when creating a binder. |
POST Create Binder Template Node
/objects/binders/templates/{template_name}/bindernodes
https://developer.veevavault.com/api/23.1/#Create_Binder_Template_Node
Create nodes in an existing binder template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Delete Binder Template
/objects/binders/templates/{template_name}
https://developer.veevavault.com/api/23.1/#Delete_Binder_Template
Delete an existing binder template from your Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Replace Binder Template Nodes
/objects/binders/templates/{template_name}/bindernodes
https://developer.veevavault.com/api/23.1/#Replace_Binder_Template_Nodes
Replace all binder nodes in an existing binder template. This action removes all existing nodes and replaces them with those specified in the input.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Retrieve Binder Template Attributes
/objects/binders/templates/{template_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Binder_Template_Attributes
Retrieve the attributes of a specific binder template in your Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Binder Template Collection
/objects/binders/templates
https://developer.veevavault.com/api/23.1/#Retrieve_Binder_Template_Collection
Retrieve the collection of all binder templates in your Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Binder Template Metadata
/metadata/objects/binders/templates
https://developer.veevavault.com/api/23.1/#Retrieve_Binder_Template_Metadata
Retrieve the metadata which defines the shape of binder templates in your Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Binder Template Node Attributes
/objects/binders/templates/{template_name}/bindernodes
https://developer.veevavault.com/api/23.1/#Retrieve_Binder_Template_Node_Attributes
Retrieve the attributes of each node (folder/section) of a specific binder template in your Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Binder Template Node Metadata
/metadata/objects/binders/templates/bindernodes
https://developer.veevavault.com/api/23.1/#Retrieve_Binder_Template_Node_Metadata
Retrieve the metadata which defines the shape of binder template nodes in your Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Binder Template
/objects/binders/templates
https://developer.veevavault.com/api/23.1/#Update_Binder_Template
Update an existing binder template in your Vault.
By changing the document type/subtype/classification, you can move an existing binder template to a different level of the document type hierarchy, effectively reclassifying the template.
See also: Bulk Update Binder Templates below.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Change the document type to which the template is associated. |
Binding Rules (3)
PUT Update Binder Document Binding Rule
/objects/binders/{binder_id}/documents/{node_id}/binding_rule
https://developer.veevavault.com/api/23.1/#Update_Binder_Document_Binding_Rule
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Binder Section Binding Rule
/objects/binders/{binder_id}/sections/{node_id}/binding_rule
https://developer.veevavault.com/api/23.1/#Update_Binder_Section_Binding_Rule
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
PUT Update Binding Rule
/objects/binders/{binder_id}/binding_rule
https://developer.veevavault.com/api/23.1/#Update_Binding_Rule
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
[Required] Set to true or false to indicate if the specified binding rule should override documents or sections which already have binding rules set. If set to true, the binding rule is applied to all documents and sections within the current section. If blank or set to false, the binding rule is applied only to documents and sections within the current section that do not have a binding rule specified. |
Bulk Active Workflow Actions (7)
POST Cancel Workflow Tasks
/object/workflow/actions/canceltasks
https://developer.veevavault.com/api/23.1/#Initiate_Bulk_Workflow_Action
Use this request to initiate a workflow action on multiple workflows. This starts an asynchronous job whose status you can check with the Retrieve Job Status endpoint. Maximum 500 workflows per request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Cancel Workflows
/object/workflow/actions/cancelworkflows
https://developer.veevavault.com/api/23.1/#Initiate_Bulk_Workflow_Action
Use this request to initiate a workflow action on multiple workflows. This starts an asynchronous job whose status you can check with the Retrieve Job Status endpoint. Maximum 500 workflows per request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Input a comma-separated list of workflow_id__v field values. Maximum 500 workflows. |
POST Initiate Workflow Actions on Multiple Workflows
/object/workflow/actions/{action}
https://developer.veevavault.com/api/23.1/#Initiate_Bulk_Workflow_Action
Use this request to initiate a workflow action on multiple workflows. This starts an asynchronous job whose status you can check with the Retrieve Job Status endpoint. Maximum 500 workflows per request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Input a comma-separated list of workflow_id__v field values. Maximum 500 workflows. |
POST Reassign Workflow Tasks
/object/workflow/actions/reassigntasks
https://developer.veevavault.com/api/23.1/#Initiate_Bulk_Workflow_Action
Use this request to initiate a workflow action on multiple workflows. This starts an asynchronous job whose status you can check with the Retrieve Job Status endpoint. Maximum 500 workflows per request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Input the user ID of the user whose tasks you wish to reassign. You cannot reassign specific tasks for a user, only all tasks currently assigned to a user. |
|
|
Input the user ID of the user who will receive the newly assigned tasks. |
POST Replace Workflow Owner
/object/workflow/actions/replaceworkflowowner
https://developer.veevavault.com/api/23.1/#Initiate_Bulk_Workflow_Action
Use this request to initiate a workflow action on multiple workflows. This starts an asynchronous job whose status you can check with the Retrieve Job Status endpoint. Maximum 500 workflows per request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
Input the ID of the user who will become the current workflow owner. |
|
|
Input the ID of the user who will become the new workflow owner. |
GET Retrieve Bulk Workflow Action Details
/object/workflow/actions/{action}
https://developer.veevavault.com/api/23.1/#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.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Bulk Workflow Actions
/object/workflow/actions
https://developer.veevavault.com/api/23.1/#Retrieve_Bulk_Workflow_Actions
Retrieve all available workflow actions that can be initiated on a workflow which:
-
The authenticated user has permissions to view or initiate
-
Can be initiated through the API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Components with Content (2)
GET Retrieve Content File
//mdl/components/{component_type_and_record_name}/files
https://developer.veevavault.com/api/23.1/#Retrieve_Content_File
Retrieve the content file of a specified component.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Upload Content File
//mdl/files
https://developer.veevavault.com/api/23.1/#Upload_File
This endpoint allows you to upload a content file to be referenced by a component.
Once uploaded, Vault stores the file in a generic files staging area where they will remain until referenced by a component. Once referenced, Vault cannot access the named file from the staging area.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Configuration Migration (8)
POST Deploy Package
/vobject/vault_package__v/{package_id}/actions/deploy
https://developer.veevavault.com/api/23.1/#Deploy_Package_Config
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Export Package
/services/package
https://developer.veevavault.com/api/23.1/#Export_Package_Config_Migration
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The name of the Outbound Package you would like to export. |
PUT Import Package
/services/package
https://developer.veevavault.com/api/23.1/#Import_Package_Config
Asynchronously import and validate a VPK package attached to this request. On completion, Vault sends an email notification which includes a link to the validation log. For packages that include Vault Java SDK code, this checks code compilation and restrictions in use of the JDK. For example, new is not allowed for non-allowlisted classes. Learn more about Vault Java SDK limits and restrictions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The .vpk file |
GET Retrieve Outbound Package Dependencies
/vobjects/outbound_package__v/{package_id}/dependencies
https://developer.veevavault.com/api/23.1/#Retrieve_Dependencies_Config
Outbound packages only include configuration details for the included components. Sometimes, a configuration for one component depends on another component which you may not have explicitly specified.
With this API, you can retrieve all outstanding component dependencies for an outbound package. You can then add these missing dependencies to the package with the Create Object Records API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Package Deploy Results
/vobject/vault_package__v/{package_id}/actions/deploy/results
https://developer.veevavault.com/api/23.1/#Retrieve_Package_Deploy_Results
After Vault has finished processing the deploy job, use this request to retrieve the results of the completed deploy.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Validate Package
/services/package/actions/validate
https://developer.veevavault.com/api/23.1/#Validate_Code
Validate a VPK package attached to this request. The validation response will include the same information on dependent components as validation logs generated through the UI. For packages that include Vault Java SDK code, this checks checks code compilation and restrictions in use of the JDK. For example, new is not allowed for non-allowlisted classes. Learn more about Vault Java SDK limits and restrictions.
This endpoint does not import your package.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
To upload the VPK file, use the multi-part attachment with the file component ”file={filename}”. The maximum allowed file size is 2GB. |
POST Vault Compare
/objects/vault/actions/compare
https://developer.veevavault.com/api/23.1/#Vault_Compare
Compare the configuration of two different Vaults. The Vault you make the request in is the source Vault, and the target Vault for the comparison is listed in the body. Learn more about Vault Compare in Vault Help.
The user who makes the request must be a cross-domain user and must have access to the vault_component__v in both Vaults. Learn more about cross-domain users in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Vault Configuration Report
/objects/vault/actions/configreport
https://developer.veevavault.com/api/23.1/#Vault_Configuration_Report
Generate an Excel™ report containing configuration information for a Vault. Users must have the Vault Configuration Report permission to use this API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Create Binders (2)
POST Create Binder
/objects/binders
https://developer.veevavault.com/api/23.1/#Create_Binder
Use this request to create a new binder in your Vault. Learn about Creating Binders in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Binder Version
/objects/binders/{binder_id}
https://developer.veevavault.com/api/23.1/#Create_Binder_Version
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Create Documents (2)
POST Create Multiple Documents
/objects/documents/batch
https://developer.veevavault.com/api/23.1/#Bulk_Create_Documents
This endpoint allows you to create multiple documents at once with a CSV input file.
-
The maximum CSV input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Note that this API does not support adding multi-value relationship fields by name. To add multi-value fields, you must first retrieve the ID values and add them to the relationship field.
The API supports all security settings except document lifecycle role defaults. You must create documents through the UI if your documents require document lifecycle role defaults. Learn more about document lifecycle role defaults in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Single Document
/objects/documents
https://developer.veevavault.com/api/23.1/#Create_Single_Document
Note: If you need to create more than one document, it is best practice to use the bulk API.
Create a single document.
The API supports all security settings except document lifecycle role defaults. You must create documents through the UI if your documents require document lifecycle role defaults. Learn more about document lifecycle role defaults in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The name of the new document. |
|
|
The label of the document type to assign to the new document. |
|
|
The label of the document lifecycle to assign the new document |
Create Users
POST Create Single User
/objects/users
https://developer.veevavault.com/api/23.1/#Create_Single_User
Note: Beginning in v18.1, Admins create and manage users with user__sys object records. Unless you are creating cross-domain users or adding users to a domain without assigning Vault membership, we strongly recommend using the Create Object Records endpoint to create new users.
Create one user at a time without the need for a csv input file or upload profile pictures to the file staging server. After creation, you can assign these users to Vaults with the Update Vault Membership endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (8)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Delegated Access (2)
POST Initiate Delegated Session
/delegation/login
https://developer.veevavault.com/api/23.1/#Initiate_Delegated_Session
Generate a delegated session ID. This allows you to call the Vault REST API on behalf of a user who granted you delegate access. To find which users have granted you delegate access, Retrieve Delegations.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The sessionId of the currently authenticated user who will initiate the delegated session. Cannot be a delegated_sessionid. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The id value of the Vault to initiate the delegated session. |
|
|
The ID of the user who granted the authenticated user delegate access in this Vault. |
GET Retrieve Delegations
/delegation/vaults
https://developer.veevavault.com/api/23.1/#Retrieve_Delegations
Retrieve Vaults where the currently authenticated user has delegate access. You can then use this information to Initiate a Delegated Session.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Delete Binders (2)
DELETE Delete Binder
/objects/binders/{binder_id}
https://developer.veevavault.com/api/23.1/#Delete_Binder
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Binder Version
/objects/binders/{binder_id}/versions/{major_version}/{minor_version}
https://developer.veevavault.com/api/23.1/#Delete_Binder_Version
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Delete Documents (5)
DELETE Delete Multiple Document Versions
/objects/documents/versions/batch
https://developer.veevavault.com/api/23.1/#Delete_Document_Versions
Delete a specific version of multiple documents, including the version's source file and viewable rendition.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Multiple Documents
/objects/documents/batch
https://developer.veevavault.com/api/23.1/#Delete_Documents
Delete all versions of multiple documents, including all source files and viewable renditions.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Single Document
/objects/documents/{doc_id}
https://developer.veevavault.com/api/23.1/#Delete_Document
Note: If you need to delete more than one document, it is best practice to use the bulk API.
Delete all versions of a document, including all source files and viewable renditions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Single Document Version
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}
https://developer.veevavault.com/api/23.1/#Delete_Document_Version
Note: If you need to delete more than one document version, it is best practice to use the bulk API.
Delete a specific version of a document, including the version's source file and viewable rendition. Other versions of the document remain unchanged. See also Delete Document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Deleted Document IDs
/objects/deletions/documents
https://developer.veevavault.com/api/23.1/#Retrieve_Deleted_Documents
Retrieve IDs of documents deleted within the past 30 days.
After documents and document versions are deleted, their IDs remain available for retrieval for 30 days. After that, they cannot be retrieved. This request supports optional parameters to narrow the results to a specific date and time range within the past 30 days.
To completely restore a document deleted within the last 30 days, contact Veeva support.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Specify a date (no more than 30 days past) after which Vault will look for deleted documents. Dates must be YYYY-MM-DDTHH:MM:SSZ format, for example, 7AM on January 15, 2016 would use 2016-01-15T07:00:00Z |
|
|
Specify a date (no more than 30 days past) before which Vault will look for deleted documents. Dates must be YYYY-MM-DDTHH:MM:SSZ format, for example, 7AM on January 15, 2016 would use 2016-01-15T07:00:00Z |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Discovery Endpoints (5)
GET Retrieve All SCIM Resource Types
/scim/v2/ResourceTypes
https://developer.veevavault.com/api/23.1/#SCIM_Retrieve_Resource_Types
Retrieve the types of SCIM resources available. Each resource type defines the endpoints, the core schema URI that defines the resource, and any supported schema extensions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve All SCIM Schema Information
/scim/v2/Schemas
https://developer.veevavault.com/api/23.1/#SCIM_Retrieve_Schemas
Retrieve information about all SCIM schema specifications supported by a Vault SCIM service provider.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve SCIM Provider
/scim/v2/ServiceProviderConfig
https://developer.veevavault.com/api/23.1/#SCIM_ProInformationvider_Info
Retrieve a JSON that describes the SCIM specification features available on the currently authenticated Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Single SCIM Resource Type
/scim/v2/ResourceTypes/{type}
https://developer.veevavault.com/api/23.1/#SCIM_Retrieve_Resource_Type
Retrieve a single SCIM resource type. Defines the endpoints, the core schema URI which defines this resource, and any supported schema extensions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Single SCIM Schema Information
/scim/v2/Schemas/{id}
https://developer.veevavault.com/api/23.1/#SCIM_Retrieve_Schema
Retrieve information about a single SCIM schema specification supported by a Vault SCIM service provider.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Document & Binder User Actions (6)
GET Download Controlled Copy Job Results
/objects/documents/actions/{lifecycle_and_state_and_action}/{job_id}/results
https://developer.veevavault.com/api/23.1/#Download_Controlled_Copy
Note: This endpoint is intended for use by integrations requesting and routing controlled copies of content as a system integrations account on behalf of users.
This endpoint is for Extensible Controlled Copy; controlled_copy_trace__v and controlled_copy_user_input__v objects. If your organization is not using these objects, you should use the endpoints for Legacy Controlled Copy.
After initiating a controlled copy user action, use this endpoint to download the controlled copy. To execute this request in an integration flow, Retrieve the Job Status and use the href under "rel": "artifacts". We do not recommend executing this request outside of this flow.
Before submitting this request:
-
You must have previously requested an initiate controlled copy job (via the API) which is no longer active
-
You must be the user who initiated the job or have the Admin: Jobs: Read permission
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Initiate Bulk User Actions
/objects/{documents_or_binders}/lifecycle_actions/{user_action_name}
https://developer.veevavault.com/api/23.1/#Bulk_Document_State_Change
For each bulk action, you may only select a single workflow that Vault will start for all selected and valid documents.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Include a comma-separated list of document or binder IDs, major and minor version numbers, as shown below. |
|
|
Include the name of the document or binder lifecycle. |
|
|
Include the current state of your document. |
PUT Initiate User Action
/objects/{documents_or_binders}/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v}
https://developer.veevavault.com/api/23.1/#Initiate_Lifecycle_Action
Initiate a user action. Before initiating, you should retrieve any applicable entry criteria for the action.
Only some user action types can be initiated through the API. See supported user actions.
The authenticated user must have permission to initiate this action. To check permissions, Retrieve User Actions and check for actions where executable__v is true.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Entry Criteria
/objects/{documents_or_binders}/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v}/entry_requirements
https://developer.veevavault.com/api/23.1/#Retrieve_Entry_Requirements
Retrieve the entry criteria for a user action. Entry criteria are requirements the document or binder must meet before you can initiate the action. Entry criteria are dynamic and depend on the lifecycle configuration, lifecycle state, or any workflow activation requirements defined in the Start Step of the workflow. Learn more about entry criteria in Vault Help.
To retrieve entry criteria, the authenticated user must have permission to execute the action. To check permissions, Retrieve User Actions and check for actions where executable__v is true.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve User Actions
/objects/{documents_or_binders}/{id}/versions/{major_version}/{minor_version}/lifecycle_actions
https://developer.veevavault.com/api/23.1/#Retrieve_Lifecycle_Actions
Retrieve all available user actions on a specific version of a document or binder which:
-
The authenticated user has permissions to view or initiate.
-
Can be initiated through the API. See supported user actions.
-
Is not currently in an active workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Retrieve User Actions on Multiple Documents or Binders
/objects/{documents_or_binders}/lifecycle_actions
https://developer.veevavault.com/api/23.1/#Retrieve_Multiple_Document_User_Actions
Retrieve all available user actions on specific versions of multiple documents or binders.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The document or binder docIds field values from which to retrieve the available user actions. Include a comma-separated list of document or binder IDs and major and minor version numbers in the format {doc_id:major_version:minor_version}, such as 22:0:1. |
Document Annotations (7)
GET Download Document Annotations
/objects/documents/{doc_id}/annotations
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Annotations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download Document Version Annotations
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Version_Annotations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Anchor IDs
/objects/documents/{doc_id}/anchors
https://developer.veevavault.com/api/23.1/#Retrieve_Anchor_IDs
Retrieve all anchor IDs from a document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Version Notes as CSV
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/doc-export-annotations-to-csv
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Version_Notes_as_CSV
Retrieve notes in CSV format for any document that has a viewable rendition and at least one annotation. You must have a Full User license type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Video Annotations
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/export-video-annotations
https://developer.veevavault.com/api/23.1/#Retrieve_Video_Annotations
Retrieve annotations on a video document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Upload Document Annotations
/objects/documents/{doc_id}/annotations
https://developer.veevavault.com/api/23.1/#Upload_Document_Annotations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Upload Document Version Annotations
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/annotations
https://developer.veevavault.com/api/23.1/#Upload_Document_Version_Annotations
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Document Attachments (19)
POST Create Document Attachment
/objects/documents/{doc_id}/attachments
https://developer.veevavault.com/api/23.1/#Add_Document_Attachment
Create an attachment on the latest version of a document. If the attachment already exists, Vault uploads the attachment as a new version of the existing attachment. Learn more about attachment versioning in Vault Help.
To create a version-specific attachment, or to create multiple attachments at once, use the bulk API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Multiple Document Attachments
/objects/documents/attachments/batch
https://developer.veevavault.com/api/23.1/#Create_Multiple_Attachments
Create multiple document attachments in bulk with a JSON or CSV input file. You must first load the attachments to the file staging server. This works for version-specific attachments and attachments at the document level. If the attachment already exists, Vault uploads the attachment as a new version of the existing attachment. Learn more about attachment versioning in Vault Help.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Delete Multiple Document Attachments
/objects/documents/attachments/batch
https://developer.veevavault.com/api/23.1/#Delete_Multiple_Attachments
Delete multiple document attachments in bulk with a JSON or CSV input file. This works for version-specific attachments and attachments at the document level.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Single Document Attachment
/objects/documents/{doc_id}/attachments/{attachment_id}
https://developer.veevavault.com/api/23.1/#Delete_Document_Attachment
Deletes the specified attachment and all of its versions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Single Document Attachment Version
/objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version}
https://developer.veevavault.com/api/23.1/#Delete_Document_Attachment_Version
Deletes the specified version of the specified attachment.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download All Document Attachments
/objects/documents/{doc_id}/attachments/file
https://developer.veevavault.com/api/23.1/#Download_All_Document_Attachment_Files
Downloads the latest version of all attachments from the document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download All Document Version Attachments
/objects/documents/{doc_id}/{major_version}/{minor_version}/attachments/file
https://developer.veevavault.com/api/23.1/#Download_All_Document_Version_Attachments
Downloads the latest version of all attachments from the specified version of the document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download Document Attachment
/objects/documents/{doc_id}/attachments/{attachment_id}/file
https://developer.veevavault.com/api/23.1/#Download_Document_Attachment_File
Downloads the latest version of the specified attachment from the document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download Document Attachment Version
/objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version}/file
https://developer.veevavault.com/api/23.1/#Download_Document_Attachment_Version_File
Downloads the specified version of the attachment from the document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download Document Version Attachment Version
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}/versions/{attachment_version}/file
https://developer.veevavault.com/api/23.1/#Download_Document_Version_Attachment_Version
Downloads the specified attachment version from the specified document version.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Restore Document Attachment Version
/objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version}
https://developer.veevavault.com/api/23.1/#Restore_Document_Attachment_Version
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The parameter restore must be set to true. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Attachment Metadata
/objects/documents/{doc_id}/attachments/{attachment_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Attachment_Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Attachment Version Metadata
/objects/documents/{doc_id}/attachments/{attachment_id}/versions/{attachment_version}
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Attachment_Version_Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Attachment Versions
/objects/documents/{doc_id}/attachments/{attachment_id}/versions
https://developer.veevavault.com/api/23.1/#List_Document_Attachment_Versions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Attachments
/objects/documents/{doc_id}/attachments
https://developer.veevavault.com/api/23.1/#List_Document_Attachments
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Version Attachment Versions
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/attachments/{attachment_id}/versions/{attachment_version}
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Version_Attachment_Version
Retrieve versions of an attachment on a specific version of a document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Version Attachments
/objects/documents/{doc_id}/version/{major_version}/{minor_version}/attachments
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Version_Attachments
Retrieve attachments on a specific version of a document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Document Attachment Description
/objects/documents/{doc_id}/attachments/{attachment_id}
https://developer.veevavault.com/api/23.1/#Update_Document_Attachment_Description
Update an attachment on the latest version of a document. To update a version-specific attachment, or to update multiple attachments at once, use the bulk API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
This is the only editable field. The maximum character length is 1000. |
PUT Update Multiple Document Attachment Descriptions
/objects/documents/attachments/batch
https://developer.veevavault.com/api/23.1/#Update_Multiple_Attachments
Update multiple document attachments in bulk with a JSON or CSV input file. This works for version-specific attachments and attachments at the document level. You can only update the latest version of an attachment.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Document Events (4)
POST Create Document Event
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/events
https://developer.veevavault.com/api/23.1/#Create_Document_Event
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Ex. distribution__v |
|
|
Ex. approved_email__v |
|
|
Ex. 1234 |
GET Retrieve Document Event SubType Metadata
/metadata/objects/documents/events/{event_type}/types/{event_subtype}
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Event_SubType_Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Event Types and Subtypes
/metadata/objects/documents/events
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Event_Types_and_Subtypes
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Events
/objects/documents/{doc_id}/events
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Events
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Document Locks (4)
POST Create Document Lock
/objects/documents/{doc_id}/lock
https://developer.veevavault.com/api/23.1/#Create_Document_Lock
A document lock is analogous to checking out a document but without the file attached in the response for download.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Document Lock
/objects/documents/{doc_id}/lock
https://developer.veevavault.com/api/23.1/#Delete_Document_Lock
Deleting a document lock is analogous to undoing check out of a document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Lock
/objects/documents/{doc_id}/lock
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Lock
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Lock Metadata
/metadata/objects/documents/lock
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Lock_Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Document Relationships (7)
POST Create Multiple Document Relationships
/objects/documents/relationships/batch
https://developer.veevavault.com/api/23.1/#Create_Document_Relationships
Create new relationships on multiple documents.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 1000.
You cannot create or delete standard relationship types. Examples of standard relationship types include Based On and Original Source. Learn about Document Relationships in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Single Document Relationship
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships
https://developer.veevavault.com/api/23.1/#Create_Document_Relationship
Note: If you need to create a relationship on more than one document, it is best practice to use the bulk API.
Create a new relationship on a document.
You cannot create or delete standard relationship types. Examples of standard relationship types include Based On and Original Source. Learn about Document Relationships in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The document id of the target document. |
|
|
The relationship type retrieved from the Document Relationships Metadata call above. |
DELETE Delete Multiple Document Relationships
/objects/documents/relationships/batch
https://developer.veevavault.com/api/23.1/#Delete_Document_Relationships
Delete relationships from multiple documents.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 1000.
You cannot create or delete standard relationship types. Examples of standard relationship types include Based On and Original Source. Learn about Document Relationships in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Single Document Relationship
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id}
https://developer.veevavault.com/api/23.1/#Delete_Document_Relationship
Note: If you need to delete a relationship on more than one document, it is best practice to use the bulk API.
Delete a relationship from a document.
You cannot create or delete standard relationship types. Examples of standard relationship types include Based On and Original Source. Learn about Document Relationships in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Relationship
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships/{relationship_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Relationship
Retrieve details of a specific document relationship.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Relationships
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/relationships
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Relationships
Retrieve all relationships from a document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Type Relationships
/metadata/objects/documents/types/{type}/relationships
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Type_Relationships
Retrieve all relationships from a document type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Document Renditions (12)
POST Add Multiple Document Renditions
/objects/documents/renditions/batch
https://developer.veevavault.com/api/23.1/#Add_Document_Renditions_Bulk
Add document renditions in bulk.
-
If the
largeSizeAssetquery parameter is not set totrue, you must include theX-VaultAPI-MigrationModeheader. -
The maximum CSV input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Add Single Document Rendition
/objects/documents/{doc_id}/renditions/{rendition_type}
https://developer.veevavault.com/api/23.1/#Upload_Document_Rendition
Note: If you need to add more than one document rendition, it is best practice to use the bulk API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Delete Document Version Rendition
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type}
https://developer.veevavault.com/api/23.1/#Delete_Document_Version_Rendition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Multiple Document Renditions
/objects/documents/renditions/batch
https://developer.veevavault.com/api/23.1/#Delete_Document_Renditions
Delete document renditions in bulk.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Single Document Rendition
/objects/documents/{doc_id}/renditions/{rendition_type}
https://developer.veevavault.com/api/23.1/#Delete_Document_Rendition
Note: If you need to delete more than one document rendition, it is best practice to use the bulk API.
Delete a single document rendition. On SUCCESS, Vault deletes the rendition of specified type from the latest document version.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download Document Rendition File
/objects/documents/{doc_id}/renditions/{rendition_type}
https://developer.veevavault.com/api/23.1/#Download_Document_Rendition_File
Download a rendition file from the latest version of a document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download Document Version Rendition File
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type}
https://developer.veevavault.com/api/23.1/#Download_Document_Version_Rendition_File
Download a rendition for a specified version of a document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Replace Document Rendition
/objects/documents/{doc_id}/renditions/{rendition_type}
https://developer.veevavault.com/api/23.1/#Replace_Document_Rendition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Replace Document Version Rendition
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type}
https://developer.veevavault.com/api/23.1/#Replace_Document_Version_Rendition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Retrieve Document Renditions
/objects/documents/{doc_id}/renditions
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Renditions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Version Renditions
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Version_Renditions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Upload Document Version Rendition
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/renditions/{rendition_type}
https://developer.veevavault.com/api/23.1/#Upload_Document_Version_Rendition
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Document Roles (5)
POST Assign Users & Groups to Roles on Multiple Documents
/objects/documents/roles/batch
https://developer.veevavault.com/api/23.1/#Assign_Users_Groups_to_Roles
Assign users and groups to roles on a document or binder in bulk.
-
The maximum CSV input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 1000.
Assigning users and groups to document roles is additive. For example, if groups 1, 2, and 3 are currently assigned to a particular role and you assign groups 3, 4, and 5 to the same role, the final list of groups assigned to the role will be 1, 2, 3, 4, and 5. Users and groups (IDs) in the input that are either invalid (not recognized) or cannot be assigned to a role due to permissions are ignored and not processed.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Assign Users & Groups to Roles on a Single Document
/objects/documents/{id}/roles
https://developer.veevavault.com/api/23.1/#Assign_Users_Groups_to_Role
Note: If you need to assign users and groups to roles on more than one document or binder, it is best practice to use the bulk API.
Assign users and groups to roles on a single document or binder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Users & Groups from Roles on a Single Document
/objects/documents/{doc_id}/roles/{role_name_and_user_or_group}/{id}
https://developer.veevavault.com/api/23.1/#Remove_Users_Groups_from_Role
Note: If you need to remove users and groups from roles on more than one document or binder, it is best practice to use the bulk API.
Remove users and groups from roles on a single document or binder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Remove Users and Groups from Roles on Multiple Documents
/objects/documents/roles/batch
https://developer.veevavault.com/api/23.1/#Remove_Users_Groups_from_Roles
Remove users and groups from roles on a document or binder in bulk.
-
The maximum CSV input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 1000.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Roles
/objects/{documents_or_binders}/{id}/roles/{role_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Roles
Retrieve all available roles on a document or binder and the users and groups assigned to them.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Document Templates (8)
POST Create Single Document Template
/objects/documents/templates
https://developer.veevavault.com/api/23.1/#Create_Document_Template
Create one document template. To create multiple document templates, see Bulk Create Document Templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
The label of the new document template. This is the name users will see among the available templates in the UI. |
|
|
The name of the document type to which the template will be associated. |
|
|
Set to true or false to indicate whether or not the new document template should be set to active, i.e., available for selection when creating a document. |
DELETE Delete Basic Document Template
/objects/documents/templates/{template_name}
https://developer.veevavault.com/api/23.1/#Delete_Document_Template
Delete a basic document template from your Vault. You cannot delete controlled document templates. Learn more about controlled template deletion in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download Document Template File
/objects/documents/templates/{template_name}/file
https://developer.veevavault.com/api/23.1/#Download_Document_Template_File
Download the file of a specific document template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Template Attributes
/objects/documents/templates/{template_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Template_Attributes
Retrieve the attributes from a document template.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Template Collection
/objects/documents/templates
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Template_Collection
Retrieve all document templates.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Template Metadata
/metadata/objects/documents/templates
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Template_Metadata
Retrieve the metadata which defines the shape of document templates in your Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Multiple Document Templates
/objects/documents/templates
https://developer.veevavault.com/api/23.1/#Bulk_Update_Document_Templates
Update up to 500 document templates in your Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Single Document Template
/objects/documents/templates/{template_name}
https://developer.veevavault.com/api/23.1/#Update_Document_Template
Update a single document template in your Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The name of an existing document template. This is required. |
|
|
Change the name of an existing document template. |
|
|
Change the label of an existing document template. This is the name users will see among the available document templates in the UI. |
|
|
Set to true or false to indicate whether or not the document template should be set to active, i.e., available for selection when creating a document. |
Document Workflows (3)
POST Initiate Document Workflow
/objects/documents/actions/{workflow_name}
https://developer.veevavault.com/api/23.1/#Initiate_Multi_Document_Workflow
Initiate a document workflow on a set of documents. If any document is not in the relevant state or does not meet configured field conditions, the API returns INVALID_DATA for the invalid documents and the workflow does not start.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
Input a comma-separated list of document id field values. Maximum 100 documents. |
|
|
Enter the participant name and input the user or group id value. For example, approvers__c: user:123,group:234. |
|
|
Description of the workflow. Maximum 128 characters. |
GET Retrieve All Document Workflows
/objects/documents/actions
https://developer.veevavault.com/api/23.1/#Retrieve_All_Multi_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
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Workflow Details
/objects/documents/actions/{workflow_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Multi_Document_Workflow_Details
Retrieves the details for a specific document workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Documents
POST Document Tokens
/objects/documents/tokens
https://developer.veevavault.com/api/23.1/#Vault_Document_Tokens
The Vault Document Tokens API allows you to generates document access tokens needed by the external viewer to view documents outside of Vault. Learn more.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Required: Include the docIds request parameter with a comma-separated string of document id values. This will generate tokens for each document. For example: docIds=101,102,103,104 |
Domain Information (2)
GET Retrieve Domain Information
/objects/domain
https://developer.veevavault.com/api/23.1/#Retrieve_Domain_Vaults
Domain Admins can use this request to retrieve a list of all Vaults currently in their domain.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
To include Vault application type information in the response, set include_application to true. If omitted, defaults to false and application information is not included. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Domains
/objects/domains
https://developer.veevavault.com/api/23.1/#Retrieve_Domains
Non-domain Admins can use this request to retrieve a list of all their domains, including the domain of the current Vault. You can use this data as a valid domain value when creating a sandbox Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Expected Document Lists (7)
POST Add EDL Matched Documents
/objects/edl_matched_documents/batch/actions/add
https://developer.veevavault.com/api/23.1/#Add_EDL_Matched_Document
Add matched documents to EDL Items. You must have a security profile that grants the _Application: EDL Matching: Edit Document Matches_ permission, and EDL Matched Document APIs must be enabled in your Vault. To enable this feature, contact Veeva Support. The edl_status__v field must also be enabled for the object type of the specified EDL Item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create a Placeholder from an EDL Item
/vobjects/edl_item__v/actions/createplaceholder
https://developer.veevavault.com/api/23.1/#Create_Placeholder_from_EDL_Item
Create a placeholder from an EDL item. Learn about working with Content Placeholders in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Comma separated list of edl item ids on which to initiate the action. |
POST Remove EDL Matched Documents
/objects/edl_matched_documents/batch/actions/remove
https://developer.veevavault.com/api/23.1/#Remove_EDL_Matched_Documents
Remove manually matched documents from EDL Items. You must have a security profile that grants the _Application: EDL Matching: Edit Document Matches_ permission, and EDL Matched Document APIs must be enabled in your Vault. To enable this feature, contact Veeva Support. The edl_status__v field must also be enabled for the object type of the specified EDL Item.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve All Root Nodes
/composites/trees/{edl_hierarchy_or_template}
https://developer.veevavault.com/api/23.1/#Retrieve_Root_Nodes
Retrieves all root EDL nodes and node metadata. Learn more about EDL hierarchies in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Retrieve Specific Root Nodes
/composites/trees/{edl_hierarchy_or_template}/actions/listnodes
https://developer.veevavault.com/api/23.1/#Retrieve_Specific_Root_Nodes
Retrieves the root node ID for the given EDL record IDs.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Choose to retrieve either edl_hierarchy__v or edl_template__v |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve a Node's Children
/composites/trees/edl_hierarchy__v/{parent_node_id}/children
https://developer.veevavault.com/api/23.1/#Retrieve_Node_Children
Given an EDL node ID, retrieves immediate children (not grandchildren) of that node. Learn more about EDL hierarchies in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Node Order
/composites/trees/edl_hierarchy__v/{parent_node_id}/children
https://developer.veevavault.com/api/23.1/#Update_Node_Order
Given an EDL parent node, update the order of its children.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The ID of the child node to update. |
|
|
The new order for the node in the hierarchy, such as “1”, “2”, etc. |
Export Binders (3)
POST Export Binder (Latest Version)
/objects/binders/{binder_id}/actions/export
https://developer.veevavault.com/api/23.1/#Export_Binder
Use this request to export the latest version of a binder in your Vault.
-
This will export the complete binder, including all binder sections and documents.
-
To export only specific binder sections and documents, refer to the next section.
-
After initiating an export, you can retrieve its status, results, and download the exported binder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Export Binder (Specific Version)
/objects/binders/{binder_id}/versions/{major_version}/{minor_version}/actions/export
https://developer.veevavault.com/api/23.1/#Export_Binder
Use this request to export a specific version of a binder in your Vault.
-
This will export the complete binder, including all binder sections and documents.
-
To export only specific binder sections and documents, refer to the next section.
-
After initiating an export, you can retrieve its status, results, and download the exported binder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Binder Export Results
/objects/binders/actions/export/{job_id}/results
https://developer.veevavault.com/api/23.1/#Retrieve_Binder_Export_Results
After submitting a request to export a binder from your Vault, you can query Vault to determine the results of the request.
Before submitting this request:
-
You must have previously requested a binder export job (via the API) which is no longer active.
-
You must have a valid
job_idvalue (retrieved from the export binder request above).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Export Documents (3)
POST Export Document Versions
/objects/documents/versions/batch/actions/fileextract
https://developer.veevavault.com/api/23.1/#Export_Document_Version
Export a specific set of document versions to your Vault's file staging server. The files you export go to the u{userID} folder, regardless of your security profile.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Export Documents
/objects/documents/batch/actions/fileextract
https://developer.veevavault.com/api/23.1/#Export_Documents
Use this request to export a set of documents to your Vault's file staging server.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Retrieve Document Export Results
/objects/documents/batch/actions/fileextract/{job_id}/results
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Export_Results
After submitting a request to export documents from your Vault, you can query your Vault to determine the results of the request.
Before submitting this request:
-
You must have previously requested a document export job (via the API) which is no longer active.
-
You must have a valid
job_idvalue (retrieved from the document export binder request above). -
You must be a Vault Owner, System Admin or the user who initiated the job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
File Staging (5)
POST Create Folder or File
/services/file_staging/items
https://developer.veevavault.com/api/23.1/#Create_File_or_Folder
Upload files or folders up to 50MB to the File Staging Server. To upload files larger than 50MB, see Resumable Upload Sessions. You can only create one file or folder per request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The maximum allowed file size is 50MB. |
|
|
The kind of item to create. This can be either file or folder. |
|
|
The absolute path, including file or folder name, to place the item in the file staging server. This path is specific to the authenticated user. Admin users can access the root directory. All other users can only access their own user directory. |
DELETE Delete File or Folder
/services/file_staging/items/{item}
https://developer.veevavault.com/api/23.1/#Delete_File_or_Folder
Delete an individual file or folder from the file staging server.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The absolute path to the file or folder to delete. This path is specific to the authenticated user. Admin users can access the root directory. All other users can only access their own user directory. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download Item Content
/services/file_staging/items/content/{item}
https://developer.veevavault.com/api/23.1/#Get_Item_Content
Retrieve the content of a specified file from the file staging server. Use the Range header to create resumable downloads for large files, or to continue downloading a file if your session is interrupted.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
If true, the response will contain the contents of all subfolders. If not specified, the default value is false. |
|
|
Optional: The maximum number of items per page in the response. This can be any value between 1 and 1000. If omitted, the default value is 1000. |
|
|
If set to csv, the response includes a job_id. Use the Job ID value to retrieve the status and results of the request. |
|
|
The absolute path to a file or folder. This path is specific to the authenticated user. Admin users can access the root directory. All other users can only access their own user directory. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET List Items at a Path
/services/file_staging/items/{item}
https://developer.veevavault.com/api/23.1/#List_Items_at_a_Path
Return a list of files and folders for the specified path. Paths are different for Admin users (Vault Owners and System Admins) and non-Admin users. Learn more about paths in the REST API Documentation.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The absolute path to a file or folder. This path is specific to the authenticated user. Admin users can access the root directory. All other users can only access their own user directory. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Folder or File
/services/file_staging/items/{item}
https://developer.veevavault.com/api/23.1/#Update_File_or_Folder
Move or rename a folder or file on the file staging server. You can move and rename an item in the same request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The absolute path to a file or folder. This path is specific to the authenticated user. Admin users can access the root directory. All other users can only access their own user directory. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Groups (7)
POST Create Group
/objects/groups
https://developer.veevavault.com/api/23.1/#Create_Group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
[Required] Enter a group label. Vault uses this to create the group name__v value. |
DELETE Delete Group
/objects/groups/{group_id}
https://developer.veevavault.com/api/23.1/#Delete_Group
Delete a user-defined group. You cannot delete system-managed groups.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve All Groups
/objects/groups
https://developer.veevavault.com/api/23.1/#Retrieve_All_Groups
Retrieve all groups except Auto Managed groups. You can retrieve Auto Managed groups using the Retrieve Auto Managed Groups endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Auto Managed Groups
/objects/groups/auto
https://developer.veevavault.com/api/23.1/#Retrieve_All_Groups
Retrieve all Auto Managed groups. Learn more about Auto Managed groups in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Group
/objects/groups/{group_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Group
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Group Metadata
/metadata/objects/groups
https://developer.veevavault.com/api/23.1/#Retrieve_Group_Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Group
/objects/groups/{group_id}
https://developer.veevavault.com/api/23.1/#Update_Group
Update editable group field values. Add or remove group members and security profiles.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Jobs (5)
GET Retrieve Job Histories
/services/jobs/histories
https://developer.veevavault.com/api/23.1/#Retrieve_Job_Histories
Retrieve a history of all completed jobs in the authenticated Vault. A completed job is any job which has started and finished running, including jobs which did not complete successfully. In-progress or queued jobs do not appear here.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Job Monitors
/services/jobs/monitors
https://developer.veevavault.com/api/23.1/#Retrieve_Job_Monitors
Retrieve monitors for jobs which have not yet completed in the authenticated Vault. An uncompleted job is any job which has not finished running, such as scheduled, queued, or actively running jobs. Completed jobs do not appear here.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Job Status
/services/jobs/{job_id}
https://developer.veevavault.com/api/23.1/#RetrieveJobStatus
After submitting a request, you can query your Vault to determine the status of the request. To do this, you must have a valid job_id for a job previously requested through the API.
Example Jobs:
-
Binder Export
-
Import Submission
-
Export Submission
-
Create EDL
-
Deploy Package
-
Deep Copy Object Record
-
Cascade Delete Object Record
-
Export Documents
Note: The Job Status endpoint can only be requested once every 10 seconds. When this limit is reached, Vault returns API_LIMIT_EXCEEDED.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Job Tasks
/services/jobs/{job_id}/tasks
https://developer.veevavault.com/api/23.1/#Retrieve_Job_Tasks
Retrieve the tasks associated with an SDK job.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Start Job
/services/jobs/start_now/{job_id}
https://developer.veevavault.com/api/23.1/#Start_Job
Moves up a scheduled job instance to start immediately. Each time a user calls this API, Vault cancels the next scheduled instance of the specified job. For example, calling this API against a scheduled daily job three times would cause the job to not run according to its schedule for three days. Once the affected Job ID is complete, Vault will schedule the next instance.
This is analogous to the Start Now option in the Vault UI.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Lifecycle Role Assignment Rules (4)
POST Create Lifecycle Role Assignment Override Rules
/configuration/role_assignment_rule
https://developer.veevavault.com/api/23.1/#Create_Override_Rules
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The name__v field values of the lifecycle and role to which the override rule is being added. |
DELETE Delete Lifecycle Role Assignment Override Rules
/configuration/role_assignment_rule
https://developer.veevavault.com/api/23.1/#Delete_Override_Rules
Delete override rules configured on a specific lifecycle role.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Lifecycle Role Assignment Rules (Default & Override)
/configuration/role_assignment_rule
https://developer.veevavault.com/api/23.1/#Retrieve_Lifecycle_Role_Assignment_Rules
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Lifecycle Role Assignment Rules (Default & Override)
/configuration/role_assignment_rule
https://developer.veevavault.com/api/23.1/#Update_Override_Rules
Before submitting this request, prepare a JSON or CSV input file. See the Create Lifecycle Role Assignment Override Rules request above for details.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Logs (3)
GET Download Daily API Usage
/logs/api_usage
https://developer.veevavault.com/api/23.1/#API_Usage
Retrieve the API Usage Log for a single day, up to 30 days in the past. The log contains information such as user name, user ID, remaining burst limit, and the endpoint called. Users with the Admin: Logs: API Usage Logs permission can access these logs.
Note that the daily logs may have a delay of about 15 minutes. If your log does not include appropriate data, know that your data is not lost; it is just not yet populated.
The logs are designed for troubleshooting burst limits and discovering which of your integrations are causing you to hit the limit. These logs should not be used for auditing, as they are not designed with the appropriate level of restrictions. For example, if an API request fails to enter the usage log, the API call is not prevented from executing, which would be required if this log was designed for auditing. In rare cases an API call may not show up as an entry in the log, but know that all calls are accurately reflected in your burst limit counts.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download SDK Runtime Log
/logs/code/runtime
https://developer.veevavault.com/api/23.1/#Download_Runtime_Log
Retrieve the Runtime Log for a single day, up to 30 days in the past. Users with the Admin: Logs: Vault Java SDK Logs permission can access these logs.
The runtime logs create entries 15 minutes after the Vault Java SDK transaction completes. If you’ve recently encountered an error which is not captured in the runtime log, wait for the transaction to finish and check again. If your log does not include appropriate data, know that your data is not lost; it is just not yet populated.
Learn more about the Vault Java SDK runtime log.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Email Notification Histories
/notifications/histories
https://developer.veevavault.com/api/23.1/#Retrieve_Email_Notification_History
Retrieve details about the email notifications sent by Vault. Details include the notification date, recipient, subject, and delivery status. In the UI, this information is available in Admin > Operations > Email Notification Status. Learn more about Email Notification Status in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Managing Vault Java SDK (7)
PUT Add or Replace Single Source Code File
/code
https://developer.veevavault.com/api/23.1/#Add_Code
Note: We do not recommend using the following endpoint to deploy code as you may introduce code which breaks existing deployed code. For best practices, use the VPK Deploy method.
Add or replace a single .java file in the currently authenticated Vault. If the given file does not already exist in the Vault, it is added. If the file already exists in the Vault, the file is updated.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Delete Single Source Code File
/code/{class_name}
https://developer.veevavault.com/api/23.1/#Delete_Code
Note: We do not recommend using the following endpoint to deploy code as you may introduce code which breaks existing deployed code. For best practices, use the VPK Deploy method.
Delete a single source code file from the currently authenticated Vault. You cannot delete a code component currently in-use.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Disable Vault Extension
/code/{class_name}/disable
https://developer.veevavault.com/api/23.1/#Enable_Disable_Code
Disable a deployed Vault extension in the currently authenticated vault. Only available on entry-point classes, such as triggers and actions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Enable Vault Extension
/code/{class_name}/enable
https://developer.veevavault.com/api/23.1/#Enable_Disable_Code
Enable a deployed Vault extension in the currently authenticated vault. Only available on entry-point classes, such as triggers and actions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Signing Certificate
/services/certificate/{cert_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Signing_Certificate
The following endpoint allows you to retrieve a signing certificate included in a Spark message header to verify that the received message came from Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Single Source Code File
/code/{class_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Code
Retrieve a single source code file from the currently authenticated Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Validate Imported Package
/services/vobject/vault_package__v/{package_id}/actions/validate
https://developer.veevavault.com/api/23.1/#Validate_Imported_Code
Validate a previously imported VPK package with Vault Java SDK code. Note that this endpoint does not validate component dependencies for Configuration Migration packages.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Metadata Definition Language (MDL) (6)
POST Cancel HVO Deployment
/metadata/vobjects/{object_name}/actions/canceldeployment
https://developer.veevavault.com/api/23.1/#Cancel_HVO
Cancel a deployment of configuration changes to a high volume object. To use this endpoint, your HVO configuration_state must be IN_DEPLOYMENT.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Execute MDL Script
//mdl/execute
https://developer.veevavault.com/api/23.1/#Execute_MDL
This synchronous endpoint executes the given MDL script on a Vault. Note that some large operations require use of the asynchronous endpoint.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Execute MDL Script Asynchronously
//mdl/execute_async
https://developer.veevavault.com/api/23.1/#Execute_MDL_Async
This asynchronous endpoint executes the given MDL script on a Vault.
While you can execute any MDL script with this endpoint, it is required if you’re operating on 10,000+ high_volume object records and executing one of the following operations:
-
Enabling lifecycles
-
Enabling or disabling object types
-
Adding or removing a field
-
Updating the max length of any variable-length field, such as Text, Long Text, or Rich Text
-
Adding or removing an
Index -
Changing the fields that compose an
Indexor otherwise would cause reindexing to occur
After initiating this request, your high volume object’s configuration_state becomes IN_DEPLOYMENT. While an HVO is IN_DEPLOYMENT, you cannot edit its fields, list layouts, or indexes. If your HVO deployment request has not yet begun execution, you can cancel the deployment.
This endpoint can only queue one asynchronous change at a time. If you have multiple requests, you must wait for the previous request to complete or use a VPK.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve All Component Metadata
/metadata/components
https://developer.veevavault.com/api/23.1/#Retrieve_All_Component_Metadata
Retrieve metadata of all component types in your Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Asynchronous MDL Script Results
//mdl/execute_async/{job_id}/results
https://developer.veevavault.com/api/23.1/#Retrieve_MDL_Results
After submitting a request to deploy an MDL script asynchronously, you can query Vault to determine the results of the request.
Before submitting this request:
-
You must have previously requested a submission export job (via the API) which is no longer active.
-
You must have a valid
job_idfield value returned from the Execute MDL Script Asynchronously request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Component Type Metadata
/metadata/components/{component_type}
https://developer.veevavault.com/api/23.1/#Retrieve_Component_Type_Metadata
Retrieve metadata of a specific component type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Multi-File Extract (3)
POST Extract Data Files
/services/loader/extract
https://developer.veevavault.com/api/23.1/#Extract_Data_Files
Create a Loader job to extract one or more data files. Learn more about extracting data files with Vault Loader in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Loader Extract Renditions Results
/services/loader/{job_id}/tasks/{task_id}/results/renditions
https://developer.veevavault.com/api/23.1/#Retrieve_Rendition_Results
After submitting a request to extract object types from your Vault, you can query Vault to retrieve results of a specified job task that includes renditions requested with documents.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Loader Extract Results
/services/loader/{job_id}/tasks/{task_id}/results
https://developer.veevavault.com/api/23.1/#Retrieve_Extract_Results
After submitting a request to extract object types from your Vault, you can query Vault to retrieve results of a specified job task.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Multi-File Load (3)
POST Load Data Objects
/services/loader/load
https://developer.veevavault.com/api/23.1/#Request_File_Load
Create a loader job and load a set of data files.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (7)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Load Failure Log Results
/services/loader/{job_id}/tasks/{task_id}/failurelog
https://developer.veevavault.com/api/23.1/#Retrieve_Load_Results
Retrieve failure logs of the loader results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Load Success Log Results
/services/loader/{job_id}/tasks/{task_id}/successlog
https://developer.veevavault.com/api/23.1/#Retrieve_Load_Results
Retrieve success logs of the loader results.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Multi-Record Workflows (3)
POST Initiate Multi-Record Workflow
/objects/objectworkflows/actions/{workflow_name}
https://developer.veevavault.com/api/23.1/#Initiate_Multi_Record_Workflow
Initiate a multi-record workflow on a set of records. If any record is not in the relevant state or does not meet configured field conditions, the API returns INVALID_DATA for the invalid records and the workflow does not start.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Input a comma-separated list of records, in the format Object:{objectname}.{record_ID}. For example, Object:product__c.V3O000000005001. Maximum 100 records. |
GET Retrieve All Multi-Record Workflows
/objects/objectworkflows/actions
https://developer.veevavault.com/api/23.1/#Retrieve_Multi_Record_Workflows
Retrieve all available multi-record workflows which:
-
The authenticated user has permissions to view or initiate
-
Can be initiated through the API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Multi-Record Workflow Details
/objects/objectworkflows/actions/{workflow_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Multi_Record_Workflow_Details
Retrieves the fields required to initiate a specific multi-record workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The multi-record workflow name value. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Object Page Layouts (2)
GET Retrieve Page Layout Metadata
/metadata/vobjects/{object_name}/page_layouts/{layout_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Page_Layout_Metadata
Given a page layout name, retrieve the metadata for that specific page layout.
The page layout APIs consider the authenticated user’s permissions, so fields which are hidden from the authenticated user will not be included in the API response. For example, field-level security, object controls, and other object-level permissions are considered. Record-level permissions such as atomic security are not considered. Both active and inactive fields are included in the response.
Layout rules are not applied, but instead have their configurations returned as metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The name of the object from which to retrieve page layout metadata. |
|
|
The name of the page layout from which to retrieve metadata. |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Page Layouts
/metadata/vobjects/{object_name}/page_layouts
https://developer.veevavault.com/api/23.1/#Retrieve_Page_Layouts
Given an object, retrieve all page layouts associated with that object. You can use this data to retrieve specific page layout metadata.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Object Record Attachments (15)
POST Create Multiple Object Record Attachments
/vobjects/{object_name}/attachments/batch
https://developer.veevavault.com/api/23.1/#Create_Multiple_Object_Record_Attachments
You can create object record attachments in bulk with a JSON or CSV input file. You must first load the attachments to the file staging server. If the attachment already exists in your Vault, Vault uploads it as a new version of the existing attachment. Learn more about attachment versioning in Vault Help.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Object Record Attachment
/vobjects/{object_name}/{object_record_id}/attachments
https://developer.veevavault.com/api/23.1/#Create_Object_Record_Attachment
Create a single object record attachment. If the attachment already exists, Vault uploads the attachment as a new version of the existing attachment. Learn more about attachment versioning in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Delete Multiple Object Record Attachments
/vobjects/{object_name}/attachments/batch
https://developer.veevavault.com/api/23.1/#Delete_Multiple_Object_Record_Attachments
Delete object record attachments in bulk with a JSON or CSV input file. You can only delete the latest version of an attachment.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Object Record Attachment
/vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}
https://developer.veevavault.com/api/23.1/#Delete_Object_Record_Attachment
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Object Record Attachment Version
/vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version}
https://developer.veevavault.com/api/23.1/#Delete_Object_Record_Attachment_Version
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Determine if Attachments are Enabled on an Object
/metadata/vobjects/{object_name}
https://developer.veevavault.com/api/23.1/#Determine_if_Attachments_are_Enabled_on_an_Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download All Object Record Attachment Files
/vobjects/{object_name}/{object_record_id}/attachments/file
https://developer.veevavault.com/api/23.1/#Download_All_Object_Record_Attachment_Files
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download Object Record Attachment File
/vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version}/file
https://developer.veevavault.com/api/23.1/#Download_Object_Record_Attachment_File
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Restore Object Record Attachment Version
/vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version}
https://developer.veevavault.com/api/23.1/#Restore_Object_Record_Attachment_Version
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Object Record Attachment Metadata
/vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Record_Attachment_Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Object Record Attachment Version Metadata
/vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions/{attachment_version}
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Record_Attachment_Version_Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Object Record Attachment Versions
/vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}/versions
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Record_Attachment_Versions
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Object Record Attachments
/vobjects/{object_name}/{object_record_id}/attachments
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Record_Attachments
Retrieve a list of all attachments on a specific object record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Multiple Object Record Attachment Descriptions
/vobjects/{object_name}/attachments/batch
https://developer.veevavault.com/api/23.1/#Update_Multiple_Object_Record_Attachment_Descriptions
Update object record attachments in bulk with a JSON or CSV input file. You can only update the latest version of an attachment.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Object Record Attachment Description
/vobjects/{object_name}/{object_record_id}/attachments/{attachment_id}
https://developer.veevavault.com/api/23.1/#Update_Object_Record_Attachment_Description
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
This is the only editable field. The maximum length is 1000 characters. |
Object Record User Actions (4)
POST Initiate Object Action on Multiple Records
/vobjects/{object_name}/actions/{action_name}
https://developer.veevavault.com/api/23.1/#Bulk_Initiate_Action
Use this request to initiate an object user action on multiple records. Maximum 500 records per batch.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Comma separated list of object record ids on which to initiate the action. |
POST Initiate Object Action on a Single Record
/vobjects/{object_name}/{object_record_id}/actions/{action_name}
https://developer.veevavault.com/api/23.1/#Initiate_Object_Record_Lifecycle_Action
Use this request to initiate an action on a specific object record.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Object Record User Actions
/vobjects/{object_name}/{object_record_id}/actions
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Record_Lifecycle_Actions
Retrieve all available user actions that can be initiated on a specific object record which:
-
The authenticated user has permissions to view or initiate
-
Can be initiated through the API
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Object User Actions Details
/vobjects/{object_name}/{object_record_id}/actions/{action_name}
https://developer.veevavault.com/api/23.1/#retrieve-object-user-action-details
Once you’ve retrieved the available user actions, use this request to retrieve the details for a specific user action.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Object Roles (3)
POST Assign Users & Groups to Roles on Object Records
/vobjects/{object_name}/roles
https://developer.veevavault.com/api/23.1/#Assign_Users_Groups_to_Roles_Objects
Assign users and groups to roles on an object record in bulk.
-
The maximum CSV input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Assigning users and groups to roles is additive, and duplicate groups are ignored. For example, if groups 1 and 2 are currently assigned to a particular role and you assign groups 2 and 3 to the same role, the final list of groups assigned to the role will be 1, 2, and 3.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
DELETE Remove Users & Groups from Roles on Object Records
/vobjects/{object_name}/roles
https://developer.veevavault.com/api/23.1/#Remove_Users_Groups_Roles_Objects
Remove users and groups from roles on an object record in bulk.
-
The maximum CSV input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Object Record Roles
/vobjects/{object_name}/{id}/roles/{role_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Roles
Retrieve manually assigned roles on an object record and the users and groups assigned to them.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Object Types (3)
POST Change Object Type
/vobjects/{object_name}/actions/changetype
https://developer.veevavault.com/api/23.1/#Change_Object_Type
Change the object types assigned to object records. Any field values which exist on both the original and new object type will carry over to the new type. All other field values will be removed, as only fields on the new type are valid. You can set field values on the new object type in the CSV input.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
GET Retrieve Details from All Object Types
/configuration/Objecttype
https://developer.veevavault.com/api/23.1/#Retrieve_Details_All_Object_Types
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Details from a Specific Object
/configuration/{object_name_and_object_type}
https://developer.veevavault.com/api/23.1/#Retrieve_Details_Specific_Object
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Picklists (6)
POST Create Picklist Values
/objects/picklists/{picklist_name}
https://developer.veevavault.com/api/23.1/#Create_Picklist_Values
Add new values to a picklist. You can add up to 1024 values to any picklist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Inactivate Picklist Value
/objects/picklists/{picklist_name}/{picklist_value_name}
https://developer.veevavault.com/api/23.1/#Delete_Picklist_Value
Note: If you need to inactivate a picklist value, it is best practice to use Update Picklist Value.
Inactivate a value from a picklist. This does not affect picklist values that are already in use.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve All Picklists
/objects/picklists
https://developer.veevavault.com/api/23.1/#Retrieve_All_Picklists
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Picklist Values
/objects/picklists/{picklist_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Picklist_Values
Retrieve all available values configured on a picklist.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Picklist Value
/objects/picklists/{picklist_name}/{picklist_value_name}
https://developer.veevavault.com/api/23.1/#Update_Picklist_Value_Name
Change a picklist value name or status. To change a picklist value label, see Update Picklist Value Label.
Use caution when editing picklist value names. When you change a picklist value name, it may affect existing document and object metadata that refer to the picklist. This may also break existing integrations that access picklist values via the API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Picklist Value Label
/objects/picklists/{picklist_name}
https://developer.veevavault.com/api/23.1/#Update_Picklist_Value_Label
Change a picklist value label (only). To change a picklist value name, see the next section below.
Use caution when editing picklist labels or names. When these attributes are changed, they affect all existing document and object metadata that refer to the picklist. For users in the UI who are accustomed to seeing a particular selection, the changes may cause confusion. This may also break existing integrations that access picklist values via the API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Pre-Production Vaults (2)
POST Build Production Vault
/objects/sandbox/actions/buildproduction
https://developer.veevavault.com/api/23.1/#Build_Production
Given a pre-production Vault, build a production Vault. This is analogous to the Build action in the Vault UI. After building your Vault, you can promote it to production.
You can build or rebuild the source Vault for a given pre-production Vault no more than three times in a 24 hour period.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The name of the source vault to build. This can be the current pre-production vault or a sandbox vault. Sandboxes must be active and match the release type (General or Limited) of the pre-production vault. |
POST Promote to Production
/objects/sandbox/actions/promoteproduction
https://developer.veevavault.com/api/23.1/#Promote_Production
Given a built pre-production Vault, promote it to a production Vault. This is analogous to the Promote action in the Vault UI.
You must build your pre-production Vault before you can promote it to production.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The name of the pre-production vault to promote. |
Queues (5)
PUT Disable Delivery
/services/queues/{queue_name}/actions/disable_delivery
https://developer.veevavault.com/api/23.1/#Disable_Delivery
The following endpoint allows you to disable the delivery of messages in an outbound Spark messaging queue, or an SDK job queue. This stop messages from exiting the queue. For example, disabling delivery on an SDK job queue stops messages from being delivered to the processor.
This endpoint is not available for inbound Spark messaging queues. There is no way to stop received messages from processing in an inbound Spark queue.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Enable Delivery
/services/queues/{queue_name}/actions/enable_delivery
https://developer.veevavault.com/api/23.1/#Enable_Delivery
The following endpoint allows you to enable the delivery of messages in an outbound Spark messaging queue, or an SDK job queue. This allows messages to exit the queue. For example, enabling delivery on an SDK job queue allows messages to be delivered to the processor.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Reset Queue
/services/queues/{queue_name}/actions/reset
https://developer.veevavault.com/api/23.1/#Reset_Queue
Delete all messages in a specific queue. This action is final and cannot be undone.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve All Queues
/services/queues
https://developer.veevavault.com/api/23.1/#Retrieve_All_Queues
Retrieve all queues in a Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Queue Status
/services/queues/{queue_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Queues_Status
Retrieve the status of a specific queue.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Resumable Upload Sessions (7)
DELETE Abort Upload Session
/services/file_staging/upload/{upload_session_id}
https://developer.veevavault.com/api/23.1/#Abort_Upload_Session
Abort an active upload session and purge all uploaded file parts. Admin users can see and abort all upload sessions, while non-Admin users can only see and abort sessions where they are the owner.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Commit Upload Session
/services/file_staging/upload/{upload_session_id}
https://developer.veevavault.com/api/23.1/#Commit_Upload_Session
Mark an upload session as complete and assemble all previously uploaded parts to create a file.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Resumable Upload Session
/services/file_staging/upload
https://developer.veevavault.com/api/23.1/#Create_Upload_Session
Initiate a multipart upload session and return an upload session ID.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The absolute path, including file name, to place the file in the staging server. This path is specific to the authenticated user. Admin users can access the root directory. All other users can only access their own user directory. |
|
|
The size of the file in bytes. The maximum file size is 500GB. |
GET Get Upload Session Details
/services/file_staging/upload/{upload_session_id}
https://developer.veevavault.com/api/23.1/#Get_Upload_Session_Details
Retrieve the details of an active upload session. Admin users can get details for all sessions, while non-Admin users can only get details for sessions if they are the owner.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET List File Parts Uploaded to Session
/services/file_staging/upload/{upload_session_id}/parts
https://developer.veevavault.com/api/23.1/#List_File_Parts_Uploaded_to_Session
Return a list of parts uploaded in a session. You must be an Admin user or the session owner.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET List Upload Sessions
/services/file_staging/upload
https://developer.veevavault.com/api/23.1/#List_Upload_Sessions
Return a list of active upload sessions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Upload to a Session
/services/file_staging/upload/{upload_session_id}
https://developer.veevavault.com/api/23.1/#Upload_to_Session
The session owner can upload parts of a file to an active upload session. By default, you can upload up to 2000 parts per upload session, and each part can be up to 50MB. Use the Range header to specify the range of bytes for each upload, or split files into parts and add each part as a separate file. Each part must be the same size, except for the last part in the upload session.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The part number, which uniquely identifies a file part and defines its position within the file as a whole. If a part is uploaded using a part number that has already been used, Vault overwrites the previously uploaded file part. You must upload parts in numerical order. For example, you cannot upload part 3 without first uploading parts 1 and 2. |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Retrieve Binders (3)
GET Retrieve All Binder Versions
/objects/binders/{binder_id}/versions
https://developer.veevavault.com/api/23.1/#Retrieve_All_Binder_Versions
Retrieve all versions of a binder.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Binder
/objects/binders/{binder_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Binder
-
Use this endpoint to retrieve all fields and values configured on a specific binder in you Vault (using the binder ID).
-
The response includes the "first level" of the binder section node structure.
-
To retrieve additional levels in the binder section node structure, use one of the
depthparameters described below. -
For binders with unbound documents, the response includes versions based on binder display options for unbound documents set in the UI. Learn more about Document Type Settings in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Binder Version
/objects/binders/{binder_id}/versions/{major_version}/{minor_version}
https://developer.veevavault.com/api/23.1/#Retrieve_Binder_Version
Retrieve the fields and values configured on a specific version of a specific binder.
For binders with unbound documents, the response includes versions based on binder display options for unbound documents set in the UI. Learn more about Document Type Settings in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Retrieve Component Records (3)
GET Component Record Collection
/configuration/{component_type}
https://developer.veevavault.com/api/23.1/#Retrieve_Component_Record_Collection
Retrieve all records for a specific component type.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Component Record (MDL)
//mdl/components/{component_type_and_record_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Component_Record_MDL
Retrieve metadata of a specific component record as MDL. To retrieve as JSON or XML, see Retrieve Component Record. Vault does not generate RECREATE statements for all component types. For details, see the Generate RECREATE column in the Component Support Matrix.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Component Record (XML/JSON)
/configuration/{component_type_and_record_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Component_Record
Retrieve metadata of a specific component record as JSON or XML. To retrieve as MDL, see Retrieve Component Record MDL. Not all component types are eligible for record description retrieval. For details, see the Describe column in the Component Support Matrix.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Retrieve Document Fields (2)
GET Retrieve All Document Fields
/metadata/objects/documents/properties
https://developer.veevavault.com/api/23.1/#Retrieve_All_Document_Fields
Retrieve all standard and custom document fields and field properties.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Retrieve Common Document Fields
/metadata/objects/documents/properties/find_common
https://developer.veevavault.com/api/23.1/#Retrieve_Common_Document_Fields
Retrieve all document fields and field properties which are common to (shared by) a specified set of documents. This allows you to determine which document fields are eligible for bulk update.
Learn about Shared Fields in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Input a comma-separated list of document id field values. |
Retrieve Document Types (4)
GET Retrieve All Document Types
/metadata/objects/documents/types
https://developer.veevavault.com/api/23.1/#Retrieve_All_Document_Types
Retrieve all document types. These are the top-level of the document type/subtype/classification hierarchy.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Classification
/metadata/objects/documents/types/{type}/subtypes/{subtype}/classifications/{classification}
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Classification
Retrieve all metadata from a document classification.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Subtype
/metadata/objects/documents/types/{type}/subtypes/{subtype}
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Subtype
Retrieve all metadata from a document subtype, including all of its classifications (when available).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Type
/metadata/objects/documents/types/{type}
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Type
Retrieve all metadata from a document type, including all of its subtypes (when available).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Retrieve Documents (7)
GET Download Document File
/objects/documents/{doc_id}/file
https://developer.veevavault.com/api/23.1/#Download_Document_File
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
If true, the step shall execute a streaming download |
|
|
N/A |
GET Download Document Version File
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/file
https://developer.veevavault.com/api/23.1/#Download_Document_Version_File
Download the file of a specific document version.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Download Document Version Thumbnail File
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}/thumbnail
https://developer.veevavault.com/api/23.1/#Download_Document_Version_Thumbnail
Download the thumbnail image file of a specific document version.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve All Documents
/objects/documents
https://developer.veevavault.com/api/23.1/#Retrieve_All_Documents
Retrieve the latest version of documents and binders to which you have access.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document
/objects/documents/{doc_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Single_Document
Retrieve all metadata from a document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Version
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Version
Retrieve all fields and values configured on a document version.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Document Versions
/objects/documents/{doc_id}/versions
https://developer.veevavault.com/api/23.1/#Retrieve_Document_Versions
Retrieve all versions of a document.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
SCIM (2)
GET Retrieve SCIM Resources
/scim/v2/{type}
https://developer.veevavault.com/api/23.1/#SCIM_Retrieve_Resource_Type_Info
Retrieve a single SCIM resource type. Defines the endpoints, the core schema URI which defines this resource, and any supported schema extensions.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Single SCIM Resource
/scim/v2/{type}/{id}
https://developer.veevavault.com/api/23.1/#SCIM_Retrieve_Single_Resource
Retrieve a single SCIM resource.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Sandbox Snapshots (5)
POST Create Sandbox Snapshot
/objects/sandbox/snapshot
https://developer.veevavault.com/api/23.1/#Create_Snapshot
Create a new snapshot for the indicated sandbox Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
The name of the sandbox Vault to take a snapshot of. |
|
|
The name of the new snapshot. |
DELETE Delete Sandbox Snapshot
/objects/sandbox/snapshot/{api_name}
https://developer.veevavault.com/api/23.1/#Delete_Snapshot
Delete a snapshot managed by the authenticated Vault. Deleted snapshots cannot be recovered. Learn more about deleting snapshots in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Sandbox Snapshots
/objects/sandbox/snapshot
https://developer.veevavault.com/api/23.1/#Retrieve_Snapshots
Retrieve information about snapshots managed by the authenticated Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Update Sandbox Snapshot
/objects/sandbox/snapshot/{api_name}/actions/update
https://developer.veevavault.com/api/23.1/#Update_Snapshot
Recreate a snapshot for the same source sandbox Vault. This request replaces the existing snapshot with the newly created one. Learn more about updating snapshots in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Upgrade Sandbox Snapshot
/objects/sandbox/snapshot/{api_name}/actions/upgrade
https://developer.veevavault.com/api/23.1/#Upgrade_Snapshot
Upgrade a sandbox snapshot to match the release version of the source sandbox Vault.
Your request to upgrade a snapshot is only valid if the upgrade_status=Upgrade Available or Upgrade Required. Use the Retrieve Sandbox Snapshots request to obtain the upgrade_status of a snapshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Sandbox Vaults (8)
POST Change Sandbox Size
/objects/sandbox/batch/changesize
https://developer.veevavault.com/api/23.1/#Change_Sandbox_Size
Change the size of a sandbox Vault for the authenticated Vault. You can initiate this action if there are sufficient allowances and the current sandbox meets the data and user limits of the requested size. Learn more about sandbox sizes in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create or Refresh Sandbox
/objects/sandbox
https://developer.veevavault.com/api/23.1/#Create_Refresh_Sandbox
Create a new sandbox for the currently authenticated Vault. Include the source_snapshot parameter in the request body to create a new sandbox from an existing snapshot.
Providing a name which already exists will refresh the existing sandbox Vault. You can also refresh a sandbox from a snapshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
The size of the sandbox: Small, Large, or Full. |
|
|
The domain to use for the new sandbox. Must be a valid domain. You can retrieve valid domains from the Retrieve Domains endpoint. Only domains of type: Sandbox are allowed. Must be lower-case, and must include the domain extension. |
|
|
The name of the sandbox vault, which appears on the My Vaults page. Providing a new name creates a new sandbox, whereas providing an existing name refreshes the existing sandbox. How often you can refresh a Vault depends on its size. Learn more about refreshing sandboxes in Vault Help. |
DELETE Delete Sandbox
/objects/sandbox/{name}
https://developer.veevavault.com/api/23.1/#Delete_Sandbox
Delete a sandbox Vault. How often you can delete a Vault depends on its size. Learn more about deleting sandboxes in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Recheck Sandbox Usage Limit
/objects/sandbox/actions/recheckusage
https://developer.veevavault.com/api/23.1/#Recheck_Sandbox_Usage_Limit
Recalculate the usage values of the sandbox Vaults for the authenticated Vault. This action can be initiated up to three (3) times in a 24-hour period. In the UI, this information is available in Admin > Settings. Learn more about viewing usage details in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Refresh Sandbox from Snapshot
/objects/sandbox/{vault_id}/actions/refresh
https://developer.veevavault.com/api/23.1/#Refresh_Sandbox_from_Snapshot
Refresh a sandbox Vault in the currently authenticated Vault from an existing snapshot.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
Provide the api_name of the snapshot to refresh the sandbox from. You can obtain the api_name using the Retrieve Sandbox Snapshots request. |
GET Retrieve Sandbox Details by ID
/objects/sandbox/{vault_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Sandbox_Details_By_ID
Retrieve information about the sandbox Vaults for the authenticated vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Sandboxes
/objects/sandbox
https://developer.veevavault.com/api/23.1/#Retrieve_Sandboxes
Retrieve information about the sandbox Vaults for the authenticated vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Set Sandbox Entitlements
/objects/sandbox/entitlements/set
https://developer.veevavault.com/api/23.1/#Set_Sandbox_Entitlements
Set new sandbox entitlements, including granting and revoking allowances, for the given sandbox name.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (4)
|
Option Name |
Description |
|---|---|
|
|
The name of the sandbox vault, which appears on the My Vaults page. Providing a new name creates a new sandbox, whereas providing an existing name refreshes the existing sandbox. How often you can refresh a Vault depends on its size. Learn more about refreshing sandboxes in Vault Help. |
|
|
The size of the sandbox: Small, Large, or Full. |
|
|
The number of entitlements to grant or revoke. |
|
|
Allowed values true and false. True grants allowances and false revokes them. |
Security Policies (3)
GET Retrieve All Security Policies
/objects/securitypolicies
https://developer.veevavault.com/api/23.1/#Retrieve_All_Security_Policies
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Security Policy
/objects/securitypolicies/{security_policy_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Single_Security_Policy
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Security Policy Metadata
/metadata/objects/securitypolicies
https://developer.veevavault.com/api/23.1/#Retrieve_Security_Policy_Metadata
Retrieve the metadata associated with the security policy object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Update Binders (3)
POST Refresh Binder Auto-Filing
/objects/binders/{binder_id}/actions
https://developer.veevavault.com/api/23.1/#Refresh_Binder_AutoFiling
This is only available in eTMF Vaults on binders configured with the TMF Reference Models.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Binder
/objects/binders/{binder_id}
https://developer.veevavault.com/api/23.1/#Update_Binder
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Binder Version
/objects/binders/{binder_id}/versions/{major_version}/{minor_version}
https://developer.veevavault.com/api/23.1/#Update_Binder_Version
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Update Documents (6)
POST Create Multiple Document Versions
/objects/documents/versions/batch
https://developer.veevavault.com/api/23.1/#Create_Document_Versions_Bulk
Create or add document versions in bulk.
-
The maximum CSV input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Create Single Document Version
/objects/documents/{doc_id}
https://developer.veevavault.com/api/23.1/#Create_Document_Version
Note: If you need to create more than one document version, it is best practice to use the bulk API.
Add a new draft version of an existing document. You can choose to either use the existing source file, or a new source file. These actions will increase the document’s minor version number. This is analogous to using the Create Draft action in the UI.
Note that not all documents are eligible for draft creation. For example, you cannot create a draft of a checked out document. Learn more in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (3)
|
Option Name |
Description |
|---|---|
|
|
File to upload |
|
|
Draft creation mode |
|
|
Document description |
PUT Reclassify Multiple Documents
/objects/documents/batch/actions/reclassify
https://developer.veevavault.com/api/23.2/#Reclassify_Multiple_Documents
Reclassify allows you to change the document type of an existing document or assign a document type to an unclassified document. This endpoint is analogous to the _Reclassify_ action in the Vault UI.
A document "type" is the combination of the type__v, subtype__v, and classification__v fields on a document. When you reclassify, Vault may add or remove certain fields on the document. Add these new fields and values to the body of this request. If a new required field is missing, the error response will list the name of the required field. The API does not currently support bulk reclassify.
Not all documents are eligible for reclassification. For example, you can only reclassify the latest version of a document and you cannot reclassify a checked out document. Learn more about
reclassifying documents in Vault Help
.
-
The maximum CSV input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the
standard format.
-
The maximum batch size is 1,000.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Document Version
/objects/documents/{doc_id}/versions/{major_version}/{minor_version}
https://developer.veevavault.com/api/23.1/#Update_Document_Version
Update editable field values on a specific version of a document. See also Update Document above.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Multiple Documents
/objects/documents/batch
https://developer.veevavault.com/api/23.1/#Update_Documents
Bulk update editable field values on multiple documents. You can only update the latest version of each document. To update past document versions, see Update Document Version.
-
The maximum CSV input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 1,000.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update Single Document
/objects/documents/{doc_id}
https://developer.veevavault.com/api/23.1/#Update_Document
Note: If you need to update more than one document, it is best practice to use the bulk API.
Update editable field values on the latest version of a single document. To update past document versions, see Update Document Version. Note that this endpoint does not allow you to update the archive__v field. To archive a document, or to update multiple documents at once, see Update Multiple Documents.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
The id value of the Vault to initiate the delegated session. |
Update Users (3)
PUT Update Multiple Users
/objects/users
https://developer.veevavault.com/api/23.1/#Update_Multiple_Users
Note: Beginning in v18.1, Admins create and manage users with user__sys object records. Unless you are updating domain-only users, we strongly recommend using the Update Object Records endpoint to update users.
Update information for multiple users at once.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update My User
/objects/users/me
https://developer.veevavault.com/api/23.1/#Update_My_User
Update information for the currently authenticated user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Single User
/objects/users/{id}
https://developer.veevavault.com/api/23.1/#Update_Single_User
Note: Beginning in v18.1, Admins create and manage users with user__sys object records. Unless you are updating domain-only users, we strongly recommend using the Update Object Records endpoint to update users.
Update information for a single user. To update information for multiple users, see Retrieve All Users.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Users (14)
POST Change My Password
/objects/users/me/password
https://developer.veevavault.com/api/23.1/#Change_User_Password
Change the password for the currently authenticated user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
POST Create User with SCIM
/scim/v2/Users
https://developer.veevavault.com/api/23.1/#SCIM_Create_User
Create a user with SCIM.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (5)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Disable User
/objects/users/{user_id}
https://developer.veevavault.com/api/23.1/#Disable_User
Disable a user in a specific Vault or disable a user in all Vaults in the domain.
Note: This endpoint disables users at the domain level. Beginning in v18.1, Admins create and manage users with user__sys object records. To disable users in an individual Vault, use the single or bulk Initiate Object Action endpoint to initiate the Make User Inactive action on the desired records.
Permissions
System Admins and Vault Owners can update users in the Vaults where they have administrative access. System Admins who are also Domain Admins have an unrestricted access to users across all Vaults in the domain.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve All Users
/objects/users
https://developer.veevavault.com/api/23.1/#Retrieve_All_Users
Note: This endpoint retrieves user records at the domain level. Beginning in v18.1, Admins create and manage users with user__sys object records. We strongly recommend using the Retrieve Object Record Collection endpoint to retrieve user__sys records.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve All Users with SCIM
/scim/v2/Users
https://developer.veevavault.com/api/23.1/#SCIM_Retrieve_Users
Retrieve all users with SCIM.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Current User with SCIM
/scim/v2/Me
https://developer.veevavault.com/api/23.1/#SCIM_Retrieve_Me
Retrieve the currently authenticated user with SCIM.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve My User Permissions
/objects/users/me/permissions
https://developer.veevavault.com/api/23.1/#Retrieve_My_User_Permissions
Retrieve all object and object field permissions (read, edit, create, delete) assigned to the currently authenticated user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Single User with SCIM
/scim/v2/Users/{id}
https://developer.veevavault.com/api/23.1/#SCIM_Retrieve_User
Retrieve a specific user with SCIM.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve User
/objects/users/{id}
https://developer.veevavault.com/api/23.1/#Retrieve_User
Note: This endpoint retrieves user records at the domain level. Beginning in v18.1, Admins create and manage users with user__sys object records. We strongly recommend using the Retrieve Object Record endpoint to retrieve a user__sys record.
Retrieve information for one user. To get information for all users, see Retrieve All Users
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve User Metadata
/metadata/objects/users
https://developer.veevavault.com/api/23.1/#Retrieve_User_Metadata
Note: This endpoint retrieves user metadata at the domain level. Beginning in v18.1, Admins create and manage users with user__sys object records. We strongly recommend using the Retrieve Object Metadata endpoint to retrieve user__sys metadata.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve User Permissions
/objects/users/{id}/permissions
https://developer.veevavault.com/api/23.1/#Retrieve_User_Permissions
Retrieve all object and object field permissions (read, edit, create, delete) assigned to a specific user.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Current User with SCIM
/scim/v2/Me
https://developer.veevavault.com/api/23.1/#SCIM_Update_Me
Update the currently authenticated user with SCIM.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
PUT Update User with SCIM
/scim/v2/Users/{id}
https://developer.veevavault.com/api/23.1/#SCIM_Update_User
Update fields values on a single user with SCIM.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (2)
|
Option Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
PUT Update Vault Membership
/objects/users/{user_id}/vault_membership/{vault_id}
https://developer.veevavault.com/api/23.1/#Update_Vault_Membership
Use this request to:
-
Assign an existing user to a Vault in your domain.
-
Remove (disable) an existing user from a Vault in your domain.
-
Update the security profile and license type of an existing user.
You cannot use this request to:
-
Create a new user. See Create Object Records.
-
Update other user profile information. See Update Object Records.
Additional information:
-
For a list of user fields and properties, see Retrieve Users.
-
Learn about Creating & Managing Users and Managing Users Across Vaults in Vault Help.
Permissions
System Admins and Vault Owners can update users in the Vaults where they have administrative access. System Admins who are also Domain Admins have an unrestricted access to users across all Vaults in the domain.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Vault Objects (14)
POST Cascade Delete Object Record
/vobjects/{object_name}/{object_record_id}/actions/cascadedelete
https://developer.veevavault.com/api/23.1/#Cascade_Delete_Object_Record
This asynchronous endpoint will delete a single parent object record and all related children and grandchildren.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
POST Create Object Records
/vobjects/{object_name}
https://developer.veevavault.com/api/23.1/#Create_Object_Record
You can use this endpoint to create User Tasks or User (user__sys) records. Learn more about User Tasks and the User & Person Objects in Vault Help.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Note that you can only add relationships on object fields using ID values or based on a unique field on the target object. This API does not support object lookup fields
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Can be text/csv or application/json |
|
|
Can be text/csv or application/json |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
POST Deep Copy Object Record
/vobjects/{object_name}/{object_record_id}/actions/deepcopy
https://developer.veevavault.com/api/23.1/#Deep_Copy_Object_Record
Deep Copy copies an object record, including all of the record’s related child
and grandchild records. Each deep (hierarchical) copy can copy a maximum of
10,000 related records at a time.
See Copying Object Records for details on required access permissions.
Note: You can perform a regular copy of an object record using the Create Object endpoint with the source_record_id field.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
DELETE Delete Object Records
/vobjects/{object_name}
https://developer.veevavault.com/api/23.1/#Delete_Object_Record
Delete Object Records in bulk. Admins can also define special deletion rules for objects, which affects how Vault behaves when you attempt to delete an object record. Learn more about limitations on object record deletion in Vault Help.
If you need to delete a parent record along with all of its children and grandchildren, use the Cascade Delete endpoint.
Note that you cannot use this API to delete user__sys records. Use the Update Object Records endpoint to set the status__v field to inactive.
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Can be text/csv or application/json |
|
|
Can be text/csv or application/json |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Deleted Object Record ID
/objects/deletions/vobjects/{object_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Deleted_Object_Records
Retrieve the IDs of object records that have been deleted from your Vault within the past 30 days. After object records are deleted from a Vault, their IDs are still available for retrieval for 30 days. After that, they cannot be retrieved. You can use the optional request parameters below to narrow the results to a specific date and time range within the past 30 days.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Limits on Objects
/limits
https://developer.veevavault.com/api/23.1/#Retrieve_Limits_Objects
Vault limits the number of object records that can be created for each object (product__v, study__v, custom_object__c, etc.). There is also a limit to the number of custom objects that can be created in each Vault. To retrieve these limits:
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Object Collection
/metadata/vobjects
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Collection
Retrieve all Vault objects in the authenticated Vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Object Field Metadata
/metadata/vobjects/{object_name}/fields/{object_field_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Field_Metadata
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The object name__v field value (product__v, country__v, custom_object__c, etc.). |
|
|
The object field name value (id, name__v, external_id__v, etc.). |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Object Record
/vobjects/{object_name}/{object_record_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Record
Retrieve metadata configured on a specific object record in your vault.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Object Record Collection
/vobjects/{object_name}
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Record_Collection
Retrieve all records for a specific Vault Object.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
The object name__v field value (product__v, country__v, custom_object__c, etc.). |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Results of Cascade Delete Job
/vobjects/cascadedelete/results/{object_name}/{job_status}/{job_id}
https://developer.veevavault.com/api/23.1/#Get_Results_Cascade_Delete
After submitting a request to cascade delete an object record, you can query Vault to determine the results of the request.
Before submitting this request:
-
You must have previously requested a cascade delete job (via the API) which is no longer active.
-
You must have a valid
job_id value, retrieved from the response of the cascade delete request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Results of Deep Copy Job
/vobjects/deepcopy/results/{object_name}/{job_status}/{job_id}
https://developer.veevavault.com/api/23.1/#Get_Results_Deep_Copy
After submitting a request to deep copy an object record, you can query Vault to determine the results of the request.
Before submitting this request:
-
You must have previously requested a deep copy job (via the API) which is no longer active.
-
You must have a valid
job_idvalue, retrieved from the response of the deep copy request.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Corporate Currency Fields
/vobjects/{object_name}/actions/updatecorporatecurrency
https://developer.veevavault.com/api/23.1/#Update_Object_Corp_Currency
Currency is a field type available on all Vault objects. Whenever a user populates a local currency field value, Vault automatically populates the related corporate currency field value, except in the following scenarios:
-
Admins change the Corporate Currency setting for the vault
-
Admins update the Rate setting for the local currency used by a record
This endpoint updates the field_corp__sys field values of an object record based on the Rate of the currency, denoted by the local_currency__sys field of the specified record. Learn more about Currency Fields in Vault Help.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
PUT Update Object Records
/vobjects/{object_name}
https://developer.veevavault.com/api/23.1/#Update_Object_Records
Update Object Records in bulk. You can use this endpoint to update user records (user__sys).
-
The maximum input file size is 1GB.
-
The values in the input must be UTF-8 encoded.
-
CSVs must follow the standard format.
-
The maximum batch size is 500.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
Can be text/csv or application/json |
|
|
Can be text/csv or application/json |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Vault Query Language (VQL)
POST Submitting a Query
/query
https://developer.veevavault.com/api/23.1/#Submit_Query
VQL queries go to the /query REST interface.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Options (1)
|
Option Name |
Description |
|---|---|
|
|
N/A |
Workflow Tasks (5)
POST Initiate Workflow Task Action
/objects/objectworkflows/tasks/{task_id}/actions/{task_action}
https://developer.veevavault.com/api/23.1/#Initiate_Workflow_Task_Action
Initiate a workflow task action. Note that the API does not support initiating task actions requiring eSignatures (where esignature is true).
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Workflow Task Action Details
/objects/objectworkflows/tasks/{task_id}/actions/{task_action}
https://developer.veevavault.com/api/23.1/#Retrieve_Workflow_Task_Action_Details
Retrieve the details of a specific workflow task action. The response lists the details of the task action, including all fields required to initiate the action. Note that task actions where esignature is true cannot be initiated via the API.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Workflow Task Actions
/objects/objectworkflows/tasks/{task_id}/actions
https://developer.veevavault.com/api/23.1/#Retrieve_Workflow_Task_Actions
Retrieve all available actions that can be initiated on a given workflow task.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Workflow Task Details
/objects/objectworkflows/tasks/{task_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Workflow_Task_Details
Retrieve the details of a specific workflow task.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Workflow Tasks
/objects/objectworkflows/tasks
https://developer.veevavault.com/api/23.1/#Retrieve_Object_Workflow_Tasks
Retrieve all available tasks across all workflows.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
Workflows (5)
POST Initiate Workflow Action
/objects/objectworkflows/{workflow_id}/actions/{workflow_action}
https://developer.veevavault.com/api/23.1/#Initiate_Workflow_Action
Initiate a workflow action on a specific object workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Workflow Action Details
/objects/objectworkflows/{workflow_id}/actions/{workflow_action}
https://developer.veevavault.com/api/23.1/#Retrieve_Workflow_Action_Details
Retrieve details about a workflow action. For example, the prompts needed to complete a workflow action.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Workflow Actions
/objects/objectworkflows/{workflow_id}/actions
https://developer.veevavault.com/api/23.1/#Retrieve_Workflow_Actions
Retrieve all available workflow actions that can be initiated on a specific object workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Workflow Details
/objects/objectworkflows/{workflow_id}
https://developer.veevavault.com/api/23.1/#Retrieve_Workflow_Details
Retrieve the details for a specific object workflow.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
GET Retrieve Workflows
/objects/objectworkflows
https://developer.veevavault.com/api/23.1/#Retrieve_Workflows
Retrieve all workflows for a specific object and object record or from a specific workflow participant.
Parameters
|
Parameter Name |
Description |
|---|---|
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |
|
|
N/A |