...
Field | Description | Format | Required | Field Type | Notes |
---|---|---|---|---|---|
name | The name of the task. | string | true | default | |
status | The status of the task. | string | true | default | This is limited to "Not Started", "In ProgressIncomplete" or "Complete". |
priority | The priority of the task. | string | false | default | This is limited to "Low", "Normal" or "High". |
dueTimestamp | When the task is due. | timestamp | true | default | The due date may be determined in a variety of ways. If the resource hasTriggerDate === true then the dueTimestamp is based on a custom data field in the associated Action resource. Otherwise the dueTimestamp may be set by conditions in its template resource and manually adjusted. |
startedTimestamp | When the task was started. | timestamp | false | default | The startTimestamp coincides with the status being changed to "In ProgressIncomplete". |
completedTimestamp | When the task is completed. | timestamp | false | default | The completedTimestamp coincides with the status being change to "CompletedComplete". |
lastModifiedTimestamp | Where the task is last modified. | timestamp | false | default | |
actualHours | The actual time spent on the task in hours. | decimal | false | default | |
billableHours | The portion of the time considered billable for the resource in hours. | decimal | false | default | The billableHours portion may in fact be greater than the actualHours value. |
description | The long description of the task. | string | false | default | |
assignedBy | The display name of the participant who assigned this task to the assignee. | string | false | additional | Tasks may at times be automatically generated; in which case, the assignedBy value will be "Auto-assigned". |
completeDuringStep | A constraint requiring that the task be completed while its associated Action resource is on this step. | integer | false | additional | |
completeBeforeStep | A constraint requiring that the task be completed before its associated Action can be moved to this step. | integer | false | additional | |
mustStartBeforeTimestamp | timestamp | false | additional | ||
expectedDurationValue | integer | false | additional | ||
expectedDurationUnits | string (25) | false | additional | ||
isBillingHold | If the task is being temporarily excluded from billing. | boolean | false | additional | |
isPartBilled | If the task has been part billed. | boolean | false | additional | |
confirmedNonBillable | If the task has been confirmed as non-billable. | boolean | false | additional | |
confirmedNonBillableTimestamp | If the task has been confirmed as non-billable, when it was confirmed as non-billable. | timestamp | false | additional | |
hasTriggerDate | If the task dueTimestamp is tied to a datacollections resource. | boolean | false | additional | |
triggerField | If the task dueTimestamp is tied to a datacollections resource, the name of the data field in that collection. | string | false | additional | |
triggerOffset | If the task dueTimestamp is tied to a datacollections resource, the offset in Days to apply to the triggerField value. | integer | false | additional | |
triggerWeekdaysOnly | If the task dueTimestamp is tied to a datacollections resource, whether to calculate the triggerOffset base solely on weekdays or all days. | boolean | false | additional | |
triggerDataCollection | The datacollections resource to be used to set the dueTimestamp. | string | false | link | Not Yet Implemented. |
action | The associated actions resource. | string | true | link | |
assignee | The associated participants resource for the participant to whom the task is assigned. | string | true | link | |
rate | The associated rates resource for the task. | string | true | link | |
confirmedNonBillableBy | The associated participants resource for the participant who confirmed the task as non-billable. | string | false | link | |
linkedDocumentTemplate | The associated documenttemplates resource for the task. | string | false | link | Not Yet Implemented. |
linkedDataCollection | The associated datacollections resource for the task. | string | false | link | Not Yet Implemented. |
template | The associated tasktemplates resource from which the task was created. | string | false | link | Not Yet Implemented. |
...
Code | Field | Condition |
---|---|---|
T-01 | billableHours | The billableHours value can't be less than the total Timerecords billableHours for this task. |
T-02 | actualHours | The actualHours value can't be less than the total Timerecords actualHours for this task. |
T-03 | assignee | The assignee is a system user and has (at least) read access to this task. |
T-04 | completedTimestamp | The completedTimestamp is less than the startedTimestamp. |
T-05 | completedTimestamp | The completedTimestamp must exist if the status is "CompletedComplete". |
T-06 | startedTimestamp | The startedTimestamp must exist if the status is anything other than "Not StartedIncomplete". |
T-07 | priority | The priority value must be "Low", "Normal" or "High" |
T-08 | status | The status value must be beĀ "Not Started", "In Progress", Incomplete" or "CompletedComplete" |
T-09 | completeDuringStep | The value of completeDuringStep must be less than the value of the completeBeforeStep. |
T-10 | confirmedNonBillableTimestamp | A value is required if the confirmedNonBillable === true. |
T-11 | confirmedNonBillableBy | A value is required if the confirmedNonBillable === true. |
T-12 | rate | A value is required if the billableHours > 0. |
...