Creating a checklist or adding items to it

Use this request to create a checklist and add new items to it.

POST

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

Query format

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

To create a new checklist or add items to an existing one, use an HTTP POST request. In the request body, specify the parameters in JSON format.

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

{
    "text": "<item_text>",
    "checked": true,
    "assignee" : "<user_ID_or_login>",
    "deadline": {
            "date": "2021-05-09T00:00:00.000+0000",
            "deadlineType": "date"
        }
}
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.

Request body parameters

The request body contains the information required to create a checklist or add an item to a checklist:

Required parameters

Parameter Description Data type
text Text of the item. String

Additional parameters

Parameter Description Data type
checked Item completion flag:
  • true: Item marked as completed.
  • false: Item not marked as completed.
 Boolean
assignee ID or username of the user to whom the checklist item is assigned. String
deadline Deadline for the checklist item. Map item

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

Response format

If the request is successful, the API returns a response with code 200 OK.

The response body contains a JSON object with the parameters of the checklist and the issue it was added to.

{
    "self": "https://api.tracker.yandex.net/v3/issues/ORG-3",
    "id": "5f981c00b982f075********",
    "key": "ORG-3",
    "version": 133,
    "lastCommentUpdatedAt": "2020-12-13T13:18:22.965+0000",
    "pendingReplyFrom": [
        {
            "self": "https://api.tracker.yandex.net/v3/users/12********",
            "id": "12********",
            "display": "Full name"
        }
    ],
    "summary": "Issue name",
    "statusStartTime": "2020-11-03T11:19:24.733+0000",
    "updatedBy": {
        "self": "https://api.tracker.yandex.net/v3/users/12********",
        "id": "12********",
        "display": "Full name"
    },
    "description": "Issue description",
    "type": {
        "self": "https://api.tracker.yandex.net/v3/issuetypes/2",
        "id": "2",
        "key": "task",
        "display": "Issue"
    },
    "priority": {
        "self": "https://api.tracker.yandex.net/v3/priorities/3",
        "id": "3",
        "key": "normal",
        "display": "Normal"
    },
    "previousStatusLastAssignee": {
        "self": "https://api.tracker.yandex.net/v3/users/12********",
        "id": "12********",
        "display": "Full name"
    },
    "createdAt": "2020-10-27T13:09:20.085+0000",
    "followers": [
        {
            "self": "https://api.tracker.yandex.net/v3/users/12********",
            "id": "12********",
            "display": "Full name"
        }
    ],
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v3/users/12********",
        "id": "12********",
        "display": "Full name"
    },
    "checklistItems": [
        {
            "id": "5fde5f0a1aee261d********",
            "text": "checklist item",
            "textHtml": "item text in HTML format",
            "checked": false,
            "checklistItemType": "standard"
        }
    ],
    "votes": 0,
    "assignee": {
        "self": "https://api.tracker.yandex.net/v3/users/12********",
        "id": "12********",
        "display": "Full name"
    },
    "deadline": "2020-10-28",
    "queue": {
        "self": "https://api.tracker.yandex.net/v3/queues/ORG",
        "id": "1",
        "key": "ORG",
        "display": "Startrek"
    },
    "updatedAt": "2020-12-19T20:14:02.648+0000",
    "status": {
        "self": "https://api.tracker.yandex.net/v3/statuses/2",
        "id": "2",
        "key": "needInfo",
        "display": "Need info"
    },
    "previousStatus": {
        "self": "https://api.tracker.yandex.net/v3/statuses/3",
        "id": "3",
        "key": "inProgress",
        "display": "In progress"
    },
    "favorite": false
}
Response parameters
Parameter Description Data type
self Address of the API resource with information about the issue. String
id Issue ID. String
version Issue version. Each change of the parameters increases the version number.
Issue edits will be disabled if the version number reaches the threshold value of 10100 (for robots) or 11100 (for users).		 Number
key Issue key. String
pendingReplyFrom Object with information about the employee whose response is awaited. Map item
lastCommentUpdatedAt Last comment's update time. String
summary Issue name. String
statusStartTime Issue creation time. String
updatedBy Object with information about the employee who edited the issue last. Map item
description Issue description. String
type Object with information about the issue type. Map item
priority Object with information about the priority. Map item
previousStatusLastAssignee Object with information about the assignee of the issue in the previous status. Map item
createdAt Issue creation date and time. String
followers Array of objects with information about issue followers. Map item
createdBy Object with information about the user who created the issue. Map item
checklistItems Array of objects with information about checklist items. Map item
votes Number of votes for the issue. Number
assignee Object with information about the issue's assignee. Map item
deadline Deadline for completing the issue. String
updatedAt Date and time when the issue was last updated. String
queue Object with information about the issue queue. Map item
status Object with information about the issue status. Map item
previousStatus Object with information about the previous status of the issue. Map item
favorite Favorite issue flag:
  • true: Issue added to favorites by the user.
  • false: Issue not added to favorites.
 Number

updatedBy object fields

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization String

pendingReplyFrom object fields

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization String

type object fields

Parameter Description Data type
self Address of the API resource with information about the issue type. String
id Issue type ID String
key Issue type key. String
display Issue type name displayed. String

priority object fields

Parameter Description Data type
self Address of the API resource with information about the priority. String
id Priority ID String
key Priority key. String
display Priority name displayed. String

previousStatusLastAssignee object fields

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization String

followers object fields

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization String

createdBy object fields

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization String

checklistItems object fields

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 object
deadline Deadline for the checklist item. Map object
checklistItemType Type of the checklist item. String

assignee object fields (checklist item)

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 account in Yandex Tracker. Number

deadline object fields (checklist item)

Parameter Description Data type
date Deadline in YYYY-MM-DDThh:mm:ss.sss±hhmm format. Date
deadlineType Deadline type:
  • date
  • quarter
 String
isExceeded Flag indicating if the deadline has passed:
  • true: Passed.
  • false: Not passed.
 Boolean

queue object fields

Parameter Description Data type
self Address of the API resource with information about the queue. String
id Queue ID. String
key Queue key. String
display Queue name displayed. String

status object fields

Parameter Description Data type
self Address of the API resource with information about the status. String
id Status ID. String
key Status key. String
display Status name displayed. String

previousStatus object fields

Parameter Description Data type
self Address of the API resource with information about the status. String
id Status ID. String
key Status key. String
display Status name displayed. String

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.
404
The requested object was not found. You may have specified an invalid object ID or key.
422
JSON validation error, the request is rejected.
423
Object edits disabled. The version parameter value limit (the maximum number of object updates) might have been exceeded. The maximum version value is 10100 for robots and 11100 for users.
Previous
Deleting a link with an issue
Next
Getting checklist parameters