CompareActionModel Data Type

This action is used for generating a comparison PDF document with separate layers containing the PDF content converted to color.

Properties
name data type description
compareFilePath string The path to the document to overlay and compare the current document with. The path is to an already uploaded document including parent directories.
comparePassword string The password associated with the document to overlay and compare the current document with.
currentOptions CompareOptionsModel The compare options to use for the current document.
compareOptions CompareOptionsModel The compare options to use for the comparison document.
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

{
  "compareFilePath" : "...",
  "comparePassword" : "...",
  "currentOptions" : {
    "layerName" : "...",
    "color" : "...",
    "scaleX" : 12345.0,
    "scaleY" : 12345.0,
    "x" : 12345.0,
    "y" : 12345.0,
    "rotation" : 12345.0
  },
  "compareOptions" : {
    "layerName" : "...",
    "color" : "...",
    "scaleX" : 12345.0,
    "scaleY" : 12345.0,
    "x" : 12345.0,
    "y" : 12345.0,
    "rotation" : 12345.0
  },
  "savePath" : "...",
  "namingMode" : 12345
}