Editing a checklist

Use this request to edit the items of a checklist in issue.

PATCH

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

Query format

To edit checklist items, use an HTTP PATCH request:

PATCH /v3/issues/<issue_ID>/checklistItems/<checklist_item_ID>
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": "11********",
  "deadline": {
        "date": "2021-05-25T00: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.

Resource

Parameter	Description	Data type
<issue_ID>	Issue ID or key.	String
<checklist_item_ID>	hecklist item ID. To get the ID, run a request.	String

Request body parameters

The request body contains the checklist item parameters. It must list all the items.

Required parameters

Parameter	Description	Data type
text	Text of the checklist item.	String

Additional parameters

Parameter	Description	Data type
checked	Checklist 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

Request executed successfully

Request failed

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 items and the parameters of the issue where the checklist was modified.

{
    "self": "https://api.tracker.yandex.net/v3/issues/ORG-3",
    "id": "5f981c00b982f075********",
    "key": "ORG-3",
    "version": 184,
    "lastCommentUpdatedAt": "2021-02-06T17:14: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/19********",
        "id": "19********",
        "display": "Full name"
    },
    "checklistDone": "2",
    "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/19********",
            "id": "19********",
            "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,
            "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"  
      },
      ...
     ],
    },
   "checklistTotal": 4,
   "votes": 0,
   "deadline": "2020-10-28",
   "queue": {
        "self": "https://api.tracker.yandex.net/v3/queues/ORG",
        "id": "1",
        "key": "ORG",
        "display": "Startrek"
    },
   "updatedAt": "2021-02-16T08:28:41.095+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
key	Issue key.	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
lastCommentUpdatedAt	Last comment's update time.	String
pendingReplyFrom	Object with information about the employee whose response is awaited.	Map item
summary	Issue name.	String
statusStartTime	Issue creation time.	String
updatedBy	Object with information about the employee who edited the issue last.	Map item
checklistDone	Number of checklist items that are marked as done.	Number
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
checklistTotal	Number of checklist items.	Number
votes	Number of votes for the issue.	Number
deadline	Deadline for completing the issue.	String
queue	Object with information about the issue queue.	Map item
updatedAt	Date and time when the issue was last updated.	String
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 item
deadline	Deadline for the checklist item.	Map item
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 Tracker account.	Number

deadline object fields (checklist item)

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

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.

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.

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.

Was the article helpful?

Getting checklist parameters

Deleting a checklist