Work Item
Work Item Object
| Field | Type | Description |
|---|---|---|
| id | snowflake | the work item's id |
| number | integer | the sequential number for the work item within an organisation |
| type | snowflake | the type of work item |
| status | status object | the status of the work item |
| priority | priority object | the priority of the work item |
| organisation_id | snowflake | the id of the organisation |
| workitem_id | ?snowflake | the id of the parent work item |
| summary | string | a short summary of the work item (2-100 characters) |
| details | string | a long description of the work item (up to 16000 characters) |
| created_by | user object | the creator of the work item |
| owner | user object | the owner of the work item |
| asset | asset group object | the asset the work item is raised against or null |
| system | system object | the system the work item is raised against or null |
| document | document object | the document the work item is raised against or null |
| created_at | ISO8601 timestamp | when the work item was created |
| edited_at | ?ISO8601 timestamp | when the work item was edited or null |
| due_at | ?ISO8601 timestamp | due date for the work item or null |
| duration_estimated | double | the estimated duration in hours |
| duration_actual | double | the actual duration in hours |
| fields | array of fields | additional work item fields |
Work Item Type Object
Work items can have different types. These types either map to an asset type or to a document type.
| Field | Type | Description |
|---|---|---|
| id | snowflake | the work item type's id |
| organisation_id | snowflake | the id of the organisation |
| name | string | the work item field's name (2-20 characters) |
| description | string | a description of the work order field |
Work Item Type Field
Custom work item fields can be added to extend work items.
| Field | Type | Description |
|---|---|---|
| id | snowflake | the work item field's id |
| type | work item type | the work item type of the custom field |
| data_type | integer | the data type of the work item type |
| data_type_strings | array of work item type strings | a string enumeration for the integer type |
| name | string | the work item field's name (2-20 characters) |
| description | string | a description of the work order field |
| mandatory | ?boolean | true if the field is mandatory for work items |
Work Item Field Data Types
| Value | Name | Description |
|---|---|---|
| 0 | string | an array of characters up to 255 |
| 1 | integer | a 32 bit signed integer number |
| 2 | double | an IEEE 754-2008 double precision floating point number |
| 3 | ISO8601 timestamp | a date and time |
| 4 | boolean | true or false |
| 10 | user | a snowflake id for a user |
Work Item Type String Object
Work item types can be an enumeration Field | Type | Description ---|---|--- id | snowflake | the work item type string's id field_id | snowflake | the work item field's id value | integer | the key value for the work item type string label | string | the label for the work item type string
Work Item Status Object
Work items have a status. These status can be mapped to the following work item states "open" and "closed".
| Field | Type | Description |
|---|---|---|
| id | snowflake | the work item status' id |
| organisation_id | snowflake | the id of the organisation |
| closed | bool | true if this status is for a work item in the closed state |
| name | string | the status' name (2-20 characters) |
| description | string | a description of the status |
Work Item Priority Object
Work items have a priority assigned.
| Field | Type | Description |
|---|---|---|
| id | snowflake | the work item priority's id |
| organisation_id | snowflake | the id of the organisation |
| name | string | the status' name (2-20 characters) |
| description | string | a description of the status |
| colour | integer | hex colour value |
Work Item Log Object
Work items can have comments logged against them. The comments form a journal history of the work item.
| Field | Type | Description |
|---|---|---|
| id | snowflake | the work item log's id |
| workitem_id | snowflake | the work item's id |
| user | user object | the creator of the work item |
| created_at | ISO8601 timestamp | when the work item was created |
| edited_at | ?ISO8601 timestamp | when the work item was edited or null |
| log | string | the contents of the work item log |
Work Item Attachment
Work items can have files and photos attached to them.
| Field | Type | Description |
|---|---|---|
| id | snowflake | the work item attachment's id |
| workitem_id | snowflake | the work item's id |
| filename | string | the attachment's filename (2-255 characters) |
| content_type | string | the attachment's content type (2-255 characters) |
| size | integer | the attachment's size in bytes |
| user | user object | the creator of the work item |
| created_at | ISO8601 timestamp | when the work item attachment was uploaded |
| description | string | a description of the work item attachment |
Work Item Schedule Object
Work items can also be scheduled across one or more days/shifts. Work items can either be static occuring at a single location, or dynamic between two locations. An example would be a test flight between two airports.
| Field | Type | Description |
|---|---|---|
| id | snowflake | the work item schedule's id |
| token | token | a randomised reference number for the work item schedule |
| workitem_id | snowflake | the work item's id |
| scheduled_start_at | ISO8601 timestamp | the time scheduled to start at |
| scheduled_finish_at | ISO8601 timestamp | the time scheduled to finish at |
| actual_start_at | ?ISO8601 timestamp | the time the work item schedule started at or null |
| actual_finish_at | ?ISO8601 timestamp | the time the work item scheduled finished at or null |
| captain | user object | the user responsible for the work item schedule (shift) |
| start_location | location object | the location the work item is scheduled to start at |
| finish_location | location object | the location the work item is scheduled to finish at |
Work Item Schedule Invitee
Work item schedules can have user's invited to participate in the work item. This will add the work item to the user's calendar.
| Field | Type | Description |
|---|---|---|
| id | snowflake | the work item schedule's id |
| token | token | a randomised reference number for the work item schedule invitee |
| string | the invitee's e-mail | |
| phonenumber | string | the invitee's mobile phone number |
| firstname | string | the invitee's first name |
| lastname | string | the invitee's last name |
| company | string | the invitee's company |
| position | string | the invitee's position at their company |
Create Work Item
POST /organisations/{organisation.id}/workitems
Parameters
| Field | Type | Description |
|---|---|---|
| summary | string | a short summary of the work item (2-100 characters) |
| details | string | a long description of the work item (up to 16000 characters) |
Update Work Item
PATCH /organisations/{organisation.id}/workitems/{workitem.id}
Update Work Item Schedule
PATCH /organisations/{organisation.id}/workitems/{workitem.id}/schedules/{schedule.id}
Parameters
| Field | Type | Description |
|---|---|---|
| actual_start_at | ?ISO8601 timestamp | the actual start time of the work item schedule |
| actual_finish_at | ?ISO8601 timestamp | the actual finish time of the work item schedule |