Getting checklist parameters
Written by
Updated at February 19, 2024
Use this request to get the parameters of a checklist in issue.
Request format
Before making the request, get permission to access the API.
To get checklist parameters, use an HTTP GET request:
GET /v2/issues/<issue_ID_or_key>/checklistItems
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
Headers
-
Host
Address of the node that provides the API:
https://api.tracker.yandex.net -
Authorization
OAuth token in
OAuth <OAuth_token>format, e.g.:OAuth 0c4181a7c2cf4521964a72ff******** -
X-Org-ID or X-Cloud-Org-ID
Organization ID. You can find it out on the Tracker organizations page.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
X-Org-IDheader is used. - If a Yandex Cloud Organization organization is the only one linked to Tracker, the
X-Cloud-Org-IDheader is used. - If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the
X-Org-IDheader and the Yandex 360 for Business organization ID are used.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
Resource
| Parameter | Description | Data type |
|---|---|---|
| <issue_ID_or_key> | Issue ID or key | String |
Response format
Request executed successfully
Request failed
If the request is successful, the API returns a response with code 200 OK.
The response body contains information about the checklist items in JSON format.
{
"id": "5fde5f0a1aee261d********",
"text": "checklist item",
"textHtml": "item text in HTML format",
"checked": false,
"assignee": {
"id": 11********,
"display": "Full Name",
"passportUid": 11********,
"login": "user_login",
"firstName": "First name",
"lastName": "Last name",
"email": "user_login@example.com",
"trackerUid": 11********
},
"deadline": {
"date": "2021-05-09T00:00:00.000+0000",
"deadlineType": "date",
"isExceeded": false
},
"checklistItemType": "standard"
}
Response parameters
| Parameter | Description | Data type |
|---|---|---|
| id | Сhecklist item ID. | String |
| text | Text of the checklist item. | String |
| textHtml | Text of the checklist item in HTML format. | String |
| checked | Checklist item completion flag:
|
Logical |
| assignee | Assignee of the checklist item. | Object |
| deadline | Deadline for the checklist item. | Object |
| checklistItemType | Type of the checklist item. | String |
Object fields assignee
| Parameter | Description | Data type |
|---|---|---|
| id | User ID. | Number |
| display | Displayed user name. | String |
| passportUid | Unique ID of the user's Yandex account. | Number |
| login | User's login. | String |
| firstName | Username. | String |
| lastName | User's last name. | String |
| User's email address. | String | |
| trackerUid | Unique ID of the user Tracker account. | Number |
deadline object fields
| Parameter | Description | Data type |
|---|---|---|
| date | Deadline in YYYY-MM-DDThh:mm:ss.sss±hhmm format. |
Date |
| deadlineType | The deadline parameter data type. |
String |
| isExceeded | Flag indicating if the deadline has passed:
|
Logical |
If the request is processed incorrectly, the API returns a response with an error code:
- 400
- One or more request parameters have an invalid value.
- 401
- The user isn't authorized. Make sure to perform the actions described in API access.
- 403
- Insufficient rights to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
- 404
- The requested object was not found. You may have specified an invalid object ID or key.