Create Single Document

POST https://{{vaultDNS}}/api/{{version}}/objects/documents

https://developer.veevavault.com/api/24.2/#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.

Request Body

[{"name"=>"file", "value"=>nil, "datatype"=>"null"}, {"name"=>"name__v", "value"=>"", "datatype"=>"null"}, {"name"=>"type__v", "value"=>"", "datatype"=>"null"}, {"name"=>"subtype__v", "value"=>"", "datatype"=>"null"}, {"name"=>"classification__v", "value"=>"", "datatype"=>"null"}, {"name"=>"lifecycle__v", "value"=>"", "datatype"=>"null"}, {"name"=>"major_version_number__v", "value"=>"", "datatype"=>"null"}, {"name"=>"minor_version_number__v", "value"=>"", "datatype"=>"null"}, {"name"=>"fromTemplate", "value"=>"", "datatype"=>"null"}, {"name"=>"source_vault_id__v", "value"=>"", "datatype"=>"null"}, {"name"=>"source_document_id__v", "value"=>"", "datatype"=>"null"}, {"name"=>"source_binding_rule__v", "value"=>"", "datatype"=>"null"}, {"name"=>"bound_source_major_version__v", "value"=>"", "datatype"=>"null"}, {"name"=>"bound_source_minor_version__v", "value"=>"", "datatype"=>"null"}]

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Acceptstring
X-VaultAPI-MigrationModebooleanWhen set to true, you can use the status__v field to create documents in any lifecycle state. Additionally, you can manually set the name, document number, and version number. Vault also bypasses entry criteria, entry actions, and event actions. You must have the Document Migration permission to use this header. Learn more about <a href="https://platform.veevavault.help/en/gr/54028&quot;&gt;Document Migration Mode in Vault Help.</a>