DIDComposePackV1
DIDComposePackV1 creates a document pack from non-interactive Document Templates and Document Pack Templates. Returns the pack. The document pack is returned in the response and can also be retrieved using DIDComposePackGetV1. See DIDComposePackGetV1 for more information.
The request requires the following fields next to the standard fields.
| Field | Type | Description |
|---|---|---|
| project | repositoryobjectname | Name of the KCM Repository project. |
| templatetype | name | Either documentpacktemplate or documenttemplate. |
| templatename | repositoryobjectname | Name of the template to compose the document pack from. |
| importdocuments | base64Binary | Optional. A base-64 encoded XML structure binary representation of an import documents data structure. For more information on the format for this XML see "Format for the definitions". |
| keys | message | Optional. A semicolon separated list of keys. If a key should refer to the uploaded xmlfile, the special value *XMLFILE should be used. In this case the xmlfile parameter is required. Note that *XMLFILE is interpreted case-sensitively. |
| extras | message | Optional. An extra parameter is a single string that contains items separated by semilcolons and has a limitation of 1024 characters. This parameter is not meant to pass big amounts of data to a template, for this purpose, use the Data Backbone. |
| xmlfile | base64Binary | Optional. A base-64 encoded data xml file, which matches the DID on which the template is based. If a file is passed for the xmlfile parameter, the keys will be required to contain at least one occurrence of *XMLFILE. |
| status | name | Optional. The status of the template to use. The available statuses are Current, Accepted, or Published. If omitted, Published is used. |
If you want to supply a key or extra value with a semicolon, use a slash as an escape character.
Example:
-
Extra1;Extra2. These are two extra parameters separated by a semicolon: Extra1 and Extra2.
-
Extra1/;Extra2. This is only one extra parameter value: Extra1;Extra2.
For more information, see Kofax Communications Manager Template Scripting Language Guide.
Keys and Extras are only supported by the CCMCompatibility contract type. See the corresponding topic for more information on document pack template restrictions related to data retrieval.
The response contains the following fields in addition to the standard fields.
| Field | Type | Description |
|---|---|---|
| ccmsessionid | sessionid | KCM Contract Manager session identifier. |
| documentpack | base64Binary | A base-64 encoded binary representation of the document pack. |