PreflightResults Resource

This resource represents the PDF/A or PDF/X verification results of a PDF document.

GET /qoppapdf/v1/documents/{filePath}.pdf/preflight

Get the preflight results for PDF/A or PDF/X verification. The verification type must be specified. Valid values are: pdfa1b, pdfa2b, pdfa3b, pdfa1a, pdfa2u, pdfua, pdfa3u, pdfa3bzugferd, pdfx1a2001, pdfx1a2003, pdfx32002, pdfx32003

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
filePath path Path to the file to operate on. n/a
profile query The PDF/A or PDF/X verification type. Valid values are: pdfa1b, pdfa2b, pdfa3b, pdfa1a, pdfa2u, pdfua, pdfa3u, pdfa3bzugferd, pdfx1a2001, pdfx1a2003, pdfx32002, pdfx32003.
Response Body
media type data type description
application/json PreflightResultsModel (JSON)
application/xml PreflightResults (XML)

GET /qoppapdf/v1/documents/{filePath}.pdf/preflight/content

Download the preflight results for PDF/A or PDF/X verification as a PDF Report. By default the document will be returned in the body of the response but can also be downloaded as an attachment. The verification type must be specified. Valid values are: pdfa1b, pdfa2b, pdfa3b, pdfa1a, pdfa2u, pdfua, pdfa3u, pdfa3bzugferd, pdfx1a2001, pdfx1a2003, pdfx32002, pdfx32003

Sample Request

GET http://{host}:{port}/qoppapdf/v1/documents/mydir/mydoc.pdf/preflight/content?profile=pdfa1b

Request Parameters
name type description default
QSESSIONID cookie The session id n/a
X-Qoppa-DocumentPassword header The document's password. n/a
filePath path Path to the file to operate on. n/a
attachment query Set to true to download the file as an attachment. false
profile query The PDF/A or PDF/X verification type. Valid values are: pdfa1b, pdfa2b, pdfa3b, pdfa1a, pdfa2u, pdfua, pdfa3u, pdfa3bzugferd, pdfx1a2001, pdfx1a2003, pdfx32002, pdfx32003.
Response Body
media type data type description
application/pdf (custom) The preflight results as a PDF Report.