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: 739

{
  "_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"
    }
  }
}

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