Reclassify Document
PUT https://{{vaultDNS}}/api/{{version}}/objects/documents/:{doc_id}
https://developer.veevavault.com/api/23.1/#Reclassify_Document
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.
Request Body
[{"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"=>"reclassify", "value"=>"true", "datatype"=>"boolean"}, {"name"=>"document_number__v", "value"=>"", "datatype"=>"null"}, {"name"=>"status__v", "value"=>"", "datatype"=>"null"}]
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Authorization | string | ||
Content-Type | string | ||
Accept | string |