YouTrack Standalone 2019.2 Help

Projects

Resource that provides access to projects.

Resource

/api/admin/projects

Returned entity

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

Supported methods

Supported sub-resources

  • /api/admin/projects/{projectID}: Operations with Specific Project

  • /api/admin/projects/{projectID}/issues: Issues

  • /api/admin/projects/{projectID}/customFields: Project Custom Fields

  • /api/admin/projects/{projectID}/timeTrackingSettings: Project Time Tracking Settings

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 List of Projects

Get a list of all available projects in the system.

Request syntax

GET /api/admin/projects?{fields}&{$top}&{$skip}

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.

$skip

Int

Optional. Lets you set a number of returned entities to skip before returning the first one.

$top

Int

Optional. Lets you specify the maximum number of entries that are returned in the response.

Add a New Project

When creating a new project, you must provide project's name, short name, and the project leader. Other attributes are optional. To create a project that is based on a template, like Scrum or Kanban, you need to add template query parameter to the endpoint URL.

Request syntax

POST /api/admin/projects?{fields}&{template}

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.

template

String

Optional. Lets you specify the template to use for the new project. Possible values: scrum, kanban.If template is not specified, then the new project will use the default settings.

Sample 1

This sample shows a minimal viable request to create a new project.

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/projects?fields=id,shortName,name,leader(id,login,name)

Sample request body

{ "name": "New Project", "shortName": "NP", "leader":{ "id":"1-2" } }

Sample response body

{ "shortName": "NP", "leader": { "login": "john.doe", "name": "John Doe", "id": "1-2", "$type": "User" }, "name": "New Project", "id": "0-16", "$type": "Project" }

Sample 2

This sample shows a request to create a new project with the Scrum template.

Sample request URI

https://example.myjetbrains.com/youtrack/api/admin/projects?fields=id,shortName,name,leader(id,login,name)&template=scrum

Sample request body

{ "description": "A new project created with the Scrum template", "name": "New Scrum Project", "shortName": "NSCP", "leader":{ "id":"1-2" } }
Last modified: 17 July 2019