Enable Study Migration Mode

Enable Study Migration Mode for multiple Study records. Sending a request to this endpoint initiates a job to set the study_migration__v field on Study records and their related object records with the value m__v. You can enable Study Migration Mode for up to 500 Study records in a single request.

When a Study enters Study Migration Mode, Vault makes study-related object data for that study hidden and uneditable for non-Admin users. Study Migration Mode also bypasses record triggers for the target studies, such as calculating metrics and generating related records. Learn more about status and archiving studies in Vault Help. Learn more about Clinical Study Migrations.

POST/api/{version}/app/clinical/studies/actions/enable_migration_mode

Headers

Name	Description
`Content-Type`	`application/json`
`Accept`	`application/json`

Body Parameters

In the body of the request, upload the following parameter as a CSV or JSON input file:

Name	Description
`id` required	The ID of the Study record.

Request

curl -X POST -H "Authorization: {SESSION_ID}" \
-H "Content-Type: application/json" \
--data-raw '[
    {
        "id": "0ST000000003001"
    },
    {
        "id": "0ST000000003003"
    }
]' \
https://myvault.veevavault.com/api/v26.1/app/clinical/studies/actions/enable_migration_mode

Response

{
    "responseStatus": "SUCCESS",
    "responseMessage": "Success",
    "data": [
        {
            "url": "/api/v26.1/services/jobs/547532",
            "job_id": "547532"
        }
    ]
}

Response Details

On SUCCESS, the response includes the jobID, which you can use to retrieve the job status, and the url, which you can use to retrieve the current status of the job.

On FAILURE, the response returns the study_id of the record that resulted in the failure and an error message describing the reason for the failure. The entire request fails to process if you provide a Study record that does not exist in your Vault or is already in Study Migration Mode.