Create a project
Written by
Use this request to create projects.
Request format
Before making the request, get permission to access the API.
To create a project, use an HTTP POST request. Request parameters are passed in the request body in JSON format.
POST /v2/projects/
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth token>
X-Org-ID: <organization ID>
{
"name: "Project name",
"queues": "<queue key>"
}
Headers
-
Host
Address of the node that provides the API:
https://api.tracker.yandex.net -
Authorization
OAuth token in
OAuth <token value>format. For example:OAuth 0c4181a7c2cf4521964a72ff57a34a07 -
X-Org-ID
Organization ID.
Request body parameters
The request body contains the information required to create a new project:
Required parameters
| Parameter | Description | Data type |
|---|---|---|
| name | Project name. | String |
| queues | Issues to include in the project. | String |
Additional parameters
| Parameter | Description | Data type |
|---|---|---|
| description | Project description. This parameter isn't displayed in the Tracker interface. | String |
| lead | ID or username of the project assignee. | Number / String |
| status | Stage of the project:
IN_PROGRESS: In progress. |
String |
| startDate | Project start date in YYYY-MM-DD format. |
String |
| endDate | Project end date in YYYY-MM-DD format. |
String |
Response format
Successful execution of the request
The request failed
If the request is successful, the API returns a response with code 201 Created.
The response body contains information about the created project in JSON format.
{
"self": "https://api.tracker.yandex.net/v2/projects/9",
"id": "9",
"version": 1,
"key": "Project",
"name": "Project",
"description": "New project",
"lead": {
"self": "https://api.tracker.yandex.net/v2/users/12314567890",
"id": "1234567890",
"display": "First and Last 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 isn't 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 |
Object fields lead
| Parameter | Description | Data type |
|---|---|---|
| self | Address of the API resource with information about the user. | String |
| id | User ID. | Number |
| display | User's 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.
- 409
- There was a conflict when editing the object. The error may be due to an invalid update version.