POST api/documentgeneration/previewpack

Generates a pack using the first selected group/property of a type to get a quick preview of the pack Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

None.

Body Parameters

The generate random pack preview data contract supplied with the request.

GenerateRandomPackPreviewDataContract

Name	Description	Type	Additional information
EnvelopeTemplatePackId	The unique identifier of the related envelope template pack resource.	integer	None.
BrandId	The unique identifier of the related brand resource.	integer	None.
EventType	The event type value.	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.

JobInvocationDetailsDataContract

Name	Description	Type	Additional information
SupportsCancellation	Indicates whether supports cancellation is true.	boolean	None.
ReportsProgress	Indicates whether reports progress is true.	boolean	None.
InitialStatusText	The initial status text value.	string	None.
JobReference	The job reference globally unique identifier.	globally unique identifier	None.
Success	Indicates whether success is true.	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "64605987-c285-4f4d-b780-eb8b55096b31",
  "Success": true
}