ComposeDocumentPackFromSnapshotInteractiveStartV1

ComposeDocumentPackFromSnapshotInteractiveStartV1 creates a Document Pack from a specified snapshot. The call results in a session ID and (partial) URL that can be used to start the interaction in Communications Manager ComposerUI. After the interaction has been completed, you can retrieve the resulting document pack using ComposeDocumentPackGetV1 (see ComposeDocumentPackGetV1).

This call works only if the Contract Manager and the Instance are installed on the same machine.

For more information about scaling out, refer to the Scaling out composition topic in Tungsten Communications Manager Installation Guide.

The request requires the following fields next to the standard fields.

Field Type Description
project repositoryobjectname Name of the Communications Manager Repository project that the snapshot belongs to.
snapshot The snapshot: either active or named.
snapshotname The name of the named snapshot if snapshot=named.

If snapshot=active, the active snapshot for the project is used, and the snapshotname parameter should not be passed.

The response contains the following fields in addition to the standard fields.

Field Type Description
ccmsessionid sessionid Communications Manager Contract Manager session identifier.
requesthandlerid requesthandlerid Request handler identifier. Identifies the Contract Manager that handles this request. You can configure this identifier in the StartContractManager.exe tool.
url url

A URL that is relative to the base URL of Tungsten Communications Manager. Example: https://<communications manager server>:443/ccm/

All relative URL's that are returned are relative to this base URL.

With this URL, the interactive session can be started.