Task
Task / Tasks
The entity represents a task (issue). A task is always linked to a project, may have a parent (be part of a subtask hierarchy), watchers, custom fields, and an attached description in RTE (HTML) format.
The service is split into two endpoints: Task — operations on a single task and single-record reads; Tasks — collection queries and related reference objects.
Task keys
A task can be identified by one of three keys:
| Key | Type | Description |
|---|---|---|
| TaskID | NVARCHAR(10) | Internal surrogate identifier |
| TaskKey | NVARCHAR(128) | Business key of the form <ProjectCode>-<TaskNumber> (e.g., PROJ-42) |
| IntegrationID | NVARCHAR(128) | External identifier from an integrated system |
Base URL
https://<host>/api/v01/Task https://<host>/api/v01/Tasks
Endpoint map
| Method | URL | Purpose | Transport |
|---|---|---|---|
| GET | /api/v01/Task/odata/Task(ID='…',TaskKeyField='…') | Read a single task | OData |
| GET | /api/v01/Task/odata/TaskCustomFields(…) | Custom fields of a single task | OData |
| GET | /api/v01/Tasks/odata/Tasks | Task list | OData |
| GET | /api/v01/Tasks/odata/TaskCustomFields | Custom fields across tasks | OData |
| GET | /api/v01/Tasks/odata/Statuses | Status reference | OData |
| GET | /api/v01/Tasks/odata/Types | Task type reference | OData |
| GET | /api/v01/Tasks/odata/Priorities | Priority reference | OData |
| GET | /api/v01/Tasks/odata/Resolutions | Resolution reference | OData |
| GET | /api/v01/Tasks/odata/Components | Project component reference | OData |
| GET | /api/v01/Tasks/odata/Labels | Label reference | OData |
| GET | /api/v01/Tasks/odata/Versions | Version (fix-versions) reference | OData |
| GET | /api/v01/Tasks/odata/Watchers | Task watchers | OData |
| GET | /api/v01/Tasks/odata/Projects | Projects available to the user | OData |
| POST | /api/v01/Task/rest/Create | Create a task | REST |
| POST | /api/v01/Task/rest/Update | Update a task | REST |
| POST | /api/v01/Task/rest/Delete | Delete a task | REST |
Task description (RTE). The task description field is stored separately from the main record — as an HTML file in the attachments subsystem. In REST operations it is passed as follows: in POST /Task/rest/Create — in the body, at the top level, the Description field (HTML string); in POST /Task/rest/Update — in the query parameter Description. When updating, a history entry for the description change is created automatically (HTML diff).