Sprint Groups

This chapter focuses on services for the sprint groups.

get Get all sprints groups

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

HTTP request

Snippet http-request not found for operation::RestSprintGroupControllerIT/browse-sprints-groups

Query parameters

Snippet query-parameters not found for operation::RestSprintGroupControllerIT/browse-sprints-groups

HTTP response

Snippet http-response not found for operation::RestSprintGroupControllerIT/browse-sprints-groups

Response fields

Snippet response-fields not found for operation::RestSprintGroupControllerIT/browse-sprints-groups

Snippet links not found for operation::RestSprintGroupControllerIT/browse-sprints-groups

get Get sprint group

A GET to /sprint-groups/{id} returns the sprint group with the given id.

Path parameters

Table 1. /api/rest/latest/sprint-groups/{id}
Parameter Description

id

the id of the sprint group

HTTP request

GET /api/rest/latest/sprint-groups/123 HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP response

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

{
  "_type" : "sprint-group",
  "id" : 123,
  "name" : "sample sprint group",
  "description" : "sample description",
  "created_by" : "admin",
  "created_on" : "2024-10-02T10:00:00.000+00:00",
  "last_modified_by" : "sample user",
  "last_modified_on" : "2024-10-12T10:00:00.000+00:00",
  "project" : {
    "_type" : "project",
    "id" : 16,
    "name" : "sample project",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/projects/16"
      }
    }
  },
  "path" : "/sample project/sample sprint group",
  "parent" : {
    "_type" : "project",
    "id" : 16,
    "name" : "sample project",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/projects/16"
      }
    }
  },
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/sprint-groups/123"
    },
    "project" : {
      "href" : "http://localhost:8080/api/rest/latest/projects/16"
    }
  }
}

Response fields

Path Type Description

_type

String

the type of this entity

id

Number

the id of this sprint group

name

String

the name of this sprint group

description

String

the description of this sprint group

created_by

String

the user who created this sprint group

created_on

String

the date the sprint group was created

last_modified_by

String

the user who last modified this sprint group

last_modified_on

String

the date the sprint group was last modified

project

Object

the project this sprint group belongs to

path

String

the path of this sprint group

parent

Object

the parent entity of this sprint group

attachments

Array

the attachments of this sprint

_links

Object

related links

Relation Description

self

link to this sprint group

project

link to the project of this sprint group

post Create a sprint group

A POST to /sprint-groups creates a new sprint group.

HTTP request

POST /api/rest/latest/sprint-groups HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 162
Host: localhost:8080

{
  "name" : "New sprint group",
  "description" : "<p>The new sprint group description</p>",
  "parent" : {
    "_type" : "campaign-folder",
    "id" : 846
  }
}

Request fields

Path Type Description

name

String

the name of the sprint group

description

String

the description of the sprint group

parent

Object

the parent entity of the sprint group

HTTP response

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

{
  "_type" : "sprint-group",
  "id" : 1234,
  "name" : "New sprint group",
  "description" : "<p>The new sprint group description</p>",
  "created_by" : "admin",
  "created_on" : "2024-10-02T10:00:00.000+00:00",
  "last_modified_by" : "sample user",
  "last_modified_on" : "2024-10-12T10:00:00.000+00:00",
  "project" : {
    "_type" : "project",
    "id" : 98,
    "name" : "Special project for sprint groups",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/projects/98"
      }
    }
  },
  "path" : "/Special project for sprint groups/New sprint group parent/New sprint group",
  "parent" : {
    "_type" : "campaign-folder",
    "id" : 846,
    "name" : "New sprint group parent",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/campaign-folders/846"
      }
    }
  },
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/sprint-groups/1234"
    }
  }
}

Response fields

Path Type Description

_type

String

the type of this entity

id

Number

the id of the created sprint group

name

String

the name of the created sprint group

description

String

the description of the created sprint group

created_by

String

the user who created this sprint group

created_on

String

the date the sprint group was created

last_modified_by

String

the user who last modified this sprint group

last_modified_on

String

the date the sprint group was last modified

project

Object

the project the created sprint group belongs to

path

String

the path of the created sprint group

parent

Object

the parent entity of the created sprint group

attachments

Array

the attachments of the created sprint group

_links

Object

related links

Relation Description

self

link to this sprint group

patch Modify a sprint group

A PATCH to /sprint-groups/{id} modifies the sprint group with the given id.

HTTP request

PATCH /api/rest/latest/sprint-groups/1234 HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 62
Host: localhost:8080

{
  "name" : "new name",
  "description" : "new description"
}

HTTP response

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

{
  "_type" : "sprint-group",
  "id" : 1234,
  "name" : "New name for my sprint group",
  "description" : "<p>The description has changed</p>",
  "created_by" : "admin",
  "created_on" : "2024-10-02T10:00:00.000+00:00",
  "last_modified_by" : "sample user",
  "last_modified_on" : "2024-10-12T10:00:00.000+00:00",
  "project" : {
    "_type" : "project",
    "id" : 98,
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/projects/98"
      }
    }
  },
  "path" : "/Special project for sprint groups/Sprint group, I am your parent/New name for my sprint group",
  "parent" : {
    "_type" : "campaign-folder",
    "id" : 846,
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/campaign-folders/846"
      }
    }
  },
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/sprint-groups/1234"
    }
  }
}

delete Delete sprint group

A DELETE to /sprint-groups/{ids} deletes one or several sprint-groups with the given ids.

Path parameters

Table 1. /api/rest/latest/sprint-groups/{ids}
Parameter Description

ids

the sprint-group ids to delete

HTTP request

DELETE /api/rest/latest/sprint-groups/123,%20456 HTTP/1.1
Accept: application/json
Host: localhost:8080