Issue Project

This resource lets you read the project where the issue belongs, and move the issue to another project.

Resource	/api/issues/{issueID}/project
Returned entity	Project. For the description of the entity attributes, see Supported Fields section.
Supported methods	`GET`: Issue Project. `POST`: Issue Project.

Project attributes

Represents a YouTrack project.

Related Resources

Below you can find the list of resources that let you work with this entity.

Extends IssueFolder

Attributes

This table describes attributes of the Project entity.

To receive an attribute in the response from the server, specify it explicitly in the fields request 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. `Read-only`.
archived	Boolean	If the project is currently archived, this property is `true`.
createdBy	User	The user who created the project. `Can be null`.
customFields	ProjectCustomField	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. `Can be null`.
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. `Read-only`. `Can be null`.
issues	Array of Issues	A list of all issues that belong to the project.
leader	User	The user who is set as the project owner. `Can be null`.
name	String	The name of the project. `Can be null`.
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. `Can be null`.
shortName	String	The ID of the project. This short name is also a prefix for an issue ID. `Can be null`.
startingNumber	Long	Starting number for issues in project. This property can be set only during creation of the new project.
team	UserGroup	Read-only user group representing all members of the project team. `Read-only`.
template	Boolean	If `true`, this project is a template.

Read the Project of an Issue

Get the project to which the issue belongs.

Request syntax

GET /api/issues/{issueID}/project?{fields}

Request parameters

Parameter	Type	Description
fields	String	A list of Project attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.

Sample

Sample request

https://example.youtrack.cloud/api/issues/SP-8/project?fields=id,name,shortName

Sample response body

                {
                  "shortName": "SP",
                  "name": "Sample Project",
                  "id": "0-0",
                  "$type": "Project"
                }
            

Move Issue to Another Project

Change the project of the issue. That is, move the issue to another project.

Request syntax

POST /api/issues/{issueID}/project?{fields}&{muteUpdateNotifications}

Request parameters

Parameter	Type	Description
fields	String	A list of Project attributes that should be returned in the response. If no field is specified, only the `entityID` is returned.
muteUpdateNotifications	Boolean	Set this parameter to `true` if no notifications should be sent on changes made by this request. This doesn't mute notifications sent by any workflow rules. Using this parameter requires Apply Commands Silently permission in all projects affected by the request. Available since 2021.3.

Sample

To move the issue to another project, you must provide the database ID of the target project in the request payload.

Sample request

https://example.youtrack.cloud/api/issues/SP-8/project?fields=id,name,shortName

Sample request body

{"id":"0-14"}

Sample response body

                {
                  "shortName": "KNBN",
                  "name": "Another Kanban project from REST",
                  "id": "0-14",
                  "$type": "Project"
                }
            

Last modified: 7 November 2024