JobDocument Object (Web Services API)

This object represents a document in a job.

Name Type Description
Attributes DocumentAttributes, read-only Stores document attributes.
BarcodeText String, read-only Returns the text of the separation barcode.
CustomText String, read-only Custom text assigned to the document during document separation or indexing. The text can be used for output file naming. You can include this text to the output file name using the <CustomText> tag.
Messages JobMessage[ ], read-only A list of errors, warnings, and information messages for this document.
OutputDocuments OutputDocument[ ], read-only

Returns a collection of output files of different formats belonging to the document.

Note. Output documents can also be located in the InputFile.OutputDocuments collection if:

  • an input document is copied to an output document without conversion
  • an Office document is converted to PDF at the preprocessing stage.
PagePositions PagePosition[ ], read-only Returns a collection of objects that store information about the page position within the input document.
Statistics Statistics, read-only Returns document processing statistics.
Name String, read-only Returns the name of the document.
IsFailed Boolean, read-only If an error occurred during processing, this property will be set to true.

26.03.2024 13:49:49

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.