Deleting an entity
Use this request to delete an entity: a project or project portfolio.
The request is a unified method for deleting projects and portfolios – more flexible and functional than the project deletion API.
Request format
Before making a request, get permission to access the API.
To delete an entity, use an HTTP DELETE request.
DELETE /v2//entities/<entity_type>/<entity_ID>?withBoard=true
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-IDheader is used. - If a Yandex Cloud Organization organization is the only one linked to Tracker, the
X-Cloud-Org-IDheader is used. - If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the
X-Org-IDheader and the Yandex 360 for Business organization ID are used.
- If a Yandex 360 for Business organization is the only one linked to Tracker, the
Resource
| Parameter | Description | Data type |
|---|---|---|
| <entity_type> | Entity type:
|
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 |
|---|---|---|
| withBoard | Delete together with the board | Logical |
Example: Deleting a project
- An HTTP DELETE method is used.
- The project is deleted together with the board.
DELETE /v2/entities/project/655f328da834c763********?withBoard=true HTTP/1.1 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 204.
If the request is processed incorrectly, the API returns a response with an error code:
- 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.