YouTrack InCloud 2019.1 Help

Sprints

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 provided during creation of a new sprint, then all unresolved issues from this sprint will be moved to the newly created sprint.

Read a List of Sprints

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.

Add a New Sprint

Creates new sprint. Sprint name must be provided.

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.

Last modified: 17 May 2019