Execute MDL Script Asynchronously

This asynchronous endpoint executes the given MDL script on a Vault.

While you can execute any MDL script asynchronously, this endpoint is required if you’re operating on 10,000+ high volume object records and executing one of the following operations:

Enabling lifecycles
Enabling object types
Adding or removing a field
Updating the max length of a text field
Adding or removing an Index
Changing the fields that compose an Index

POST/api/mdl/execute_async

Headers

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

Body Parameters

The body of the request should contain the MDL script to execute. Enter the body as raw data. The body must start with one of the following values:

CREATE
RECREATE
RENAME
ALTER
DROP

Learn more in the MDL Commands documentation.

Request

curl -X POST -H "Authorization: {SESSION_ID}" \
-H "Content-Type: application/json" \
--data-binary @"hvo.txt" \
https://myvault.veevavault.com/api/mdl/execute_async

Example Body: RECREATE Picklist

RECREATE Picklist color__c (
   label('Color'),
   active(true),
   Picklistentry red__c(
      value('Red'),
      order(1),
      active(true)
   ),
   Picklistentry blue__c(
      value('Blue'),
      order(2),
      active(true)
   ),
   Picklistentry green__c(
      value('Green'),
      order(3),
      active(true)
   )
);

Response

{
   "responseStatus": "SUCCESS",
   "script_execution": {
       "code": "GEN-S-0",
       "message": "OK",
       "warnings": 0,
       "failures": 0,
       "exceptions": 0,
       "components_affected": 1,
       "execution_time": 0.622
   },
   "job_id": 327103,
   "url": "/api/v21.1/services/jobs/327103"
}

Response Details

On SUCCESS, the response includes the following information:

Name	Description
`job_id`	The Job ID value to retrieve the status and results of this request
`url`	URL to retrieve the current job status of this request
`code`	The response code indicating the if the script passed or failed syntax validation
`message`	A descriptive message for any warnings, failures, or exceptions, otherwise `OK`
`warnings`	The number of warnings received while validating the script syntax
`failures`	The number of errors received while validating the script syntax
`exceptions`	The number of exceptions received while validating the script syntax
`components_affected`	The number of components affected by this script
`execution_time`	The length of time taken to validate this script syntax, in milliseconds