DocumentEx

DocumentEx data type in the ABBYY FlexiCapture Web Services API: extended document information including pages, processing status, errors, and priority.

The DocumentEx data type stores extended information about a document. It replaces the Document data type from the previous version of the Web Services API.

Fields

Name	Type	Description
Id	int	The ID of the document. Completed automatically by the Application Server.
Pages	Page[]	The set of pages in the document.
PageCount	int	The number of pages in the document.
IsProcessed	bool	A flag that shows whether the document has been processed. True if processed, False if not. Completed automatically by the Application Server.
HasProcessingErrors	bool	A flag that shows whether processing errors occurred. True if some processing errors occurred, False if there were none. Completed automatically by the Application Server.
HasDocumentErrors	bool	A flag that shows whether the document has errors, such as format, rule, or assembly errors. True if there are errors in the document, False if there are none. Completed automatically by the Application Server.
ErrorText	string	A description of the document processing errors. Completed automatically by the Application Server.
ExternalId	string	The external ID of the document. If left empty, the parameter is completed automatically by the Application Server and is the same as Id.
FileVersion	int	The version of the document file on the server. Completed automatically by the Application Server.
OwnerId	int	The ID of the user to whom the document is assigned.
Properties	RegistrationProperty[]	The set of registration parameters for the document.
PropertiesCount	int	The number of registration parameters for the document.
Priority	int	Document priority. For possible values, see ProcessingPriority.