Document

The Document object contains information about the requested document based on the document identifier.

Parameter Type Description
DocumentIDstringA unique identifier associated with a document.
StoredDocIDstringA reference to the unique identifier (DocID) associated with a document.
OrganizationIDstringA unique identifier for the root organization associated with the document.
InstanceIDstringA unique identifier associate with the document instance.
InstanceBarcodeValuestringThe barcode value associated with the instance of the document.
PageCountExpereIntegerThe number of paginated documents (not including documents that are not paginated).
DisplayNamestringThe document display name associated with the document. This is authored as part of REQ authoring (Document > Properties).
InstanceFileNamestringThe document display name associated with the document instance. This is authored as part of REQ authoring (Document > Properties).
TypeDocumentTypeObject defining the format type for a document type (based on an enumerated value).
FragmentedNamestringThe document name when used as a fragment.
AutoselectedExpereBooleanA boolean defining if the document is marked for autoselection. A TRUE value indicates the document is autoselected; a FALSE value indicates it is not autoselected.
PrepareExpereBooleanA boolean defining if the document is a prepared document. A TRUE value indicates the document is prepared; a FALSE value indicates it is not prepared.
SuggestedExpereBooleanA boolean defining if the document is a suggested document. A TRUE value indicates the document is suggested; a FALSE value indicates it is not suggested.
FormatDocumentFormatTypeThe format of the document.
CopyExpereIntegerThe number of copies of the document associated with the instance.
AncillaryOutputOptionsArrayOfAncillaryOutputOptionArray containing an unbound collection of AncillaryOutputOption objects.
DataDataContainer object for transaction data inputs and outputs in binary (base64), text, or XML format. It will include all documents in the current packet.
PackageID string A string of data representing the PackageID
DDRData true Indicates if there is any DDR data associated with the document.