1. Home
2. Resources

Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the Swagger UI provided for this API.

name	path	methods	description
Annotations	/qoppapdf/v1/documents/{filePath}.pdf/annotations /qoppapdf/v1/documents/{filePath}.pdf/annotations/content /qoppapdf/v1/documents/{filePath}.pdf/annotations/redaction /qoppapdf/v1/documents/{filePath}.pdf/annotations/{name} /qoppapdf/v1/documents/{filePath}.pdf/annotations/{name}/attachment /qoppapdf/v1/documents/{filePath}.pdf/annotations/{name}/attachment/content	DELETE, GET, POST GET, POST POST DELETE, GET GET GET	This resource represents the annotations in the PDF document.
Attachments	/qoppapdf/v1/documents/{filePath}.pdf/attachments /qoppapdf/v1/documents/{filePath}.pdf/attachments/{attachmentName} /qoppapdf/v1/documents/{filePath}.pdf/attachments/{attachmentName}/content	GET, POST DELETE, GET GET	This resource represents a file attached to a PDFDocument.
Bookmarks	/qoppapdf/v1/documents/{filePath}.pdf/bookmarks	GET	This resource represents the Bookmarks in a PDF document.
ContentProvider	/qoppapdf/v1/contentprovider	GET	This resource represents the active content provider.
Document	/qoppapdf/v1/documents/{filePath}.pdf /qoppapdf/v1/documents/{filePath}.pdf/content	DELETE, GET, POST, PUT GET	This resource represents a PDF document.
DocumentInfo	/qoppapdf/v1/documents/{filePath}.pdf/doc-info /qoppapdf/v1/documents/{filePath}.pdf/doc-info/xmp	DELETE, GET, PUT DELETE, GET, PUT	This resource represents the document info in the PDF document including standard information and metadata.
Fields	/qoppapdf/v1/documents/{filePath}.pdf/fields /qoppapdf/v1/documents/{filePath}.pdf/fields/content	DELETE, GET, POST GET, POST	This resource represents all fields in a PDF document.
Folder	/qoppapdf/v1/documents/{folderPath}	DELETE, GET, POST, PUT	This resource represents a folder that can contain sub folders or documents.
OptimizeProfiles	/qoppapdf/v1/optimize-profiles /qoppapdf/v1/optimize-profiles/{profileName}	GET DELETE, GET, PUT	This resource represents the settings used when optimizing a Document.
PDFPermissions	/qoppapdf/v1/documents/{filePath}.pdf/permissions /qoppapdf/v1/documents/{filePath}.pdf/permissions/usage-rights	GET DELETE	This resource represents all Permissions in the PDF document including PasswordPermissions, Usage Rights, and DocMDP (Document modification detection and prevention) permissions.
Pages	/qoppapdf/v1/documents/{filePath}.pdf/pages /qoppapdf/v1/documents/{filePath}.pdf/pages/text /qoppapdf/v1/documents/{filePath}.pdf/pages/{pageIndex} /qoppapdf/v1/documents/{filePath}.pdf/pages/{pageIndex}/content /qoppapdf/v1/documents/{filePath}.pdf/pages/{pageIndex}/text	GET, POST GET DELETE, GET GET GET	This resource represents the collection of pages in the PDF document.
PasswordPermissions	/qoppapdf/v1/documents/{filePath}.pdf/permissions/password-permissions	DELETE, GET, PUT	This resource represents Password Permissions in a document.
PreflightResults	/qoppapdf/v1/documents/{filePath}.pdf/preflight /qoppapdf/v1/documents/{filePath}.pdf/preflight/content	GET GET	This resource represents the PDF/A or PDF/X verification results of a PDF document.
Session	/qoppapdf/v1/sessions /qoppapdf/v1/sessions/authorizer	DELETE, POST GET	This resource represents a session.
SignatureFields	/qoppapdf/v1/documents/{filePath}.pdf/fields/signature-fields /qoppapdf/v1/documents/{filePath}.pdf/fields/signature-fields/{fieldName} /qoppapdf/v1/documents/{filePath}.pdf/fields/signature-fields/{fieldName}/default-signature /qoppapdf/v1/documents/{filePath}.pdf/fields/signature-fields/{fieldName}/signature	DELETE, GET DELETE, GET, PUT POST POST	This resource represents all SignatureFields in the Document.