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

Deleting a checklist

Written by
Updated at May 6, 2024

The request allows you to delete all checklist items in an entity. The action cannot be undone.

Request format

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

To delete all checklist items, use an HTTP DELETE request.

DELETE /v2/entities/<entity_type>/<entity_ID>/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
<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

Example: Delete all checklist items

  • An HTTP DELETE method is used.
  • All items in the checklist are deleted.
  • The response displays information about the checklist (fields=checklistItems).
DELETE /v2/entities/project/<project_ID>/checklistItems?fields=checklistItems
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

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 entity from which the checklist was deleted.

{
    "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": []
    }
}
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
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
Moving an item
Next
Deleting one item