Sprints

This chapter focuses on services for the sprints.

get Get all sprints

A GET to /sprints returns all the sprints that the user is allowed to read.

HTTP request

GET /api/rest/latest/sprints?size=2&page=0 HTTP/1.1
Accept: application/json
Host: localhost:8080

Query parameters

Parameter Description

page

number of the page to retrieve (optional)

size

size of the page to retrieve (optional)

sort

which attributes of the returned entities should be sorted on (optional)

fields

which fields of the elements should be returned (optional)

type

which type of the element should be returned (optional)

HTTP response

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

{
  "_embedded" : {
    "sprints" : [ {
      "_type" : "sprint",
      "id" : 256,
      "name" : "sample sprint",
      "reference" : "sample reference",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/sprints/256"
        }
      }
    }, {
      "_type" : "sprint",
      "id" : 257,
      "name" : "sample sprint 2",
      "reference" : "sample reference 2",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/sprints/257"
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "http://localhost:8080/api/rest/latest/sprints?page=0&size=2"
    },
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/sprints?page=0&size=2"
    },
    "next" : {
      "href" : "http://localhost:8080/api/rest/latest/sprints?page=1&size=2"
    },
    "last" : {
      "href" : "http://localhost:8080/api/rest/latest/sprints?page=1&size=2"
    }
  },
  "page" : {
    "size" : 2,
    "totalElements" : 4,
    "totalPages" : 2,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.sprints

Array

the list of elements for that page

page.size

Number

the page size for that query

page.totalElements

Number

total number of elements the user is allowed to read

page.totalPages

Number

how many pages can be browsed

page.number

Number

the page number

_links

Object

related links

Relation Description

first

link to the first page (optional)

prev

link to the previous page (optional)

self

link to this page

next

link to the next page (optional)

last

link to the last page (optional)

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: 1396

{
  "_type" : "sprint",
  "id" : 256,
  "name" : "sample sprint",
  "reference" : "my ref",
  "description" : "my description",
  "status" : "OPEN",
  "start_date" : "2025-06-10T10:00:00.000+00:00",
  "end_date" : "2025-06-24T10:00:00.000+00:00",
  "created_by" : "admin",
  "created_on" : "2024-10-01T10:00:00.000+00:00",
  "last_modified_by" : "another user",
  "last_modified_on" : "2025-05-12T10:00:00.000+00:00",
  "project" : {
    "_type" : "project",
    "id" : 19,
    "name" : "the project for sprints",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/projects/19"
      }
    }
  },
  "path" : "/the project for sprints/the sprint group/sample sprint",
  "parent" : {
    "_type" : "sprint-group",
    "id" : 1,
    "name" : "the sprint group",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/sprint-groups/1"
      }
    }
  },
  "sprint_req_versions" : [ {
    "_type" : "sprint-req-version",
    "id" : 247,
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/sprint-req-versions/247"
      }
    }
  } ],
  "is_synchronized" : "false",
  "attachments" : [ ],
  "_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

reference

String

the reference of this sprint

description

String

the description of this sprint

status

String

the status of this sprint

start_date

String

the start date of this sprint

end_date

String

the end date of this sprint

created_by

String

the user who created this sprint

created_on

String

the date the sprint was created

last_modified_by

String

the user who last modified this sprint

last_modified_on

String

the date the sprint was last modified

project

Object

the project this sprint belongs to

path

String

the path of this sprint

parent

Object

the parent entity of this sprint

sprint_req_versions

Array

the sprint requirement versions of this sprint

is_synchronized

String

indicates if the sprint is synchronized (true) or native (false)

attachments

Array

the attachments of this sprint

_links

Object

related links

Relation Description

self

link to this sprint

project

link to the project of this sprint

post Create a sprint

A POST to /sprints creates a new sprint.

HTTP request

POST /api/rest/latest/sprints HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 330
Host: localhost:8080

{
  "name" : "Sprint created by API",
  "reference" : "ABCD",
  "status" : "OPEN",
  "description" : "<p>Sed eget rhoncus sapien. Nam et pulvinar nisi. su Do</p>",
  "start_date" : "2025-05-29T10:00:00.000+00:00",
  "end_date" : "2025-06-13T10:00:00.000+00:00",
  "parent" : {
    "_type" : "campaign-folder",
    "id" : 103
  }
}

Request fields

Path Type Description

name

String

the name of the sprint

reference

String

the reference of the sprint

status

String

the status of the sprint

description

String

the description of the sprint

start_date

String

the start date of the sprint

end_date

String

the end date of the sprint

parent

Object

the parent entity of the sprint

HTTP response

HTTP/1.1 201 Created
Content-Type: application/json
Content-Length: 1162

{
  "_type" : "sprint",
  "id" : 885,
  "name" : "new sprint",
  "reference" : "new ref",
  "description" : "<p>New description</p>",
  "status" : "UPCOMING",
  "start_date" : "2025-05-29T10:00:00.000+00:00",
  "end_date" : "2025-06-13T10:00:00.000+00:00",
  "created_by" : "admin",
  "created_on" : "2024-10-01T10:00:00.000+00:00",
  "last_modified_by" : "another user",
  "last_modified_on" : "2025-05-12T10:00:00.000+00:00",
  "project" : {
    "_type" : "project",
    "id" : 76,
    "name" : "the project for new sprints",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/projects/76"
      }
    }
  },
  "path" : "/the project for new sprints/the parent campaign folder/new sprint",
  "parent" : {
    "_type" : "campaign-folder",
    "id" : 103,
    "name" : "the parent campaign folder",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/campaign-folders/103"
      }
    }
  },
  "sprint_req_versions" : [ ],
  "is_synchronized" : "false",
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/sprints/885"
    }
  }
}

Response fields

Path Type Description

_type

String

the type of the created sprint

id

Number

the id of the created sprint

name

String

the name of the created sprint

reference

String

the reference of the created sprint

description

String

the description of the created sprint

status

String

the status of the created sprint

start_date

String

the start date of the created sprint

end_date

String

the end date of the created sprint

project

Object

the project the created sprint belongs to

parent

Object

the parent entity of the created sprint

created_by

String

the user who created the sprint

created_on

String

the date the sprint was created

last_modified_by

String

the user who last modified the sprint

last_modified_on

String

the date the sprint was last modified

path

String

the path of the created sprint

sprint_req_versions

Array

the sprint requirement versions

is_synchronized

String

indicates if the sprint is synchronized

attachments

Array

the attachments of the sprint

_links

Object

related links

Relation Description

self

the link to the created sprint

patch Modify a sprint

A PATCH to /sprints/{id} modifies the sprint with the given id.

HTTP request

PATCH /api/rest/latest/sprints/762 HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 232
Host: localhost:8080

{
  "name" : "New name",
  "reference" : "New reference",
  "status" : "OPEN",
  "description" : "<p>This is my new description</p>",
  "start_date" : "2025-05-29T10:00:00.000+00:00",
  "end_date" : "2025-06-13T10:00:00.000+00:00"
}

HTTP response

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

{
  "_type" : "sprint",
  "id" : 762,
  "name" : "New name",
  "reference" : "New reference",
  "description" : "<p>This is my new description</p>",
  "status" : "OPEN",
  "start_date" : "2025-05-29T10:00:00.000+00:00",
  "end_date" : "2025-06-13T10:00:00.000+00:00",
  "created_by" : "admin",
  "created_on" : "2024-10-01T10:00:00.000+00:00",
  "last_modified_by" : "another user",
  "last_modified_on" : "2025-05-12T10:00:00.000+00:00",
  "project" : {
    "_type" : "project",
    "id" : 76,
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/projects/76"
      }
    }
  },
  "path" : "/the project for new sprints/the parent campaign folder/New name",
  "parent" : {
    "_type" : "campaign-folder",
    "id" : 108,
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/campaign-folders/108"
      }
    }
  },
  "sprint_req_versions" : [ ],
  "is_synchronized" : "false",
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/sprints/762"
    }
  }
}

delete Delete sprints

A DELETE to /sprints/{ids} deletes one or several sprints with the given ids.

Path parameters

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

ids

the sprint ids to delete

HTTP request

DELETE /api/rest/latest/sprints/44,59 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080