Document - ABBYY Documentation

The Document data type stores information about a document.

Fields

Name	Type	Description
`Id`	`int`	The ID of a document. The only way to set an ID for a document is to use the GetBatchIdsRange method, which reserves IDs for new documents. Set an ID for a document before you add the document to a batch. A document ID is generated automatically if you set its value to `-1`.
`BatchId`	`int`	The ID of the batch.
`ParentId`	`int`	The ID of the parent document of the set. If a new document is part of a set, assign this field the ID of the parent document of the set. If a new document is not part of any set, set the value of the field to `0`. Create the parent document before you create child documents.
`ChildrenOrder`	ChildrenOrder[]	A set of child documents that enables sorting of documents in the set. When data is read from the server, the field is filled out automatically. If this field is empty, the documents in the set are arranged in the order in which they were added.
`DocIndex`	`int`	Document index.
`TemplateName`	`string`	The name of the Document Definition.
`ProcessingStageType`	`int`	The type of the processing stage. For possible values, see ProcessingStageType.
`Comment`	`string`	Comment on the document.
`Pages`	Page[]	The set of pages in the document.
`IsProcessed`	`bool`	A flag that shows whether the document has been processed.
`HasProcessingErrors`	`bool`	A flag that shows whether there were processing errors.
`HasDocumentErrors`	`bool`	A flag that shows whether there are errors in the document (for example, format errors, rule errors, assembly errors).
`ErrorText`	`string`	A description of the document processing errors.
`ExternalId`	`string`	The external ID of the document.
`Properties`	RegistrationProperty[]	The set of registration parameters for the document.
`Priority`	Priority[]	Document priority.
`FileVersion`	`int`	The version of the document file on the server.
`OwnerId`	`int`	The ID of the user or group who owns the project.
`StageExternalId`	`int`	The ID of the processing stage in which the task was created (unique within the batch type).
`TaskId`	`int`	The ID of the task the document belongs to.
`UncertainSymbols`	`int`	The number of uncertain characters.
`VerificationSymbols`	`int`	The number of verified characters.
`TotalSymbols`	`int`	The total number of characters in the document.
`HasErrors`	`bool`	A flag that shows whether there are any validation rule errors.
`HasWarnings`	`bool`	A flag that shows whether there are any validation rule warnings.
`HasAssemblingErrors`	`bool`	A flag that shows whether there were assembling errors.
`HasAttachments`	`bool`	A flag that shows whether the document has attachments.
`Flags`	`int`	A set of flags that describe the status of the document. The value combines the flags listed after this table.

Flags field values

The Flags value is a combination of the following flags. Only the flags useful when working with tasks and the Web Services API methods are listed.

Flag	Value	Meaning
`BIF_IsAnalyzed`	`0x100`	The document is analyzed.
`BIF_IsRecognized`	`0x200`	The document is recognized.
`BIF_IsVerified`	`0x400`	The document is verified.
`BIF_IsExported`	`0x800`	The document is exported.
`BIF_HasRuleErrors`	`0x10000`	The document contains rule execution errors.
`BIF_HasRuleWarnings`	`0x20000`	The document contains rule execution warnings.
`BIF_HasMergeVersionErrors`	`0x80000`	The document contains errors from merging double verification results (verification results do not match).
`BIF_HasUserAttachments`	`0x100000`	The document has attachments.
`BIF_HasUnmatchedFieldErrors`	`0x200000`	The document contains unmatched fields.
`BIF_NeedsPreprocessing`	`0x800000`	The document needs preprocessing.
`BIF_IsManuallyCreated`	`0x1000000`	The document was created manually.
`BIF_IsExcludedFromAutomaticAssembling`	`0x2000000`	The document is excluded from automatic assembly.
`BIF_IsSourceImageAttached`	`0x4000000`	A source image file is attached to the document.