Question:

How to download Extensible Controlled Copy from Vault QualityDocs using the API?

Answer:

QualityDocs users often require a way to track specific content copies outside of Vault, or prepare copies with specific overlays for specialized use. Through the Extensible Controlled Copy feature, QualityDocs vaults provide special objects and fields to assist with this business process, supporting download and distribution of controlled copies.

To Download Extensible Controlled Copy using the API, see the following steps:

1. Retrieve all user actions on the document.
   /api/{version}/objects/documents/{id}/versions/{major_version}/{minor_version}/lifecycle_actions
   
   
2. Initiate the Controlled Copy user action.
   /api/{version}/objects/documents/{id}/versions/{major_version}/{minor_version}/lifecycle_actions/{name__v}
   
   Note that this API requires the name(name__v) of the Controlled Copy user action which can be found in the first API response. 
   
   ​
   
   
3. Retrieve the Job details.
   /api/{version}/services/jobs/{job_id}
   
   Note that the API requires the job_id which can be found in the second API response.
   
   
4. In the third API response, the user is able to find the href URL of the artifacts in the result. The URL format should be the same as the following.
   /api/{version}/objects/documents/actions/{lifecycle.state.action}/{job_id}/results
   
   Copy this URL and use it to call the API to download the controlled copy.

Related Documentation:

Vault Help Documentation: Download Controlled Copy Job Results