Session Notes

This chapter focuses on services for session notes. A session note is a type of note left by a user during an exploratory execution. There are different kinds of notes: comments, questions, suggestions…​

get Get a session note

A GET to /session-notes/{id} returns the session note with the given id.

Path parameters

Table 1. /api/rest/latest/session-notes/{id}
Parameter Description

id

the id of the session note

HTTP request

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

HTTP response

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

{
  "_type" : "session-note",
  "id" : 1,
  "kind" : "SUGGESTION",
  "content" : "Suggestion 1",
  "note_order" : 0,
  "created_by" : "admin",
  "created_on" : "2017-07-24T10:00:00.000+00:00",
  "last_modified_by" : "User 1",
  "last_modified_on" : "2023-07-25T10:00:00.000+00:00",
  "attachments" : [ ],
  "_links" : {
    "self" : {
      "href" : "http://localhost:8080/api/rest/latest/session-notes/1"
    },
    "project" : {
      "href" : "http://localhost:8080/api/rest/latest/projects/1"
    },
    "exploratory_execution" : {
      "href" : "http://localhost:8080/api/rest/latest/exploratory-executions/1"
    },
    "attachments" : {
      "href" : "http://localhost:8080/api/rest/latest/session-notes/1/attachments"
    },
    "issues" : {
      "href" : "http://localhost:8080/api/rest/latest/session-notes/1/issues"
    }
  }
}

Response fields

Path Type Description

_type

String

the type of the entity

id

Number

the id of the session note

kind

String

the kind of the session note

content

String

the content of the session note

note_order

Number

the order of the session note

created_by

String

user that created the entity

created_on

String

timestamp of the creation (ISO 8601)

last_modified_by

String

user that modified the entity the most recently

last_modified_on

String

timestamp of last modification (ISO 8601)

attachments

Array

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

_links

Object

related links

Relation Description

self

link to this session note

project

link to the project of this session note

exploratory_execution

link to the exploratory execution of this session note

attachments

link to the attachments of this session note

issues

link to the issues of this session note

get Get issues of a session note

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

Path parameters

Table 1. /api/rest/latest/session-notes/{id}/issues
Parameter Description

id

the id of the session note

HTTP request

GET /api/rest/latest/session-notes/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: 381

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

_embedded.issues[].remoteIssueId

String

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

_embedded.issues[].url

String

the url of the issue linked to the session note.

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)