Edit a project
Use this request to update information about a project.
You can also use the new, more flexible and functional updating entity information API that provides a unified method for updating information about projects and portfolios.
Request format
Before making the request, get permission to access the API.
To edit a project, use an HTTP PUT request. Request parameters are provided in the request body in JSON format.
PUT /v2/projects/<project_ID>?version=<version_number>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
{
"queues": "<queue_key>"
}
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 |
|---|---|---|
| <project_ID> | Project ID | Number |
Request parameters
Required parameters
| Parameter | Description | Data type |
|---|---|---|
| version | Project version. Changes are only made to the current version of the project. | Number |
Additional parameters
| Parameter | Description | Data type |
|---|---|---|
| expand | Additional fields to include in the response:
|
String |
Request body parameters
Required parameters
| Parameter | Description | Data type |
|---|---|---|
| queues | Issues to include in the project | String |
Additional parameters
| Parameter | Description | Data type |
|---|---|---|
| name | Project name | String |
| description | Project description. This parameter is not displayed in the Tracker interface. | String |
| lead | ID or username of the project assignee | Number / String |
| status | Stage of the project:
|
String |
| startDate | Project start date in YYYY-MM-DD format |
String |
| endDate | Project end date in YYYY-MM-DD format |
String |
Response format
If the request is successful, the API returns a response with code 200 OK.
The response body contains information about the updated project in JSON format.
{
"self": "https://https://api.tracker.yandex.net/v2/projects/9",
"id": "9",
"version": 5,
"key": "Project",
"name": "Project",
"description": "Project with updates",
"lead": {
"self": "https://https://api.tracker.yandex.net/v2/users/12********",
"id": "12********",
"display": "Full Name"
},
"status": "launched",
"startDate": "2020-11-16",
"endDate": "2020-12-16"
}
Response parameters
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the project. | String |
| id | Project ID. | Number |
| version | Project version. Each change of the parameters increases the version number. | Number |
| key | Project key. Matches the project name. | String |
| name | Project name | String |
| description | Project description. This parameter is not displayed in the Tracker interface. | String |
| lead | Block with information about the project assignee | Object |
| status | Stage of the project:
|
String |
| startDate | Project start date in YYYY-MM-DD format |
String |
| endDate | Project end date in YYYY-MM-DD format |
String |
lead 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 |
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.
- 412
- There was a conflict when editing the object. The error may be due to an invalid update version.
- 428
- Access to the resource is denied. Make sure all required conditions for the request are specified.