Contact UsGet started

Creating a checklist or adding items to it

Written by
Updated at May 6, 2024

Use this request to create a checklist and add new items to it. New items are added to the end of the list.

Request format

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

To create a new checklist or add items to an existing one, use an HTTP POST request. Information about new items is transmitted in its body in JSON format.

POST /v2/entities/<entity_type>/<entity_ID>/checklistItems
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
  "text": "<item_text>",
  "checked": true,
  "assignee": "<assignee_ID_or_login>",
  "deadline": {
    "date": "2021-05-09T00:00:00.000+0000",
    "deadlineType": "date"
  },
}
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-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Resource
Parameter Description Data type
<entity_type> Entity type:
  • Project for a project
  • Portfolio for a portfolio
 String
<entity_ID> Entity ID. To get the ID, see the entity list. String
<project_or_portfolio_ID> Project or portfolio ID (the shortId value). You can use it instead of the entity ID in the request. String

Warning

Entity ID is not the same as project or portfolio ID.

Request parameters

Additional parameters

Parameter Description Data type
notify Notify the users specified in the Author, Responsible, Participants, Customers, and Followers fields. The default value is true. Boolean
notifyAuthor Notify the author of the changes. The default value is false. Boolean
fields Additional entity fields to be included into the response. String
expand Additional information to be included into the response:
  • attachments: Attached files
 String
Request body parameters

The request body contains the information required to add items to the checklist:

Required parameters

Parameter Description Data type
text Text of the checklist 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 that the checklist item is assigned to. Number or string
deadline Deadline for the checklist item. Object

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

Example: Adding two items to a checklist

  • An HTTP POST method is used.
  • Item added to the checklist: Сhecklist item 1.
  • Item added to the checklist: Checklist item 2 marked as completed.
  • The response displays information about all the checklist items (fields=checklistItems).
POST /v2/entities/project/<project_ID>/checklistItems?fields=checklistItems
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

[
  {
     "text":"Сhecklist item 1."
  },
  {
     "text":"Checklist item 2.",
     "checked": true
  }
]

Response format

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

The response body contains information about the entity, its attachments, and checklist items in JSON format.

{
    "self": "https://api.tracker.yandex.net/v2/entities/project/6586d6fee2b9ef74********",
    "id": "6586d6fee2b9ef74********",
    "version": 133,
    "shortId": 0,
    "entityType": "project",
    "createdBy": {
        "self": "https://api.tracker.yandex.net/v2/users/19********",
        "id": "19********",
        "display": "Full name",
        "cloudUid": "ajeppa7dgp53********",
        "passportUid": "15********"
    },
    "createdAt": "2023-12-13T15:06:27.231Z",
    "updatedAt": "2023-12-13T15:06:27.231Z",
    "fields": {
        "checklistItems": [
           {
               "id": "6586d91f99a40477********",
               "text": "Сhecklist item 1.",
               "checked": false,
               "checklistItemType": "standard"
           },
           {
               "id": "6586d91f99a40477********",
               "text": "Сhecklist item 2.",
               "checked": true,
               "checklistItemType": "standard"
           }
        ]
    }
}
Response parameters
Parameter Description Data type
self Address of the API resource with information about the entity. String
id Entity ID. String
version Entity version. Each change of the parameters increases the version number. Number
shortId Project or portfolio ID. Number
entityType Entity type:
  • Project for a project
  • Portfolio for a portfolio
 String
createdBy Object with information about the entity creator. Object
createdAt Entity creation date in YYYY-MM-DDThh:mm:ss.sss±hhmm format. String
updatedAt Date when the entity was last updated, in YYYY-MM-DDThh:mm:ss.sss±hhmm format. String
fields Additional entity fields. Object

createdBy object fields

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

fields object fields

Parameter Description Data type
checklistItems Information about checklist items. Array of objects

checklistItems object fields

Parameter Description Data type
id Сhecklist item ID. Number
text Text of the checklist item. String
checked Item completion flag:
  • true: Item marked as completed.
  • false: Item not marked as completed.
 Boolean
checklistItemType Checklist item type:
  • Standard
  • Metric
  • Criterion
  • Filter
 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.
Previous
Deleting a comment
Next
Editing a checklist