Contact UsGet started
© 2024 Direct Cursus Technology L.L.C.

Deleting a checklist

Written by
Updated at February 19, 2024

Use this request to delete a checklist from an issue.

Request format

To delete a checklist from an issue, use an HTTP DELETE request:

DELETE /v2/issues/<issue_ID_or_key>/checklistItems
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
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
<issue_ID_or_key> 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 a JSON object with the parameters of the issue to delete the checklist from.

{
    "self": "https://https://api.tracker.yandex.net/v2/issues/ORG-3",
    "id": "5f981c00b982f075********",
    "key": "ORG-3",
    "version": 147,
    "lastCommentUpdatedAt": "2020-12-13T13:18:22.965+0000",
    "pendingReplyFrom": [
        {
            "self": "https://https://api.tracker.yandex.net/v2/users/12********",
            "id": "12********",
            "display": "Full Name"
        }
    ],
    "summary": "Issue name",
    "statusStartTime": "2020-11-03T11:19:24.733+0000",
    "updatedBy": {
        "self": "https://https://api.tracker.yandex.net/v2/users/19********",
        "id": "19********",
        "display": "Full Name"
    },
    "checklistDone": "0",
    "description": "Issue description",
    "type": {
        "self": "https://https://api.tracker.yandex.net/v2/issuetypes/2",
        "id": "2",
        "key": "task",
        "display": "Issue"
    },
    "priority": {
        "self": "https://https://api.tracker.yandex.net/v2/priorities/3",
        "id": "3",
        "key": "normal",
        "display": "Normal"
    },
    "previousStatusLastAssignee": {
        "self": "https://https://api.tracker.yandex.net/v2/users/12********",
        "id": "12********",
        "display": "Full Name"
    },
    "createdAt": "2020-10-27T13:09:20.085+0000",
    "followers": [
        {
            "self": "https://https://api.tracker.yandex.net/v2/users/19********",
            "id": "19********",
            "display": "Full Name"
        }
    ],
    "createdBy": {
        "self": "https://https://api.tracker.yandex.net/v2/users/12********",
        "id": "12********",
        "display": "Full Name"
    },
   "checklistTotal": 4,
   "votes": 0,
   "assignee": {
        "self": "https://https://api.tracker.yandex.net/v2/users/12********",
        "id": "12********",
        "display": "Full Name"
    },
   "deadline": "2020-10-28",
   "queue": {
        "self": "https://https://api.tracker.yandex.net/v2/queues/ORG",
        "id": "1",
        "key": "ORG",
        "display": "Startrek"
    },
   "updatedAt": "2021-02-16T08:28:41.095+0000",
   "status": {
        "self": "https://https://api.tracker.yandex.net/v2/statuses/2",
        "id": "2",
        "key": "needInfo",
        "display": "Need info"
    },
    "previousStatus": {
        "self": "https://https://api.tracker.yandex.net/v2/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. Number
key Issue key. String
version Issue version. Each change of the parameters increases the version number. Number
lastCommentUpdatedAt Last comment's update time. String
pendingReplyFrom Object with information about the employee whose response is awaited. Object
summary Issue name. String
statusStartTime Issue creation time. String
updatedBy Object with information about the employee who edited the issue last. Object
checklistDone Number of checklist items that are marked as done. Number
description Issue description. String
type Object with information about the issue type. Object
priority Object with information about the priority. Object
previousStatusLastAssignee Object with information about the assignee of the issue in the previous status. Object
createdAt Issue creation date and time. String
followers Array of objects with information about issue followers. Object
createdBy Object with information about the user who created the issue. Object
checklistTotal Number of checklist items. Number
votes Number of votes for the issue. Number
assignee Object with information about the issue's assignee. Object
deadline Deadline for completing the issue. String
queue Object with information about the issue queue. Object
updatedAt Date and time when the issue was last updated. String
status Object with information about the issue status. Object
previousStatus Object with information about the previous status of the issue. Object
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. Number
display Displayed user name. String

pendingReplyFrom 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

type object fields

Parameter Description Data type
self Link to 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 Link to the priority type. 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. Number
display Displayed user name. String

followers 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

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

assignee 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

queue object fields

Parameter Description Data type
self Queue link. String
id Queue ID. Number
key Queue key. String
display Queue name displayed. String

status object fields

Parameter Description Data type
self Status link. String
id Status ID. String
key Status key. String
display Status name displayed. String

previousStatus object fields

Parameter Description Data type
self Status link. 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 isn't authorized. Make sure to perform the actions described in API access.
403
Insufficient rights 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
Editing a checklist
Next
Deleting a checklist item