Domain Model
Field Task
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| projectId | string.uuid | Yes | — | ID of the associated project |
| workOrderId | unknown | No | — | ID of the associated work order |
| workPackageId | unknown | No | — | ID of the associated work package |
| milestoneId | unknown | No | — | ID of the associated milestone |
| title | string | Yes | — | Title |
| description | unknown | No | — | Description |
| locationLabel | unknown | No | — | Location label |
| locationSortKey | unknown | No | — | Location sort key |
| drawingRef | unknown | No | — | Drawing ref |
| priority | enum(low, medium, high, urgent) | Yes | "medium" | Priority |
| estimatedMinutes | unknown | No | — | Estimated minutes |
| dueAt | unknown | No | — | Due at |
| sortOrder | integer | Yes | 0 | Sort order |
| requiredPermitTypes | string[] | Yes | [] | Required permit types |
| requiredCertificationTypeIds | string[] | Yes | [] | Required certification type ids |
| checklistTemplateId | unknown | No | — | ID of the associated checklist template |
| visibilityMode | unknown | No | — | Visibility mode |
| id | string.uuid | Yes | — | Id |
| workspaceId | string.uuid | Yes | — | ID of the associated workspace |
| status | enum(todo, in_progress, blocked, done, verified, canceled) | Yes | — | Status |
| percentComplete | integer | Yes | — | Percent complete |
| rowVersion | integer | Yes | — | Row version |
| claimedByUserId | unknown | Yes | — | ID of the associated claimed by user |
| claimedAt | unknown | Yes | — | Claimed at |
| blockedByIssueId | unknown | Yes | — | ID of the associated blocked by issue |
| createdBy | unknown | Yes | — | Created by |
| completedAt | unknown | Yes | — | Completed at |
| verifiedByUserId | unknown | Yes | — | ID of the associated verified by user |
| verifiedAt | unknown | Yes | — | Verified at |
| createdAt | string.date-time | Yes | — | Created at |
| updatedAt | string.date-time | Yes | — | Updated at |
Create Schema
Fields accepted when creating a new record:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| projectId | string.uuid | Yes | — | ID of the associated project |
| workOrderId | unknown | No | — | ID of the associated work order |
| workPackageId | unknown | No | — | ID of the associated work package |
| milestoneId | unknown | No | — | ID of the associated milestone |
| title | string | Yes | — | Title |
| description | unknown | No | — | Description |
| locationLabel | unknown | No | — | Location label |
| locationSortKey | unknown | No | — | Location sort key |
| drawingRef | unknown | No | — | Drawing ref |
| priority | enum(low, medium, high, urgent) | Yes | "medium" | Priority |
| estimatedMinutes | unknown | No | — | Estimated minutes |
| dueAt | unknown | No | — | Due at |
| sortOrder | integer | Yes | 0 | Sort order |
| requiredPermitTypes | string[] | Yes | [] | Required permit types |
| requiredCertificationTypeIds | string[] | Yes | [] | Required certification type ids |
| checklistTemplateId | unknown | No | — | ID of the associated checklist template |
| visibilityMode | unknown | No | — | Visibility mode |
Update Schema
All fields are optional when updating:
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| workOrderId | unknown | No | — | ID of the associated work order |
| workPackageId | unknown | No | — | ID of the associated work package |
| milestoneId | unknown | No | — | ID of the associated milestone |
| title | string | No | — | Title |
| description | unknown | No | — | Description |
| locationLabel | unknown | No | — | Location label |
| locationSortKey | unknown | No | — | Location sort key |
| drawingRef | unknown | No | — | Drawing ref |
| priority | enum(low, medium, high, urgent) | No | — | Priority |
| estimatedMinutes | unknown | No | — | Estimated minutes |
| dueAt | unknown | No | — | Due at |
| sortOrder | integer | No | — | Sort order |
| requiredPermitTypes | string[] | No | — | Required permit types |
| requiredCertificationTypeIds | string[] | No | — | Required certification type ids |
| checklistTemplateId | unknown | No | — | ID of the associated checklist template |
| visibilityMode | unknown | No | — | Visibility mode |
| id | string.uuid | Yes | — | Id |
| expectedRowVersion | integer | Yes | — | Expected row version |