YouTrack InCloud 2018.3 Help

Agile Board Rest API

This resource lets you work with agile boards.

Resource

/api/agiles

Returned entity

Agile. For details, see the Supported Fields.

Supported methods

Sub-resources

Supported fields

Field

Type

Description

name

String

Name of an agile board.

owner

User

Owner of the agile board.

visibleFor

UserGroup?

A user group that can view this board is visible for.

visibleForProjectBased

Boolean

When true, the board is visible to everyone who can view all projects that are associated with the board.

updateableBy

UserGroup?

Group of users who can update board settings.

updateableByProjectBased

Boolean

When true, anyone who can update the accosiated projects can update the board.

orphansAtTheTop

Boolean

When true, the orphan swimlane is placed at the top of the board. Otherwise, the orphans swimlane is located below all other swimlanes.

hideOrphansSwimlane

Boolean

When true, the orphans swimlane is not displayed on the board.

estimationField

CustomField

A custom field that is used as the estimation field for the board.

projects

Project

A collection of projects associated with the board.

sprints

Iterable<Sprint>

Collection of existing sprints of the board.

currentSprint

Sprint

A read-only attribute that contains dtata of a sprint that is actual for the current date.

columnSettings

ColumnSettings

Column settings of the board.

swimlaneSettings

SwimlaneSettings?

Settings of the board swimlanes.

sprintsSettings

SprintsSettings

Setting of the board sprints.

colorCoding

ColorCoding?

Color coding settings for the board. The ColorCoding entity is a commot ancestor for two actual entities:

status

AgileStatus

Status of the board.

Get a List of Agile Boards

Get a list of available agile boards. The list depends on the access permissions of the user account that is used to send the request.

Request syntax

GET /api/agiles?{fields}&{$skip}&{$top}

Parameter

Type

Description

fields

string

A list of project attributes that should be returned in the response. If no fields specified, only 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.

For the list of supported fields, see the table in the previous section.

Sample request

curl -X GET \ 'https://example.myjetbrains.com/youtrack/api/agiles?fields=id,name,owner%28id,name,login%29,projects%28id,name%29,sprints%28id,name%29' \ -H 'Accept: application/json' \ -H 'Authorization: Bearer perm:am9obi5kb2U=.UG9zdG1hbiBKb2huIERvZQ==.jJe0eYhhkV271j1lCpfknNYOEakNk7' \ -H 'Cache-Control: no-cache' \ -H 'Content-Type: application/json'

Sample response body

[ { "sprints": [ { "name": "First sprint", "id": "109-0" } ], "projects": [ { "name": "Sandbox", "id": "0-3" } ], "owner": { "login": "root", "name": "John Smith", "id": "1-1" }, "name": "Sandbox Scrum Board", "id": "108-0" } ]

Create a New Agile Board

Create a new agile board.

Request syntax

POST /api/agiles?fields=<string>&template=<string>

Request parameters

Parameter

Type

Description

fields

string

A list of entity attributes that should be returned in the response. If no fields specified, only the entity ID is returned.

template

string

The template parameter accepts a name of agile board template. Supported names:
  • custom: A default agile board template. No predefined settings.

  • scrum: A board with pre-defined parameters for a Scrum process.

  • kanban: A board with pre-defined parameters for a Kanban process.

  • version: A version-based board: sprints are connected to the versions field and swimlanes and tasks are added to the board automatically.

  • personal: A personal board.

To create a new board, you must provide the following mandatory attributes in the request body:

Attribute

Type

Description

name

String

Name of an agile board.

projects

Project

A collection of projects associated with the board.

Sample request

curl -X POST \ 'https://example.myjetbrains.com/youtrack/api/agiles?template=kanban&fields=id,name,owner%28id,name,login%29,projects%28id,name%29,sprints%28id,name%29' \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'cache-control: no-cache' \ -d '{ "name":"Kanban board", "projects":[{"id":"0-0"},{"id":"0-2"}] }'

Sample response body

{ "projects": [ { "name": "Sample Project", "id": "0-0" }, { "name": "Rest Api Project", "id": "0-2" } ], "sprints": [ { "name": "First sprint", "id": "109-3" } ], "owner": { "login": "john.doe", "name": "John Doe", "id": "1-2" }, "name": "Kanban board", "id": "108-3" }
Last modified: 9 November 2018