Fields
Task fields
The fields are returned by both the single-record endpoint Task and the collection Tasks. The field set is identical.
Identifiers and hierarchy
| Field | Type | Description |
|---|---|---|
| TaskID | NVARCHAR(10) | Internal task identifier |
| TaskKey | NVARCHAR(128) | Business key of the task (e.g., PROJ-42) |
| TaskKeySort | NVARCHAR(136) | Sort key (with project prefix and leading zeros) |
| TaskNumber | INTEGER | Sequence number of the task within the project |
| IntegrationID | NVARCHAR(128) | External ID from an integrated system |
| ParentID | NVARCHAR(10) | TaskID of the parent task |
| ParentTaskKey | NVARCHAR(128) | Business key of the parent |
| isParent_F | NVARCHAR(1) | Flag indicating the task has subtasks ('X' / empty) |
| isChild_F | NVARCHAR(1) | Flag indicating the task is a subtask ('X' / empty) |
| TreeLevel | INTEGER | Nesting level |
Task content
| Field | Type | Description |
|---|---|---|
| TaskText | NVARCHAR(256) | Task title |
| StatusID | NVARCHAR(10) | Status identifier (FK to the Statuses reference) |
| StatusText | NVARCHAR(128) | Localized status text |
| StatusIcon | NVARCHAR(64) | Status icon name |
| StatusColor | NVARCHAR(20) | Status color |
| StatusCategoryID | NVARCHAR(1) | Status category ('1' To Do, '2' In Progress, '3' Done) |
| StatusCategoryText | NVARCHAR(128) | Localized category name |
| StatusChanged | SECONDDATE | When the status was last changed |
| TaskTypeID | NVARCHAR(10) | Task type (FK to Types) |
| TypeText | NVARCHAR(128) | Localized type text |
| TypeIcon | NVARCHAR(64) | Type icon |
| TypeColor | NVARCHAR(20) | Type color |
| PriorityID | NVARCHAR(10) | Priority (FK to Priorities) |
| PriorityText | NVARCHAR(128) | Localized priority text |
| PriorityIcon | NVARCHAR(64) | Priority icon |
| PriorityColor | NVARCHAR(20) | Priority color |
| ResolutionID | NVARCHAR(10) | Resolution (FK to Resolutions) |
| ResolutionText | NVARCHAR(128) | Localized resolution text |
| ResolutionIcon | NVARCHAR(64) | Resolution icon |
| ResolutionColor | NVARCHAR(20) | Resolution color |
| Label | NVARCHAR(64) | Label |
| Component | NVARCHAR(64) | Component |
| ComponentText | NVARCHAR(64) | Localized component text |
| FixVersion | NVARCHAR(64) | Fix version |
| ProjectReleasText | NVARCHAR(64) | Release text |
Users
| Field | Type | Description |
|---|---|---|
| AssigneeID | NVARCHAR(10) | Assignee |
| AssigneeFullName | NVARCHAR(121) | Assignee full name |
| AssigneeAvatarURL | NVARCHAR(2083) | Assignee avatar URL |
| AssigneeIntegrationID | NVARCHAR(64) | Assignee external ID |
| ReporterID | NVARCHAR(10) | Reporter |
| ReporterFullName | NVARCHAR(121) | Reporter full name |
| ReporterAvatarURL | NVARCHAR(2083) | Reporter avatar URL |
| ReporterIntegrationID | NVARCHAR(64) | Reporter external ID |
| CreatedBy | NVARCHAR(256) | UserID of the author |
| CreatedByFullName | NVARCHAR(2083) | Author full name |
| CreatedByAvatar | NVARCHAR(121) | Author avatar URL |
| CreatedByIntegrationID | NVARCHAR(64) | Author external ID |
| ModifiedBy | NVARCHAR(256) | UserID of the last modifier |
| ModifiedByFullName | NVARCHAR(2083) | Last modifier full name |
| ModifiedByAvatar | NVARCHAR(121) | Last modifier avatar URL |
| ModifiedByIntegrationID | NVARCHAR(64) | Last modifier external ID |
Project
| Field | Type | Description |
|---|---|---|
| ProjectID | NVARCHAR(10) | Project identifier |
| ProjectCode | NVARCHAR(60) | Project code |
| ProjectText | NVARCHAR(128) | Project name |
| ProjectIcon | NVARCHAR(64) | Project icon |
| ProjectIconColor | NVARCHAR(20) | Project icon color |
| ProjectIntegrationID | NVARCHAR(64) | Project external ID |
| ProjectTypeID | NVARCHAR(10) | Project type |
| ProjectCategoryID | NVARCHAR(10) | Project category |
| ProjectCategoryText | NVARCHAR(128) | Category text |
| ProjectCategoryIcon | NVARCHAR(64) | Category icon |
| ProjectCategoryIconColor | NVARCHAR(20) | Category icon color |
| ProjectCustomerID | NVARCHAR(10) | Customer |
| PartnerID | NVARCHAR(10) | Partner |
| ProjectCompanyID | NVARCHAR(10) | Project owner company |
| ProjectPMID | NVARCHAR(10) | Project manager |
| LineOfBusinessID | NVARCHAR(10) | Line of business |
| LineOfBusinessText | NVARCHAR(128) | Line of business text |
| LineOfBusinessIcon | NVARCHAR(64) | Line of business icon |
| LineOfBusinessIconColor | NVARCHAR(20) | Line of business icon color |
Time
| Field | Type | Description |
|---|---|---|
| OriginalEstimate | BIGINT | Original estimate, seconds |
| OriginalEstimateTotal | BIGINT | Estimate including subtasks |
| RemainingEstimate | BIGINT | Remaining estimate, seconds |
| RemainingEstimateTotal | BIGINT | Remaining estimate including subtasks |
| TimeSpent | BIGINT | Time spent, seconds |
| TimeSpentTotal | BIGINT | Time spent including subtasks |
| StoryPoint | INT | Story points |
| Order | INT | Order in the backlog/sprint |
| DateTimeStart | SECONDDATE | Planned start date |
| DateTimeEnd | SECONDDATE | Planned end date |
| DateTimeResolved | SECONDDATE | Date the task moved to a final status |
| DueDateTime | SECONDDATE | Due date |
| OverTimeSeconds | BIGINT | Estimate overrun, seconds |
| OverDueSeconds | BIGINT | Due date overrun, seconds |
| OverDueDays | BIGINT | Due date overrun, days |
| Progress | INTEGER | Task progress, % |
| ProgressColor | SMALLINT | Progress color marker |
| ProgressTotal | INTEGER | Progress including subtasks, % |
| ProgressTotalColor | SMALLINT | Combined progress color marker |
| RatingDueDate | SMALLINT | Due date rating marker |
| RatingEstimate | SMALLINT | Estimate rating marker |
| RatingLikes | SMALLINT | Likes rating marker |
Counters and activity
| Field | Type | Description |
|---|---|---|
| AttachCount | INTEGER | Number of attachments |
| FeedBackCount | INTEGER | Number of comments |
| WorkLogCount | INTEGER | Number of work logs |
| WatcherCount | INTEGER | Number of watchers |
| SubTaskCount | INTEGER | Number of subtasks |
| LikesCount | INTEGER | Likes |
| DisLikesCount | INTEGER | Dislikes |
| LikesStatus | INTEGER | Current user's like status |
Audit
| Field | Type | Description |
|---|---|---|
| Created | SECONDDATE | Creation date |
| Modified | SECONDDATE | Last modification date |
RTE description. The task description is not returned as a regular field. It is stored separately as an HTML attachment and is available through the attachments subsystem API.