Getting checklist parameters

Use this request to get the parameters of a checklistin an issue.

GET

https://api.tracker.yandex.net/v3/issues/<issue_ID>/checklistItems

Query format

Before making a request, get permission to access the API.

To get checklist parameters, use an HTTP GET request:

GET /v3/issues/<issue_ID>/checklistItems
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
Headers

  • Host: Address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more

  • X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.

    To get the organization ID, go to Administration → Organizations and copy the value from the ID field.

Resource
Parameter Description Data type
<issue_ID> Issue ID or key String

Response format

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:
  • true: Item marked as completed.
  • false: Item not marked as completed.
 Boolean
assignee Assignee of the checklist item. Map item
deadline Deadline for the checklist item. Map item
checklistItemType Type of the checklist item. String

assignee object fields

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
email 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 deadline parameter data type. String
isExceeded Flag indicating if the deadline has passed:
  • true: Passed.
  • false: Not passed.
 Boolean

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 is not authorized. Make sure that actions described in the API access section are performed.
403
You are not authorized 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.
Previous
Creating a checklist or adding items to it
Next
Editing a checklist