Downloading Assembled Documents
Once you have a completed assembly session, you can download the documents assembled. This action is typically performed at the request of the end user who has just finished the interview.
Prerequisites
Before making a request to download the documents, you must have an access token to sign the request. You can retrieve an access token using one of the following flows:
- Getting an access token using the Resource Owner flow
- Getting an access token using the Hybrid flow
- Getting an access token using the Implicit flow
Additionally, you must have the following items:
-
A work item with a completed assembly session (see Completing an Assembly Session)
Overview
The 'download assembled documents' API method is a query method. The API client invoking this method must have a query scope.
The downloading assembled documents method requires two API requests:
- Get a list of work item documents
- Download the document(s)
Authentication
See Authentication for more information about authenticating requests to the Advance API.
API Documentation
You can view the latest reference documentation for the Advance API at https://yourorganization.com/HdaApi/rest/documentation/index.html, where yourorganization.com is the domain under which your Advance deployment is located.
You can view the latest documentation for the Advance API at http://hotdocsadvance.com/api/rest/documentation/index.html
Request
Request URL
GET https://{tenancymoniker}.{domain}/HdaApi/rest/v1.1/WorkItems/{id}/Documents
GET https://{tenancymoniker}.hotdocsadvance.com/api/rest/v1.1/WorkItems/{id}/Documents
And
GET https://{tenancymoniker}.{domain}/HdaApi/rest/v1.1/WorkItems/{id}/Documents/{documentId}/Content
GET https://{tenancymoniker}.hotdocsadvance.com/api/rest/v1.1/WorkItems/{id}/Documents/{documentId}/Content
Headers
| Key | Required | Description | Example value |
| Authorization | Yes | The Authorization header for the request. Uses the access token retrieved (see Prerequisites section above for more information). | Bearer [access token] |
Parameters
| Name | Type | Location | Required | Description |
| tenancymoniker | String |
URL |
Yes | The tenancy moniker for the tenancy in which you want to create the new work item. |
| domain | String |
URL |
Yes | Your domain. For example, yourorganization.com. |
| id | Guid |
URL |
Yes | The Guid for an existing work item. |
Examples
Example Request URL
https://yourtenancy.yourorganization.com/HdaApi/rest/v1.1/WorkItems/2d9f3d10-6fdb-494f-9929-955515c6f114/Documents
https://yourtenancy.hotdocsadvance.com/api/rest/v1.1/WorkItems/2d9f3d10-6fdb-494f-9929-955515c6f114/Documents
https://yourtenancy.yourorganization.com/HdaApi/rest/v1.1/WorkItems/2d9f3d10-6fdb-494f-9929-955515c6f114/Documents/11cd9164-758b-4880-9442-a512c8e62fcd/Content
https://yourtenancy.hotdocsadvance.com/api/rest/v1.1/WorkItems/2d9f3d10-6fdb-494f-9929-955515c6f114/Documents/11cd9164-758b-4880-9442-a512c8e62fcd/Content
Example Request JSON
{}
Example Response
Status: 200 OK