Saving an In-progress Assembly Session
The save assembly session API method enables you to save the current state of an in-progress assembly session.
Prerequisites
Before making a 'save assembly session' request, 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 an in-progress assembly session (see Beginning an Assembly Session)
Overview
Implementing the save assembly session feature is usually only required when you are displaying an interview to your end users.
The 'save assembly session' API method is a command method. The API client invoking this method must have either a command or a root scope.
This method is useful when you want to enable a user to save the current state of their interview, so they can return to it at a later time.
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
PUT https://{tenancymoniker}.{domain}/HdaApi/rest/v1.1/WorkItems/{id}/Versions/Active/SaveSession
PUT https://{tenancymoniker}.hotdocsadvance.com/api/rest/v1.1/WorkItems/{id}/Versions/Active/SaveSession
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/Versions/Active/SaveSession
https://yourtenancy.hotdocsadvance.com/api/rest/v1.1/WorkItems/2d9f3d10-6fdb-494f-9929-955515c6f114/Versions/Active/SaveSession
Example Request JSON
{}
Example Response
Status: 200 OK
Next steps