ComposeDocxInteractiveStartV1
The ComposeDocxInteractiveStartV1 call starts an interactive run that composes a DOCX document from a Document Template or a Letter Book.
The request requires the following fields next to the standard fields.
| Field | Type | Description |
| project | repositoryobjectname | The Designer project that contains the Document Template or the Letter Book that you want to start an interactive run for. |
| documenttemplate | repositoryobjectname | Optional. If specified, the Document Template that you want to start an interactive run for. Either a documenttemplate or letterbook must be specified, but not both. |
| lettterbook | repositoryobjectname | Optional. If specified, the Letter Book that you want to start an interactive run for. Either a documenttemplate or letterbook must be specified, but not both. |
| status | message | Optional. The status of the Document Template that you want to use. The available statuses are Current, Accepted, or Published. If omitted, Published is used. |
| previewformat | message | Optional. If specified, the format of the document previews that you want to have during the interactive run. This can be either PDF or HTML. HTML conversions proceed through the MakeHTMLDocument.dss Core scripting exit point. This exit point makes uses of the .msxsl transformation tool. Make sure that this tool is installed on the system and that it is in the binary search path. |
| databackbonexml | base64Binary | The Data Backbone XML for the Document Template. This must be the contents of a Data Backbone XML file, base-64 encoded. |
The response contains the following fields in addition to the standard fields.
| Field | Type | Description |
| itpcloudid | sessionId | An identifier for the interactive run. |
| url | url |
A URL that is relative to the base URL of Kofax Communications Manager. Example: https://<kcm server>:443/ccm/ All relative URLs that are returned are relative to this base URL. This URL refers to JSON data that serves as input to your interactive KCM ComposerUI web application. |
In case of an error, the response contains a SOAP Fault structure.