Sprint Requirement Versions

This chapter focuses on services for the sprint requirement versions.

get Get sprint requirement version

A GET to /sprint-req-versions/{id} returns the sprint-req-version with the given id.

If the sprint requirement version is native (see its mode), the fields name, reference, description, status, criticality and category are pulled from the related requirement version.

If the sprint requirement version is synchronized, those fields have a value corresponding to the remote element last synchronization.

Get a sprint requirement version

Path parameters

Snippet path-parameters not found for operation::RestSprintReqVersionControllerIT/get-sprint-req-version

HTTP request
GET /api/rest/latest/sprint-req-versions/456 HTTP/1.1
Accept: application/json
Host: localhost:8080

Get a native sprint requirement version

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

{
  "_type" : "sprint-req-version",
  "id" : 456,
  "name" : "native requirement version",
  "reference" : "native reference",
  "description" : "native description",
  "status" : "UNDER_REVIEW",
  "criticality" : "MINOR",
  "category" : "CAT_USER_STORY",
  "validation_status" : "TO_BE_TESTED",
  "created_by" : "admin",
  "created_on" : "2024-10-01T10:00:00.000+00:00",
  "last_modified_by" : "sample user",
  "last_modified_on" : "2017-05-12T10:00:00.000+00:00",
  "requirement_version" : {
    "_type" : "requirement-version",
    "id" : 789,
    "name" : "native requirement version",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/requirement-versions/789"
      }
    }
  },
  "sprint" : {
    "_type" : "sprint",
    "id" : 123,
    "name" : "native sprint",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/sprints/123"
      }
    }
  },
  "mode" : "NATIVE",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/sprint-req-versions/456"
    },
    "sprint" : {
      "href" : "http://localhost:8080/api/rest/latest/sprints/123"
    }
  }
}

Get a synchronized sprint requirement version

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

{
  "_type" : "sprint-req-version",
  "id" : 456,
  "name" : "synchronized requirement version",
  "reference" : "synchronized reference",
  "description" : "synchronized description",
  "status" : "",
  "criticality" : "",
  "category" : "",
  "validation_status" : "TO_BE_TESTED",
  "created_by" : "admin",
  "created_on" : "2024-10-01T10:00:00.000+00:00",
  "last_modified_by" : "sample user",
  "last_modified_on" : "2017-05-12T10:00:00.000+00:00",
  "requirement_version" : {
    "_type" : "requirement-version",
    "id" : 789,
    "name" : "synchronized requirement version",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/requirement-versions/789"
      }
    }
  },
  "sprint" : {
    "_type" : "sprint",
    "id" : 123,
    "name" : "synchronized sprint",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/sprints/123"
      }
    }
  },
  "mode" : "SYNCHRONIZED",
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/sprint-req-versions/456"
    },
    "sprint" : {
      "href" : "http://localhost:8080/api/rest/latest/sprints/123"
    }
  }
}
Response fields
Path Type Description

_type

String

the type of this entity

id

Number

the id of this sprint requirement version

name

String

the name of this sprint requirement version. Null if mode is NATIVE

reference

String

the reference of this sprint requirement version. Null if mode is NATIVE

description

String

the description of this sprint requirement version. Null if mode is NATIVE

status

String

the status of this sprint requirement version. Null if mode is NATIVE

criticality

String

the criticality of this sprint requirement version. Null if mode is NATIVE

category

String

the category of this sprint requirement version. Null if mode is NATIVE

validation_status

String

the validation status of this sprint requirement version

created_by

String

the user who created this sprint requirement version

created_on

String

the date the sprint requirement version was created

last_modified_by

String

the user who last modified the sprint requirement version

last_modified_on

String

the date the sprint requirement version was last modified

requirement_version

Object

the related requirement version (if there is one)

sprint

Object

the sprint which this sprint requirement version belongs to

mode

String

native or synchronized

_links

Object

related links

Relation Description

self

link to this sprint requirement version

sprint

link to the related sprint