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.

name path methods description
Annotations
  • /qoppapdf/v1/documents/{filePath}.pdf/annotations
  • /qoppapdf/v1/documents/{filePath}.pdf/annotations/annotations
  • /qoppapdf/v1/documents/{filePath}.pdf/annotations/content
  • GET POST
  • DELETE
  • GET
This resource represents the annotations in the PDF document.
Document
  • /qoppapdf/v1/documents/{filePath}.pdf
  • /qoppapdf/v1/documents/{filePath}.pdf/content
  • DELETE GET POST PUT
  • GET
This resource represents a PDF document.
Fields
  • /qoppapdf/v1/documents/{filePath}.pdf/fields
  • /qoppapdf/v1/documents/{filePath}.pdf/fields/content
  • DELETE GET POST
  • GET
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-results
  • GET
This resource represents the PDF/A verification results of a PDF document.
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}/signature
  • DELETE GET
  • DELETE GET PUT
  • POST
This resource represents all SignatureFields in the Document.

Data Types

JSON

type description
AnnotationModel An annotation in the PDF document.
AnnotationsModel All annotations in the PDF document.
ApplyRedactionsActionModel This action will apply or "burn in" all redaction annotations that are in this document. The page content that is contained within the redaction annotation's bounds will be redacted.
CopyActionModel This action is used to create a copy of a document.
DigitalIDModel A digital ID used to sign a signature field in the PDF document.
DocumentActionModel Document actions contain information that is used to copy and modify documents. DocumentActionModel is abstract and should not be used. Instead, use one of it's subclasses: FlattenAnnotationsActionModel, FlattenFieldsActionModel, OptimizeActionModel, CopyActionModel, and LinearizeActionModel.
DocumentModel A PDF document.
DocumentOverviewModel Information about a document.
FieldModel A field in the PDF document.
FieldsModel All fields in the PDF document.
FileModel A File (folder or normal file).
FlattenAnnotationsActionModel This action is used to flatten all annotations in the document.
FlattenFieldsActionModel This action is used to flatten all fields in the document.
FolderModel A folder.
ImageHandlerModel An image handler in the optimize settings that controls the output images.
ImageStampActionModel This action contains information to place an image stamp on one or more pages.
InsertAttachedPagesActionModel This action is used to insert or append a PDF or image file as a page/pages. An image (jpeg, tiff, gif, png) or pdf file must also be sent as part of the request.
InsertPagesActionModel Insert page actions are used to insert pages into the document. InsertPagesActionModel is abstract and should not be used. Instead, use one of it's subclasses: InsertAttachedPagesActionModel and InsertUploadedPagesActionModel.
InsertUploadedPagesActionModel This action is used to insert or append a PDF that is already uploaded.
LinearizeActionModel This action is used to linearize a document.
LinkModel A link to a resource.
NewPageActionModel This action is used to insert a new blank page.
OCRActionModel This action is used to perform OCR on one or more pages.
OptimizeActionModel This action is used to optimize the document with the specified profile.
OptimizeProfileModel A profile for optimizing. It includes a profile name and the associated Optimize Settings.
OptimizeProfilesModel All available optimization profiles.
PDFAConvertActionModel This action is used to convert the document to PDF/A.
PDFPermissionsModel All permissions in the PDF Document including password permissions, DocMDP permissions, and usage rights.
PageActionModel Page actions contain information that is used to modify pages. PageActionModel is abstract and should not be used. Instead, use one of it's subclasses: OCRActionModel, ImageStampActionModel, TextStampActionModel, InsertAttachedPagesActionModel, InsertUploadedPagesActionModel, and NewPageActionModel.
PageModel A page in the PDF document.
PagesModel All pages in the PDF Document.
PasswordPermissionsModel Permissions for operating on the PDF document.
PermissionsModel Permissions for operating on the PDF document.
PreflightInformationModel Information about the preflight process.
PreflightResultRecordModel This object holds information about an issue found in the document. The information includes a header or short name, a detail string and the page number where the issue happened.
PreflightResultsModel All preflight result records.
RectangleModel A component's boundaries within a page in a PDF document.
SignatureFieldModel A signature field in the PDF document.
SignatureFieldsModel All signature fields in the PDF document.
StampActionModel Stamp actions contain information used to add a stamp to a page in the document. They can be used to create watermarks, headers, and footers. StampActionModel is abstract and should not be used. Instead, use one of its subclasses: ImageStampActionModel and TextStampActionModel.
TextStampActionModel This action contains information to place a text stamp on one or more pages.
WebApplicationExceptionModel A web application exception.
WidgetModel A widget in the PDF Document.

XML

Default Namespace (schema)
type description
Annotation An annotation in the PDF document.
Annotations All annotations in the PDF document.
DigitalID A digital ID used to sign a signature field in the PDF document.
Document A PDF document.
DocumentOverview Information about a document.
Field A field in the PDF document.
Fields All fields in the PDF document.
File A File (folder or normal file).
Folder A folder.
ImageHandler An image handler in the optimize settings that controls the output images.
Link A link to a resource.
OptimizeProfile A profile for optimizing. It includes a profile name and the associated Optimize Settings.
OptimizeProfiles All available optimization profiles.
PDFPermissions All permissions in the PDF Document including password permissions, DocMDP permissions, and usage rights.
Page A page in the PDF document.
Pages All pages in the PDF Document.
PasswordPermissions Permissions for operating on the PDF document.
Permissions Permissions for operating on the PDF document.
PreflightInformation Information about the preflight process.
PreflightResultRecord This object holds information about an issue found in the document. The information includes a header or short name, a detail string and the page number where the issue happened.
PreflightResults All preflight result records.
Rectangle A component's boundaries within a page in a PDF document.
SignatureField A signature field in the PDF document.
SignatureFields All signature fields in the PDF document.
WebApplicationException A web application exception.
Widget A widget in the PDF Document.
ApplyRedactionsAction This action will apply or "burn in" all redaction annotations that are in this document. The page content that is contained within the redaction annotation's bounds will be redacted.
CopyAction This action is used to create a copy of a document.
documentActionModel Document actions contain information that is used to copy and modify documents. DocumentActionModel is abstract and should not be used. Instead, use one of it's subclasses: FlattenAnnotationsActionModel, FlattenFieldsActionModel, OptimizeActionModel, CopyActionModel, and LinearizeActionModel.
FlattenAnnotationsAction This action is used to flatten all annotations in the document.
FlattenFieldsAction This action is used to flatten all fields in the document.
ImageStampAction This action contains information to place an image stamp on one or more pages.
InsertAttachedPagesAction This action is used to insert or append a PDF or image file as a page/pages. An image (jpeg, tiff, gif, png) or pdf file must also be sent as part of the request.
insertPagesActionModel Insert page actions are used to insert pages into the document. InsertPagesActionModel is abstract and should not be used. Instead, use one of it's subclasses: InsertAttachedPagesActionModel and InsertUploadedPagesActionModel.
InsertUploadedPagesAction This action is used to insert or append a PDF that is already uploaded.
LinearizeAction This action is used to linearize a document.
NewPageAction This action is used to insert a new blank page.
OCRAction This action is used to perform OCR on one or more pages.
OptimizeAction This action is used to optimize the document with the specified profile.
PDFAConvertAction This action is used to convert the document to PDF/A.
pageActionModel Page actions contain information that is used to modify pages. PageActionModel is abstract and should not be used. Instead, use one of it's subclasses: OCRActionModel, ImageStampActionModel, TextStampActionModel, InsertAttachedPagesActionModel, InsertUploadedPagesActionModel, and NewPageActionModel.
stampActionModel Stamp actions contain information used to add a stamp to a page in the document. They can be used to create watermarks, headers, and footers. StampActionModel is abstract and should not be used. Instead, use one of its subclasses: ImageStampActionModel and TextStampActionModel.
TextStampAction This action contains information to place a text stamp on one or more pages.