Operations with Specific Project
This resource provides access to projects.
Resource | |
|---|---|
Returned entity | Project. For the description of the entity attributes, see Supported Fields section. |
Supported methods |
|
Represents a YouTrack project.
Below you can find the list of resources that let you work with this entity.
Extends IssueFolder
This table describes attributes of the Project entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The database ID of the project. |
archived | Boolean | If the project is currently archived, this property is |
createdBy | The user who created the project. | |
customFields | The set of custom fields that are available in the project. | |
description | String | The description of the project as shown on the project profile page. |
fromEmail | String | The email address that is used to send notifications for the project. If a 'From' address is not set for the project, the default 'From' address for the YouTrack server is returned. |
iconUrl | String | The URL of the icon of the project. |
issues | A list of all issues that belong to the project. | |
leader | The user who is set as the project owner. | |
name | String | The name of the project. |
replyToEmail | String | The email address that is used as the reply email to send notifications for the project. If it is not set for the project, the default address for the YouTrack server is returned. |
shortName | String | The ID of the project. This short name is also a prefix for an issue ID. |
startingNumber | Long | Starting number for issues in project. This property can be set only during creation of the new project. |
team | Read-only user group representing all members of the project team. | |
template | Boolean | If |
Get the settings of the specific project.
Requires permissions: Read Project Basic or Update Project
GET /api/admin/projects/{projectID}?{fields}{projectID} | ID of the project. To identify the project, you can use either its database entity ID or the short name. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Project attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/projects/0-6?fields=id,name,timeTrackingEnabled,shortName,leader(login,name,id),description,createdBy(login,name,id){
"description": "A project created using REST API",
"leader": {
"login": "root",
"name": "John Smith",
"id": "1-1",
"$type": "User"
},
"shortName": "RP",
"createdBy": {
"login": "john.doe",
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
"name": "Rest Project",
"id": "0-6",
"$type": "Project"
}Update settings of a project with a specific ID.
Requires permissions: Update Project
POST /api/admin/projects/{projectID}?{fields}{projectID} | ID of the project. To identify the project, you can use either its database entity ID or the short name. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Project attributes that should be returned in the response. If no field is specified, only the |
https://example.youtrack.cloud/api/admin/projects/0-6?fields=id,name,timeTrackingEnabled,shortName,leader(login,name,id),description,createdBy(login,name,id){
"leader":{"id":"1-1"},
"description":"A project created using REST API"
}{
"description": "A project created using REST API",
"leader": {
"login": "root",
"name": "John Smith",
"id": "1-1",
"$type": "User"
},
"shortName": "RP",
"createdBy": {
"login": "john.doe",
"name": "John Doe",
"id": "1-2",
"$type": "User"
},
"name": "Rest Project",
"id": "0-6",
"$type": "Project"
}Delete a project with specific ID.
DELETE /api/admin/projects/{projectID}{projectID} | ID of the project. To identify the project, you can use either its database entity ID or the short name. |
|---|
Parameter | Type | Description |
|---|---|---|
fields | String | A list of Project attributes that should be returned in the response. If no field is specified, only the |
Identify the target project by its entity ID. For a successful request, server returns 200 OK code and an empty response payload.
https://example.youtrack.cloud/api/admin/projects/0-15