Add EDL Matched Documents

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.

POST/api/{version}/objects/edl_matched_documents/batch/actions/add

Headers

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

Body Parameters

Expressed as JSON or CSV.

Name	Description
`id` required	The EDL Item `id` to match to documents. EDL Item records and their parent records must have a `status__v` of `active__v`.
`document_id` required	The document `id` to match to an EDL Item.
`major_version_number__v` optional	The major version number of a document. You must also include `minor_version_number__v` to use this parameter.
`minor_version_number__v` optional	The minor version number of a document. You must also include `major_version_number__v` to use this parameter.
`lock` optional	If set to `true`, locks the EDL Item to match a specific steady state document version or, if version numbers are omitted, the latest steady state document version. If set to `false` or omitted, and version numbers are omitted, Vault matches the latest version of the document without regard to state.

Request

curl -L -X POST -H 'Authorization: {SESSION_ID}' \
-H 'Content-Type: application/json' \
--data-raw '[
   {
       "id": "0EI000000003001",
       "document_id": "21",
       "major_version_number__v": 1,
       "minor_version_number__v": 0,
       "lock": true
   }
]'
'https://myvault.veevavault.com/api/v24.1/objects/edl_matched_documents/batch/actions/add' \

Response

{
   "responseStatus": "SUCCESS",
   "data": [
       {
           "responseStatus": "SUCCESS",
           "id": "0EI000000003001",
           "document_id": "21",
           "major_version_number__v": "1",
           "minor_version_number__v": "0",
           "lock": "true"
       }
   ]
}

Response Details

On SUCCESS, the response includes a SUCCESS or FAILURE status and any applicable error messages for each EDL Item to document match in the body of your request.