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

GenerateRandomPackPreviewDataContract
NameDescriptionTypeAdditional information
EnvelopeTemplatePackId

integer

None.

BrandId

integer

None.

EventType

EnumDataContract

None.

Request Formats

application/json, text/json

Sample:
{
  "EnvelopeTemplatePackId": 1,
  "BrandId": 2,
  "EventType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  }
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Details of the job that has been invoked.

JobInvocationDetailsDataContract
NameDescriptionTypeAdditional 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": "42de7075-1015-491c-a310-2c05bb5d8700",
  "Success": true
}