Editing a checklist item

Written by

Updated at February 19, 2024

Request format
Response format

The request allows you to update information about an individual checklist item in an entity.

Request format

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

To edit a checklist item, use an HTTP PATCH request. Request parameters are provided in the request body in JSON format.

PATCH /v2/entities/<entity_type>/<entity_ID>/checklistItems/<checklist_item_ID>
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
<checklist_item_id>	Сhecklist item ID. To get the ID, see the entity parameters.	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

Request body contains the information required to make changes to the checklist item:

Additional parameters

Parameter	Description	Data type
text	Text of the checklist item.	String
checked	Item completion flag: `true`: Item marked as completed. `false`: Item not marked as completed.	Logical
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	The `deadline` parameter data type.	String

Example: Changing checklist item information

An HTTP PATCH method is used.

Checklist item gets a name update and a completion flag.

The response displays information about all the checklist items (fields=checklistItems).
PATCH /v2/entities/project/<project_ID>/checklistItems/<checklist_item_ID>?fields=checklistItems
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
   "text":"<updated_checklist_item>",
   "checked": true
}

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 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": "Updated checklist item.",
               "checked": true,
               "checklistItemType": "standard"
           },
           {
               "id": "6586d91f99a40472********",
               "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 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	User unique 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.	Logical
assignee	Checklist item assignee	Object
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.

Editing a checklist item

Request formatRequest format

Response formatResponse format

Was the article helpful?

Request format

Response format