The save assembly session API method enables you to save the current state of an in-progress assembly session.
In this Topic Hide
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:
Additionally, you must have the following items:
A work item with an in-progress assembly session (see Beginning an Assembly Session)
Note: 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.
See Authentication for more information about authenticating requests to the Advance API.
You can view the latest reference documentation for the Advance API at https://server.yourorganization.com/HdaApi/rest/documentation/index.html, where server.yourorganization.com is the location of your Advance deployment.
PUT https://{tenancymoniker}.{domain}/HdaApi/rest/v1.1/WorkItems/{id}/Versions/Active/SaveSession
| 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] |
| 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, server.yourorganization.com. |
| id | Guid | URL |
Yes | The Guid for an existing work item. |
https://tenancy1.server.yourorganization.com/HdaApi/rest/v1.1/WorkItems/2d9f3d10-6fdb-494f-9929-955515c6f114/Versions/Active/SaveSession
{}
Status: 200 OK
Once you save the assembly session, you can resume the session by making a request to the begin assembly session endpoint, using same versionId as you used to begin the initial assembly session.
See Beginning an assembly session: resuming an assembly session for more information.