Exploratory Executions

This chapter focuses on services for exploratory executions. An exploratory execution represents the execution of an exploratory session by an assigned user. It belongs to an exploratory session.

get Get an exploratory execution

A GET to /exploratory-executions/{id} returns the exploratory execution with the given id.

Path parameters

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

id

the id of the exploratory execution

HTTP request

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

HTTP response

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

{
  "_type" : "exploratory-execution",
  "id" : 1,
  "name" : "execution 1",
  "reference" : "REF 1",
  "execution_mode" : "EXPLORATORY",
  "progress_status" : "RUNNING",
  "last_executed_by" : "User 1",
  "last_executed_on" : "2023-11-03T11:00:00.000+00:00",
  "charter" : "this is an Exploratory Test Case Charter",
  "task_division" : "User 1 : Test the buttons, User 2 : test the login form",
  "session_notes" : [ {
    "_type" : "session-note",
    "id" : 1,
    "kind" : "SUGGESTION",
    "content" : "Suggestion 1",
    "_links" : {
      "self" : {
        "href" : "http://localhost:8080/api/rest/latest/session-notes/1"
      }
    }
  } ],
  "reviewed" : true,
  "comment" : "no comment",
  "custom_fields" : [ {
    "code" : "CUF_TXT",
    "label" : "cuf text",
    "value" : "cuf text value"
  }, {
    "code" : "CUF_TXT_2",
    "label" : "cuf text 2",
    "value" : "cuf text value 2"
  } ],
  "test_case_custom_fields" : [ {
    "code" : "TC_CUF_TXT",
    "label" : "tc cuf text",
    "value" : "tc cuf text value"
  }, {
    "code" : "TC_CUF_TXT_2",
    "label" : "tc cuf text 2",
    "value" : "tc cuf text value 2"
  } ],
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/exploratory-executions/1"
    },
    "test_plan_item" : {
      "href" : "http://localhost:8080/api/rest/latest/iteration-test-plan-items/1"
    },
    "project" : {
      "href" : "http://localhost:8080/api/rest/latest/projects/1"
    },
    "exploratory_session" : {
      "href" : "http://localhost:8080/api/rest/latest/exploratory-sessions/1"
    },
    "attachments" : {
      "href" : "http://localhost:8080/api/rest/latest/exploratory-executions/1/attachments"
    },
    "issues" : {
      "href" : "http://localhost:8080/api/rest/latest/exploratory-executions/1/issues"
    }
  }
}

Response fields

Path Type Description

_type

String

the type of the entity

id

Number

the id of the exploratory execution

reference

String

the reference of the exploratory execution

name

String

the name of the exploratory execution

execution_mode

String

the execution mode of the exploratory execution

progress_status

String

the progress status of the exploratory execution

last_executed_by

String

the user who last executed this execution

last_executed_on

String

the date this execution was last executed

charter

String

the charter for the exploratory execution

task_division

String

the task division regarding the exploratory execution

session_notes

Array

the session notes of the exploratory execution. Please refer to the session note documentation for more details.

reviewed

Boolean

whether the exploratory execution has been reviewed

comment

String

any comments added to the exploratory execution

custom_fields

Array

the custom fields for the exploratory session. Please refer to the custom field documentation for more details.

test_case_custom_fields

Array

the custom fields for the referenced test case. Please refer to the custom field documentation for more details.

attachments

Array

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

_links

Object

related links

Relation Description

self

the link to this execution

test_plan_item

the link to its test plan item

project

the link to its project

exploratory_session

the link to its exploratory session

attachments

the link to an execution’s attachments

issues

link to the issues of this exploratory execution

get Get issues of an exploratory execution

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

Path parameters

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

id

the id of the exploratory execution

HTTP request

GET /api/rest/latest/exploratory-executions/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: 622

{
  "_embedded" : {
    "issues" : [ {
      "remoteIssueId" : "165",
      "url" : "http://192.175.1.51/bugzilla/show_bug.cgi?id=165",
      "session-notes" : [ {
        "_type" : "session-note",
        "id" : 1,
        "_links" : {
          "self" : {
            "href" : "http://localhost:8080/api/rest/latest/session-notes/1"
          }
        }
      } ]
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/exploratory-executions/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 execution

_embedded.issues[].remoteIssueId

String

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

_embedded.issues[].url

String

the url of the issue linked to the exploratory execution.

_embedded.issues[].session-notes

Array

the session notes linked to the issue. If the issue is not linked to any session notes, this field will not appear.

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)