Task - ABBYY Documentation

The Task data type stores information about tasks. Besides records of this type, information about tasks is also stored in XML files. An XML file may describe the entire task or its separate files. For more information, see Exchange files with the Application Server.

Fields

Name	Type	Description
`Id`	`int`	The ID of the task.
`ProjectId`	`int`	The ID of the project to which the task belongs.
`BatchId`	`int`	The ID of the batch that includes the documents of the task.
`BatchTypeId`	`int`	The ID of the batch type. `0` corresponds to the `Default` batch type.
`Priority`	`int`	Task priority. For possible values, see Priority.
`Status`	`System.UInt32`	Task status. Possible values: `0` (being created), `1` (awaits processing), `2` (being processed), `3` (processing completed), `4` (postponed).
`CreationTime`	`long`	Time of creation, as a FILETIME value. To convert the value, use the conversion example after this table.
`ModificationTime`	`long`	The time when the task was last modified, as a FILETIME value. To convert the value, use the conversion example after this table.
`Comment`	`string`	Comment on the task.
`StageType`	`int`	The type of the processing stage at which the task was formed. For possible values, see ProcessingStageType.
`UserId`	`int`	The ID of the user or group to whom the task has been assigned.
`Flags`	`int`	A set of flags that describe the status of the task. The value combines the flags listed after this table.
`CreatorId`	`int`	The ID of the user that created the task.
`BatchName`	`string`	The name of the batch the task is associated with.
`StageExternalId`	`int`	The ID of the processing stage in which the task is created.

Convert CreationTime and ModificationTime between long and DateTime in C# as follows:

DateTime dTime;
long lTime;
...
// conversion from long to DateTime
dTime = DateTime.FromFileTime(lTime);
...
// conversion from DateTime to long
lTime = dTime.ToFileTime();

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
`TA_HasAttachedDataVerificationXml`	`0x200`	An XML file with pre-processing data has been generated for the task.
`TA_HasAttachedDocumentsXml`	`0x1000`	XML files with data have been generated for the task.