POST api/documentgeneration/createpdf

Creates a new pdf document. 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 create pdf data contract supplied with the request.

CreatePdfDataContract

Name	Description	Type	Additional information
Pages	The collection of pages.	Collection of string	None.
StyleBlocks	The collection of style blocks.	Collection of string	None.
CssFiles	The collection of css files.	Collection of string	None.
Width	The width value.	integer	None.
Height	The height value.	integer	None.
PageSize	The page size value.	string	None.
PageOrientation	The page orientation value.	string	None.
PdfName	The pdf name value.	string	None.
RoleId	The unique identifier of the related role resource.	integer	None.
BaseUrl	The base url value.	string	None.
RootPath	The root path value.	string	None.
PdfQuality	The pdf quality value.	string	None.
UseNew	Indicates whether use new is true.	boolean	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "Pages": [
    "sample string 1",
    "sample string 2"
  ],
  "StyleBlocks": [
    "sample string 1",
    "sample string 2"
  ],
  "CssFiles": [
    "sample string 1",
    "sample string 2"
  ],
  "Width": 1,
  "Height": 2,
  "PageSize": "sample string 3",
  "PageOrientation": "sample string 4",
  "PdfName": "sample string 5",
  "RoleId": 6,
  "BaseUrl": "sample string 7",
  "RootPath": "sample string 8",
  "PdfQuality": "sample string 9",
  "UseNew": true
}

Response Information

Resource Description

The response returned after the operation completes.

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": "13435658-fc5f-42cc-8b98-653aa3c5bb2d",
  "Success": true
}