The Jobs API provides the ability to render PDF documents offline. Rendering documents via jobs is the recommended approach when a large number of documents need to be rendered in a single request.
Compared to the Generate Documents API (which requires the request connection remain open throughout the render process), a call to the Create job API will return immediately and (if a notify URL is provided) will send a notification once the job is complete. Completed jobs will store their results for 8 hours after which the job will expire and its results deleted.
Jobs can also be periodically queried for their status if needed. If it is not possible to supply a notify URL, periodically querying the status of a job can be used to determine when (or if) a job has completed successfully in order to retrieve its results.
An optional URL parameter that the render system will attempt to post a request to once the job is complete.
The endpoint for this URL must accept JSON POST requests. The body of the request will contain a JobStatus object identical to what is returned by the GetStatus API.
A Boolean indicating whether or not the request was successful.
Message
String
A message containing error information if the request was unsuccessful.
Data
Guid
A Guid value holding the Id for the job. This value can be used later on to request the status of the job or to retrieve the results of the job once completed.
Note: This value will only be populated if the job was created successfully.
The job has been successfully created and is waiting in the render queue.
IN_PROGRESS
Rendering of the documents for this job is currently in progress.
COMPLETED
Rendering of the documents for this job has been completed and its results are ready to be retrieved.
COMPLETED_WITH_ERRORS
Rendering of the documents has been completed, but some documents were not able to render successfully. Partial results can be retrieved. See the Message property on the JobStatus object for more information about the failure.
FAILED
Rendering of the documents has failed and no results are available. See the Message property on the JobStatus object for more information about the failure.
EXPIRED
The job has been marked as expired and is queued for deletion. All jobs are marked as expired 8 hours after they have been completed.
Retrieves the rendered PDF data for a job that has been completed successfully. Only jobs with the status of COMPLETED or COMPLETED_WITH_ERRORS will have results that can be retrieved. Attempting to retrieve the results for jobs in any other state will result in a 404 response.
