YouTrack Standalone 2019.2 Help

Operations with Specific Project

Resource that provides access to projects.

Resource

/api/admin/projects/{projectID}

Returned entity

Project. For the description of the entity attributes, see Supported Fields section.

Supported methods

Project attributes

Represents a YouTrack project.

Extends IssueFolder

This table describes attributes of the Project entity.

  • To receive an attribute in the response from server, specify it explicitly in the request parameter fields.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

startingNumber

Long

Starting number for issues in project. This property can be set only during creation of the new project.

shortName

String

The ID of the project. This short name is also a prefix for an issue ID. Can be null.

description

String

The description of the project as shown on the project profile page. Can be null.

leader

User

The user who is set as the project lead. Can be null.

createdBy

User

The user who created the project. Can be null.

issues

Array of Issues

A list of all issues that belong to the project.

customFields

Array of ProjectCustomField

The set of custom fields that are available in the project.

archived

Boolean

If the project is currently archived, this property is `true`.

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.

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.

template

Boolean

If true, this project is a template.

iconUrl

String

The URL of the icon of the project. Read-only.

Read a Specific Project

Request syntax

GET /api/admin/projects/{projectID}?{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.

Update a Specific Project

Request syntax

POST /api/admin/projects/{projectID}?{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.

Delete a Specific Project

Delete a project with specific ID.

Request syntax

DELETE /api/admin/projects/{projectID}

Sample

Identify the target project by its entity ID. For a successful request, server returns 200 OK code and an empty response payload.

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/projects/0-15
Last modified: 17 July 2019