PDFAConvertActionModel Data Type

This action is used to convert the document to PDF/A.

Properties
name data type description
profile string The PDF/A conversion type. Valid values are: pdfa1b, pdfa2b, pdfa3b, pdfa2u, pdfa3u.
unsupportedAnnots number The behavior when unsupported annotations are encountered. Valid values are: 0 - delete, 1 - fail. The default value is 0.
transparency number The behavior when transparency is encountered. Valid values are: 1 - fail, 2 - make opaque. The default value is 2.
embeddedFiles number The behavior when embedded files are encountered. Valid values are: 0 - delete, 1 - fail. The default value is 0.
addAnnots boolean On failure, adds the result records as annotations to the document that was preflighted. The default value is false.
appendReport boolean On failure, appends the preflight report to the document that was preflighted. The default value is false.
Properties inherited from DocumentActionModel
savePath string Path to save the modified document. If not provided, the original document will be overwritten.
namingMode number The behavior when saving the modified document to a new path that already exists. Valid values are: 0-Throw a bad request exception, 1-Overwrite the existing file, 2-Append a random number to the file name.

Example

{
  "profile" : "...",
  "unsupportedAnnots" : 12345,
  "transparency" : 12345,
  "embeddedFiles" : 12345,
  "addAnnots" : true,
  "appendReport" : true,
  "savePath" : "...",
  "namingMode" : 12345
}