Information Classification: External Restricted.
See https://www.chili-publish.com/security

Webservice Functions - DocumentCreatePDF

Generates a PDF of the document.

Declaration

public string DocumentCreatePDF ( string apiKey, string itemID, string settingsXML, int taskPriority );

Arguments

Name

Type

Description

apiKey

apiKey

The API key previously generated by calling the GenerateApiKey function

itemID

itemID

The ID of the document for which to create the PDF

settingsXML

xmlString

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

int

The priority (1-10) of the task, recommend priority setting for DocumentCreatePDF is 4

Returns

taskXML

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