Operations with Specific Sprint
This resource lets you work with sprints of the specific agile board.
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.
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. |
name | String | Name of the sprint. |
goal | String | Goal of the sprint. |
start | Long | The start date of the sprint as a timestamp. |
finish | Long | The end date of the sprint as a timestamp. |
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. |
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 Specific Sprint
Get settings of the specific sprint of the agile board.
Required permissions
The user must have permissions to read the board.
Request syntax
GET /api/agiles/{agileID}/sprints/{sprintID}?{fields}{sprintID} | Database ID of the sprint. |
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 |
Sample
Sample request URI
https://example.myjetbrains.com/youtrack/api/agiles/108-4/sprints/109-8?fields=id,archived,start,finish,goal,isDefault,name,previousSprint(finish,name,id),unresolvedIssuesCountSample response body
{
"isDefault": false,
"start": 1541372400000,
"unresolvedIssuesCount": 1,
"previousSprint": null,
"archived": false,
"finish": 1542582000000,
"goal": "Prepare the bug-fix release",
"name": "Sprint 3: Bug-fix release",
"id": "109-8",
"$type": "Sprint"
}Delete a Specific Sprint
Delete the specific sprint from agile board.
Required permissions
The user must have permissions to update the board.
Request syntax
DELETE /api/agiles/{agileID}/sprints/{sprintID}{sprintID} | Database ID of the sprint. |
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 |
Update a Specific Sprint
Update the specific sprint of the agile board.
Required permissions
The user must have permissions to update the board.
Request syntax
POST /api/agiles/{agileID}/sprints/{sprintID}?{fields}{sprintID} | Database ID of the sprint. |
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 |
Sample
Sample request URI
https://example.myjetbrains.com/youtrack/api/agiles/108-4/sprints/109-10?fields=id,goal,isDefault,start,finish,name,previousSprint(start,finish,name,id),unresolvedIssuesCountSample request body
{
"goal": "Revise the list of public resources and entities",
"name": "Sprint 5: Public resources revision",
"start": 1569880800000,
"finish": 1572476400000
}Sample response body
{
"isDefault": false,
"start": 1569880800000,
"unresolvedIssuesCount": 0,
"previousSprint": null,
"finish": 1572476400000,
"goal": "Revise the list of public resources and entities",
"name": "Sprint 5: Public resources revision",
"id": "109-10",
"$type": "Sprint"
}