Issue Sprints
This resource lets you work with the sprints where the issue belongs.
Resource | |
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.
Related Resources
Below you can find the list of resources that let you work with this entity.
Attributes
This table describes attributes of the Sprint entity.
To receive an attribute in the response from the server, specify it explicitly in the
fieldsrequest parameter.To update an attribute, provide it in the body of a POST request.
Field | Type | Description |
|---|---|---|
id | String | The ID of the sprint. |
agile | Agile | The agile board that the sprint belongs to. |
name | String | Name of the sprint. |
goal | String | Goal of the sprint. |
start | Long | The timestamp in milliseconds indicating the start date of the sprint. Stored as a unix timestamp at UTC. |
finish | Long | The timestamp in milliseconds indicating the end date of the sprint. Stored as a unix timestamp at UTC. |
archived | Boolean | Indicates whether the sprint is archived. |
isDefault | Boolean | If |
issues | Array of Issues | Issues that are present on this sprint. |
unresolvedIssuesCount | Int | Number of unresolved issues on this sprint. |
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 sprints where the issue belongs.
Request syntax
GET /api/issues/{issueID}/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 |
$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. If you don't set the $top value, the server limits the maximum number of returned entries. The server returns a maximum of 42 entries for most resources that return collections. For more information, see Pagination. |
Sample
Sample request
https://example.youtrack.cloud/api/issues/NP-113/sprints?fields=id,agile(id,name),name,goal,start,finish,archivedSample response body
[
{
"start": null,
"archived": false,
"agile": {
"name": "The product board",
"id": "87-72",
"$type": "Agile"
},
"goal": "Develop the features",
"finish": null,
"name": "Sprint 134",
"id": "91-703",
"$type": "Sprint"
},
{
"start": null,
"archived": false,
"agile": {
"name": "The marketing board",
"id": "87-159",
"$type": "Agile"
},
"goal": "Maintain the marketing materials",
"finish": null,
"name": "Q3",
"id": "91-1317",
"$type": "Sprint"
},
{
"start": null,
"archived": false,
"agile": {
"name": "Outsource",
"id": "87-91",
"$type": "Agile"
},
"goal": "Track the freelancers' effort",
"finish": null,
"name": "October",
"id": "91-1325",
"$type": "Sprint"
}
]