Sprints

This chapter focuses on services for the sprints.

Endpoints only contain minimal information for this version. More information and endpoints will be available in future versions.

get Get sprint

A GET to /sprints/{id} returns the sprint with the given id.

Path parameters

Table 1. /api/rest/latest/sprints/{id}
Parameter Description

id

the id of the sprint

HTTP request

GET /api/rest/latest/sprints/256 HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 266

{
  "_type" : "sprint",
  "id" : 256,
  "name" : "sample sprint",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/sprints/256"
    },
    "project" : {
      "href" : "http://localhost:8080/api/rest/latest/projects/19"
    }
  }
}

Response fields

Path Type Description

_type

String

the type of this entity

id

Number

the id of this sprint

name

String

the name of this sprint

_links

Object

related links

Relation Description

self

link to this sprint

project

link to the project of this sprint