Information Classification: External Restricted.
See https://www.chili-publish.com/security
POST - resources/documents/{itemID}/representations/pdf
Generates a PDF of the document.
URI
resources/documents/{itemID}/representations/pdf |
HTTP Method
Post
Request parameters
Name |
Location |
Type |
Description |
---|---|---|---|
API-KEY |
http header |
The API key previously generated by calling the GenerateApiKey function |
|
itemID |
uri |
The ID of the document for which to create the PDF |
|
settingsXML |
body |
The PDF Export Settings XML used to generated the PDF. These settings can be either build manually, or requested from one of the available PDFExportSettings resource items |
|
taskPriority |
query |
int |
The priority (1-10) of the task |
HTTP Return Status
Created
Returns
This function is always run asynchronously. The taskXML contains a "result" attribute, which in its turn contains an XML string of the PDF generation result:
<result path="server_path" relativeURL="ZZZ" url="FULL_URL" />
relativeURL is provided from the root of the CHILI website.
The 'path' attribute contains the file path (on the server) to the PDF or zip file or directory where the output has been created.
An XML string describing the created task, containing its ID and other information.
All information on this page must be treated as External Restricted, or more strict. https://www.chili-publish.com/security