YouTrack InCloud 2019.2 Help

Sprints

This resource lets you work with sprints of the specific agile board.

Resource

/api/agiles/{agileID}/sprints

Returned entity

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

Supported methods

Sprint attributes

Represents a sprint that is associated with an agile board. Each sprint can include issues from one or more projects.

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

agile

Agile

The agile board that the sprint belongs to. Read-only. Can be null.

name

String

Name of the sprint. Can be null.

goal

String

Goal of the sprint. Can be null.

start

Long

The start date of the sprint as a timestamp. Can be null.

finish

Long

The end date of the sprint as a timestamp. Can be null.

archived

Boolean

Indicates whether the sprint is archived.

isDefault

Boolean

If true, then new issues that match a column on this board are automatically added to this sprint.

issues

Array of Issues

Issues that are present on this sprint.

unresolvedIssuesCount

Int

Number of unresolved issues on this sprint. Read-only.

previousSprint

Sprint

If you provide this attribute when you create a new sprint, then all unresolved issues from this sprint will be moved to the newly created sprint.

Read a List of Sprints

Get the list of all sprints of the agile board.

Request syntax

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

Request parameters

Parameter

Type

Description

fields

String

A list of Sprint 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/108-4/sprints?fields=id,name,isDefault,issues(idReadable),goal,start,finish,unresolvedIssuesCount,archived

Sample response body

[ { "issues": [], "isDefault": false, "start": null, "unresolvedIssuesCount": 0, "archived": false, "finish": null, "goal": null, "name": "First sprint", "id": "109-5", "$type": "Sprint" }, { "issues": [ { "idReadable": "SP-35", "$type": "Issue" } ], "isDefault": false, "start": 1540159200000, "unresolvedIssuesCount": 1, "archived": false, "finish": 1541372400000, "goal": "Open most requested resources", "name": "Sprint 2: Add more resources", "id": "109-7", "$type": "Sprint" }, { "issues": [ { "idReadable": "SP-37", "$type": "Issue" } ], "isDefault": false, "start": 1541372400000, "unresolvedIssuesCount": 1, "archived": false, "finish": 1542582000000, "goal": "Prepare the bug-fix release", "name": "Sprint 3: Bug-fix release", "id": "109-8", "$type": "Sprint" }, { "issues": [], "isDefault": false, "start": null, "unresolvedIssuesCount": 0, "archived": false, "finish": null, "goal": "Revise the list of public resources and entities", "name": "Sprint 5: Public resources revision", "id": "109-10", "$type": "Sprint" }, { "issues": [], "isDefault": false, "start": null, "unresolvedIssuesCount": 0, "archived": false, "finish": null, "goal": null, "name": "Sprint 6: Only the name matters", "id": "109-11", "$type": "Sprint" } ]

Add a New Sprint

Create a new sprint for the specified agile board.

Mandatory attributes: name.

Required permissions

THe user must have permissions to update the board.

Request syntax

POST /api/agiles/{agileID}/sprints?{fields}

Request parameters

Parameter

Type

Description

fields

String

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

Sample

Sample request URI

https://example.myjetbrains.com/youtrack/api/agiles/108-4/sprints?fields=id,archived,start,finish,goal,isDefault,name,previousSprint(finish,name,id),unresolvedIssuesCount,issues(id,summary,description,idReadable)

Sample request body

{ "start":1572562800000, "finish":1575068400000, "goal":"Prepare the public BETA release", "name":"Public BETA release", "previousSprint":{"id":"109-10"} }

Sample response body

{ "issues": [], "isDefault": false, "start": 1572562800000, "unresolvedIssuesCount": 0, "previousSprint": null, "archived": false, "finish": 1575068400000, "goal": "Prepare the public BETA release", "name": "Public BETA release", "id": "109-31", "$type": "Sprint" }
Last modified: 18 November 2019