Download OpenAPI specification:Download
Operation successful. The XDP obtained after converting the supplied PDF document is included in the response.
Bad Request. The Problem Details object will provide more information about the exact cause.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
Operation successful. The requested properties of the supplied PDF document are included in the response.
Bad Request. The Problem Details object will provide more information about the exact cause.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "properties": {
- "acrobatVersion": "Acrobat_10",
- "formType": "NotAForm",
- "hasAttachments": true,
- "hasComments": true,
- "isAccessible": true,
- "isAcroForm": true,
- "isFillableForm": true,
- "isLocked": true,
- "isPackage": true,
- "isPdf": true,
- "isShell": true,
- "isXfa": true,
- "version": true,
- "xfaVersion": true
}
}
required | HttpUrl (string) or InlineDocument (string) A PDF document to be checked for Adobe Acrobat Reader extensibility and if eligible, whose enabled usage rights are to be fetched. |
OpenPassword (string) or PermissionsPassword (string) (UnlockPassword) The password required for opening an encrypted PDF document. Typically, this is the document open password but if the PDF document is additionally protected by a permissions password, either may be used to open it. |
Operation successful. The usage rights enabled in the supplied PDF document are included in the response.
Bad Request. The Problem Details object will provide more information about the exact cause.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "message": "This PDF has usage rights enabled.",
- "invalidAfter": "2024-06-30T00:00:00.000Z",
- "invalidBefore": "2023-11-01T00:00:00.000Z",
- "usageRights": {
- "barcodeDecoding": true,
- "formFillIn": true,
- "submitStandalone": true
}
}
A multipart request representing a metadata export operation.
Operation successful. The requested metadata of the supplied PDF document is included in the response.
Bad Request. The Problem Details object will provide more information about the exact cause.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "author": "string",
- "title": "string",
- "subject": "string",
- "keywords": [
- "string"
], - "creator": "string",
- "producer": "string"
}
A multipart request representing a data export operation.
Operation successful.
The data exported from the supplied PDF form or XDP template is included in the response.
Bad Request. The Problem Details object will provide more information about the exact cause.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
A multipart request representing a metadata import operation.
Operation successful. The updated PDF document containing the supplied metadata is included in the response.
Bad Request. The Problem Details object will provide more information about the exact cause.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
Digital signature, usage rights and encryption-related operations with PDF documents.
Existing usage rights on the document are replaced with the provided usage rights. If no usage rights are provided, this effectively removes any existing usage rights from the document.
A multipart request representing usage rights application operation.
required | HttpUrl (string) or InlineDocument (string) A PDF document to be extended for Adobe Acrobat Reader by applying usage rights. Use content-type as "text/plain" to specify a URL. |
required | object (UsageRights) The set of usage rights representing capabilities applicable to a PDF document within Adobe Acrobat Reader. |
object (ApplyRightsOptions) Specifies options to control the usage rights application operation. |
Operation successful. The reader extended PDF document is included in the response.
Bad Request. The Problem Details object will provide more information about the exact cause.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}
A multipart request representing a PDF form generation operation.
required | HttpUrl (string) or InlineDocument (string) or (RepoDocument (RepoPath (string) or RepoUrl (string))) The template defines the appearance and behavior of the resultant PDF form. |
HttpUrl (string) or InlineDocument (string) An optional XML file containing the data to be merged with the template to generate a pre-filled PDF form. | |
object (PdfFormOptions) Options to govern PDF form generation and behavior. |
Operation successful.
The generated PDF form is included in the response.
The request is accepted and the location specified in the header
may be polled for information about the result.
Bad Request. The Problem Details object will provide more information about the exact cause.
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "state": "PROCESSING",
- "operation": "string",
- "status": "string",
- "errors": [ ],
}
Information about the processing state of an asynchronous request.
See Other. Indicates that the server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field.
Bad Request. The Problem Details object will provide more information about the exact cause.
Not Found
The server encountered an unexpected error. Retrying the request after a certain time could help.
The service is temporarily unavailable. Please try again later.
{- "state": "PROCESSING",
- "operation": "string",
- "status": "string",
- "errors": [ ],
}
Operation successful.
The generated PDF form is included in the response.
Bad Request. The Problem Details object will provide more information about the exact cause.
Not Found
The server encountered an unexpected error. Retrying the request after a certain time could help.
{- "title": "Bad Request",
- "status": 400,
- "detail": "Bad request, please check that you have provided the correct parameters and that they are valid."
}