YouTrack InCloud 2019.2 Help

Agiles

This resource lets you work with agile boards in YouTrack using the REST API.

Resource

/api/agiles

Returned entity

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

Supported methods

Supported sub-resources

Agile attributes

Represents an agile board configuration.

This table describes attributes of the Agile 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

name

String

The name of the agile board. Can be null.

owner

User

Owner of the agile board. Can be null.

visibleFor

UserGroup

The user group that can view this board. Can be null.

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. Can be null.

updateableByProjectBased

Boolean

When true, anyone who can update the associated 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. Can be null.

projects

Array of Projects

A collection of projects associated with the board.

sprints

Array of Sprints

The set of sprints that are associated with the board.

currentSprint

Sprint

A sprint that is actual for the current date. Read-only. Can be null.

columnSettings

ColumnSettings

Column settings of the board. Read-only.

swimlaneSettings

SwimlaneSettings

Settings of the board swimlanes. Can be null.

sprintsSettings

SprintsSettings

Settings of the board sprints. Read-only.

colorCoding

ColorCoding

Color coding settings for the board. Can be null.

status

AgileStatus

Status of the board. Read-only.

Read a List of Agiles

Get the list of all available agile boards in the system.

Request syntax

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

Request parameters

Parameter

Type

Description

fields

String

A list of Agile 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.

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/agiles?fields=id,name,owner(id,name),projects(id,name),sprints(id,name)&$top=3

Sample response body

[ { "owner": { "name": "John Smith", "id": "1-1", "$type": "User" }, "projects": [ { "name": "Sandbox", "id": "0-3", "$type": "Project" } ], "sprints": [ { "name": "First sprint", "id": "109-0", "$type": "Sprint" } ], "name": "Sandbox Scrum Board", "id": "108-0", "$type": "Agile" }, { "owner": { "name": "John Doe", "id": "1-2", "$type": "User" }, "projects": [ { "name": "GRA Project", "id": "0-7", "$type": "Project" } ], "sprints": [ { "name": "First sprint", "id": "109-1", "$type": "Sprint" } ], "name": "GRA Project", "id": "108-1", "$type": "Agile" }, { "owner": { "name": "John Doe", "id": "1-2", "$type": "User" }, "projects": [ { "name": "Sample Project", "id": "0-0", "$type": "Project" }, { "name": "Rest Api Project", "id": "0-2", "$type": "Project" } ], "sprints": [ { "name": "First sprint", "id": "109-3", "$type": "Sprint" } ], "name": "Kanban board", "id": "108-3", "$type": "Agile" } ]

Add a New Agile

Create a new agile board.

Mandatory attributes: name and projects.

Request syntax

POST /api/agiles?{fields}&{template}

Request parameters

Parameter

Type

Description

fields

String

A list of Agile attributes that should be returned in the response. If no field is specified,only the entityID is returned

template

String

The name of the board template that should be used. Possible values: kanban, scrum, version, custom, personal.

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/agiles?template=kanban&fields=id,name,owner(id,name),projects(id,name),sprints(id,name)

Sample request body

{ "name":"Kanban board", "projects":[{"id":"0-0"},{"id":"0-2"}], "updateableByProjectBased":true, "visibleForProjectBased":true }

Sample response body

{ "owner": { "name": "John Doe", "id": "1-2", "$type": "User" }, "projects": [ { "name": "Sample Project", "id": "0-0", "$type": "Project" }, { "name": "Rest Api Project", "id": "0-2", "$type": "Project" } ], "sprints": [ { "name": "First sprint", "id": "109-30", "$type": "Sprint" } ], "name": "Kanban board", "id": "108-23", "$type": "Agile" }
Last modified: 15 November 2019