Exploratory Sessions

This chapter focuses on services for exploratory sessions. An exploratory session represents an overview of the execution for an exploratory test case that has been planned in an iteration test plan. It belongs to an iteration test plan, and binds together the test case to execute with the assigned users and the execution.

Please note that executions located in sprints are not handled for now. They will be in a future version.

get Get an exploratory session

A GET to /exploratory-sessions/{id} returns the exploratory session with the given id.

Path parameters

Table 1. /api/rest/latest/exploratory-sessions/{id}
Parameter Description

id

the id of the exploratory session

HTTP request

GET /api/rest/latest/exploratory-sessions/1 HTTP/1.1
Accept: application/json
Host: localhost:8080

HTTP response

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

{
  "_type" : "exploratory-session-overview",
  "id" : 1,
  "name" : "session 1",
  "reference" : "REF 1",
  "due_date" : "2023-01-01T11:00:00.000+00:00",
  "session_duration" : 30,
  "session_status" : "FINISHED",
  "comments" : "",
  "charter" : "this is an Exploratory Test Case Charter",
  "iteration_test_plan_item" : {
    "_type" : "iteration-test-plan-item",
    "id" : 1,
    "execution_status" : "SUCCESS",
    "created_by" : "admin",
    "created_on" : "2017-07-12T10:00:00.000+00:00",
    "last_modified_by" : "admin",
    "last_modified_on" : "2017-07-12T10:00:00.000+00:00",
    "executions" : [ {
      "_type" : "exploratory-execution",
      "id" : 1,
      "last_executed_on" : "2023-11-03T11:00:00.000+00:00",
      "task_division" : "User 1 : Test the buttons, User 2 : test the login form",
      "reviewed" : false,
      "assignee_user" : "User 1",
      "_links" : {
        "self" : {
          "href" : "http://localhost:8080/api/rest/latest/exploratory-executions/1"
        }
      }
    } ],
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/1"
      }
    }
  },
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/exploratory-sessions/1"
    },
    "project" : {
      "href" : "http://localhost:8080/api/rest/latest/projects/1"
    },
    "iteration" : {
      "href" : "http://localhost:8080/api/rest/latest/iterations/1"
    },
    "issues" : {
      "href" : "http://localhost:8080/api/rest/latest/exploratory-sessions/1/issues"
    }
  }
}

Response fields

Path Type Description

_type

String

the type of the entity

id

Number

the id of the exploratory session

reference

String

the reference of the exploratory session

name

String

the name of the exploratory session

due_date

String

the due date of the exploratory session

session_duration

Number

the session duration of the exploratory session

session_status

String

the session status of the exploratory session

comments

String

the comments of the exploratory session

charter

String

the charter of the exploratory session

iteration_test_plan_item

Object

the iteration test plan item of the exploratory session. Please refer to the iteration test plan item documentation for more details.

iteration_test_plan_item.executions

Array

the exploratory executions of the iteration test plan item. Please refer to the exploratory executions documentation for more details.

attachments

Array

the attachments of the exploratory session. Please refer to the attachments documentation for more details.

_links

Object

related links

Links

Relation Description

self

link to this exploratory session

project

link to the project of this exploratory session

iteration

link to the iteration of this exploratory session

issues

link to the issues of this exploratory session

get Get issues of an exploratory session

A GET to /exploratory-sessions/{id}/issues returns all the issues of the exploratory session with the given id.

Path parameters

Table 1. /api/rest/latest/exploratory-sessions/{id}/issues
Parameter Description

id

the id of the exploratory session

HTTP request

GET /api/rest/latest/exploratory-sessions/1/issues HTTP/1.1
Accept: application/json
Host: localhost:8080

Request parameters

Parameter Description

page

number of the page to retrieve (optional)

size

size of the page to retrieve (optional)

fields

which fields of the elements should be returned (optional)

HTTP response

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

{
  "_embedded" : {
    "issues" : [ {
      "remoteIssueId" : "165",
      "url" : "http://192.175.1.51/bugzilla/show_bug.cgi?id=165",
      "exploratory-executions" : [ {
        "_type" : "exploratory-execution",
        "id" : 1,
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/exploratory-executions/1"
          }
        }
      } ]
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/exploratory-sessions/1/issues?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 0
  }
}

Response fields

Path Type Description

_embedded.issues

Array

the issues of this exploratory session.

_embedded.issues[].remoteIssueId

String

the remote issue id of the issue linked to the exploratory session.

_embedded.issues[].url

String

the url of the issue linked to the exploratory session.

_embedded.issues[].exploratory-executions

Array

the exploratory executions linked to the issue.

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

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)