What it does
The Document data type stores information about a document.
The ID of a document.
The only way to set an ID for a document is to use the GetBatchIdsRange method, which allows reserving IDs for new documents. We recommend that you set an ID for a document before you add the document to a batch.
A document ID will be generated automatically if you set its value to -1.
|BatchId||int||The ID of the batch|
The ID of the parent document of the set.
If a new document should be part of a set, this field should be assigned the value of the parent document of the set.
If a new document should not be part of any set, set the value of the field to 0.
Important! The parent document must be created before child documents are created.
A set of child documents enabling the sorting of documents in the set.
When data are read from the server, the field is filled out automatically.
If this field is empty, the documents in the set will be arranged in the order in which they were added.
|TemplateName||string||The name of the Document Definition|
|ProcessingStageType||int||The type of the processing stage; values come from ProcessingStageType|
|Pages||Page||The set of pages in the document|
|IsProcessed||bool||A flag that shows whether the document has been processed or not|
|HasProcessingErrors||bool||A flag that shows whether there were processing errors|
|HasDocumentErrors||bool||A flag that shows whether there are errors in the document (e.g. format errors, rules 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|
|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|
A set of flags that describe the status of the document. The value of a field is a combination of the values of the flags, which include:
Note: Only those flags are listed which are useful when working with the tasks and methods of the Web Services API.