POST api/documentgeneration/previewpack
Generates a pack using the first selected group/property of a type to get a quick preview of the pack
Request Information
URI Parameters
None.
Body Parameters
Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Commands.GenerateRandomPackPreviewDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| EnvelopeTemplatePackId | integer |
None. |
|
| BrandId | integer |
None. |
|
| EventType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"EnvelopeTemplatePackId": 1,
"BrandId": 2,
"EventType": {
"Id": 1,
"Name": "sample string 2",
"SystemName": "sample string 3"
}
}
Response Information
Resource Description
Details of the job that has been invoked.
Dezrez.Core.DataContracts.External.Api.Job.Query.Get.JobInvocationDetailsDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| SupportsCancellation | boolean |
None. |
|
| ReportsProgress | boolean |
None. |
|
| InitialStatusText | string |
None. |
|
| JobReference | globally unique identifier |
None. |
|
| Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"SupportsCancellation": true,
"ReportsProgress": true,
"InitialStatusText": "sample string 3",
"JobReference": "8a23736d-c6e7-4679-90b4-1ce9090f91e0",
"Success": true
}