Lookups
Related objects
These objects are exposed through the collection /api/v01/Tasks/odata/<Object> and are read-only.
Statuses
Task status reference, localized for the current user.
| Field | Type | Description |
|---|---|---|
| Language | NVARCHAR | Language code |
| StatusID | NVARCHAR(10) | Status identifier |
| StatusText | NVARCHAR | Localized text |
| StatusDescription | NVARCHAR | Status description |
| StatusIcon | NVARCHAR | Icon |
| StatusColor | NVARCHAR | Color |
| StatusCategoryID | NVARCHAR | Category ('1', '2', '3') |
| StatusCategoryText | NVARCHAR | Localized category name |
| ResolutionID | NVARCHAR | Linked resolution, if the status sets one |
| IntegrationID | NVARCHAR | External ID |
Types
Task type reference (Bug, Task, Story, etc.).
| Field | Type | Description |
|---|---|---|
| Language | NVARCHAR | Language code |
| TypeID | NVARCHAR(10) | Type identifier |
| TypeText | NVARCHAR | Localized text |
| TypeDescription | NVARCHAR | Description |
| TypeIcon | NVARCHAR | Icon |
| TypeColor | NVARCHAR | Color |
| IntegrationID | NVARCHAR | External ID |
Priorities
Priority reference.
| Field | Type | Description |
|---|---|---|
| Language | NVARCHAR | Language code |
| PriorityID | NVARCHAR(10) | Identifier |
| PriorityText | NVARCHAR | Localized text |
| PriorityDescription | NVARCHAR | Description |
| PriorityIcon | NVARCHAR | Icon |
| PriorityColor | NVARCHAR | Color |
| IntegrationID | NVARCHAR | External ID |
Resolutions
Resolution reference (Done, Won't Fix, Duplicate, etc.).
| Field | Type | Description |
|---|---|---|
| Language | NVARCHAR | Language code |
| ResolutionID | NVARCHAR(10) | Identifier |
| ResolutionText | NVARCHAR | Localized text |
| ResolutionDescription | NVARCHAR | Description |
| ResolutionIcon | NVARCHAR | Icon |
| ResolutionColor | NVARCHAR | Color |
| IntegrationID | NVARCHAR | External ID |
Components
Project components. Linked to a project through ProjectID.
| Field | Type | Description |
|---|---|---|
| ComponentID | NVARCHAR(10) | Component identifier |
| ProjectID | NVARCHAR(10) | Project the component belongs to |
| ComponentText | NVARCHAR | Name |
| ComponentDescription | NVARCHAR | Description |
| ComponentLeadID | NVARCHAR | Component lead (UserID) |
| ComponentLeadFullName | NVARCHAR(121) | Lead full name |
| DefaultAssigneeID | NVARCHAR | Default assignee |
| DefaultAssigneeFullName | NVARCHAR(121) | Default assignee full name |
| ParentID | NVARCHAR | Parent component if hierarchical |
| IntegrationID | NVARCHAR | External ID |
Versions
Fix versions.
| Field | Type | Description |
|---|---|---|
| VersionID | NVARCHAR(10) | Version identifier |
| ProjectID | NVARCHAR(10) | Project |
| ProjectReleasText | NVARCHAR(64) | Version name |
| ProjectReleasDescription | NVARCHAR | Description |
| ReleaseStatusID | NVARCHAR | Release status |
| ReleaseStatusText | NVARCHAR | Localized release status |
| StartDate | DATE | Start date |
| ReleaseDate | DATE | Release date |
| ParentID | NVARCHAR | Parent version |
| IntegrationID | NVARCHAR | External ID |
Labels
Labels. Returns labels actually used in tasks of projects visible to the user; the first item is an "empty" label from i18n (btnNone).
| Field | Type | Description |
|---|---|---|
| Label | NVARCHAR(64) | Label |
Watchers
Task watchers.
| Field | Type | Description |
|---|---|---|
| TaskID | NVARCHAR(10) | Task |
| WatcherID | NVARCHAR(10) | Watcher UserID |
| WatcherByAvatar | NVARCHAR(2083) | Avatar URL |
| WatcherByFullName | NVARCHAR(121) | Full name |
| IntegrationID | NVARCHAR | External ID |
Projects (in the Tasks context)
A slice of projects available to the current user as a task creator.
| Field | Type | Description |
|---|---|---|
| ProjectID | NVARCHAR(10) | Identifier |
| ProjectCode | NVARCHAR(60) | Project code |
| ProjectText | NVARCHAR(128) | Display name (<ProjectCode> - <ProjectText>) |
| Version | NVARCHAR | Record version ('A' — active) |
| Language | NVARCHAR | Language |
| ProjectIcon | NVARCHAR | Icon |
| ProjectIconColor | NVARCHAR | Color |
| IntegrationID | NVARCHAR | External ID |