ApiCodytTask
A Codyt task is linked to a revision set and to a specific language version.
FORMAT
<ArrayOfApiCodytTask xmlns="http://schemas.datacontract.org/2004/07/Wordbee.Database">
<ApiCodytTask>
<ProjectId>2147483647</ProjectId>
<RevisionSetTaskId>2147483647</RevisionSetTaskId>
<BeeDocumentId>2147483647</BeeDocumentId>
<DocumentName>String content</DocumentName>
<Status_>255</Status_>
<TaskCode>String content</TaskCode>
<LocaleSource>String content</LocaleSource>
<LocaleTarget>String content</LocaleTarget>
<Reference>String content</Reference>
<AllocMode_>255</AllocMode_>
<AllocCompanyId>2147483647</AllocCompanyId>
<AllocPersonId>2147483647</AllocPersonId>
<CreationDate>1999-05-31T11:20:00</CreationDate>
<Deadline>1999-05-31T11:20:00</Deadline>
<CostExVAT>12678967.543233</CostExVAT>
<CostCurrency>String content</CostCurrency>
<CostSegmentsCounted>2147483647</CostSegmentsCounted>
<RevisionSetId>2147483647</RevisionSetId>
<IsCurrent>true</IsCurrent>
</ApiCodytTask>
PROPERTIES
ProjectId | The unique project id |
RevisionSetId | Identifies a specific version of a source document and all its translations. |
BeeDocumentId | Points to the source document of the revision set. |
DocumentName | The unique name/id of the revision set which is identical to the unique name of the source document |
Status | The task's status which is a numeric value of: /// <summary> /// Work in the active step did not yet start, i.e. the worker did not yet open the work /// </summary> NotAssigned = 0, /// <summary> /// Work in the active step did not yet start, i.e. the worker did not yet open the work /// </summary> NotStarted = 1, /// <summary> /// The step is in progress. /// </summary> InProgress = 2, /// <summary> /// The step is completed. /// </summary> Completed = 3, /// <summary> /// The task is not yet active because another step in the workflow is not yet ready /// </summary> Inactive = 10, /// <summary> /// The step is cancelled. /// </summary> Cancelled = 20, |
TaskCode | Can be TR (Translation), RV (Revision) or APP (Approval/Proofreading) |
LocaleSource LocaleTarget | The languages of the task. |
Reference | The task reference |
AllocMode_ | The type of allocation: /// <summary> /// A single user must be allocated to a work item task (translation, revision and approval). /// The user who allocates must have proper rights for it. /// </summary> SingleUser = 0, /// <summary> /// Any user can pick up a work item and put his name on it to reserve exclusive work. /// The user can remove his name if he wants to release item for other people. /// </summary> SingleUserSelfService = 1, /// <summary> /// Multiple users can work at the same time. The work item is then simply not allocated to /// a specific person. /// </summary> MultiUser = 2 |
AllocCompanyId | Empty if not allocated. If set, then this task is allocated to this company. |
AllocPersonId | When a task is allocated inhouse, this field contains the inhouse person's ID. |
CreationDate | Date when the task was created in the system. |
Deadline | Optional task deadline |
CostExVAT | Cost of supplier |
CostCurrency | ISO currency code for cost value |
CostSegmentsCounted | Empty if all document segments are covered by the costs. Otherwise contains the number of segments taken into account for cost calculation. Purpose is to calculate costs for partially completed tasks (e.g. when a task is interrupted because a new document version is added). |
IsCurrent | Indicates whether the task refers to the current revision set or an old one. |