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 a session note
A GET
to /session-notes/{id}
returns the session note with the given id.
Path parameters
Parameter | Description |
---|---|
|
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 |
---|---|---|
|
|
the type of the entity |
|
|
the id of the session note |
|
|
the kind of the session note |
|
|
the content of the session note |
|
|
the order of the session note |
|
|
user that created the entity |
|
|
timestamp of the creation (ISO 8601) |
|
|
user that modified the entity the most recently |
|
|
timestamp of last modification (ISO 8601) |
|
|
the attachments of the session note. Please refer to the attachments documentation for more details. |
|
|
related links |
Links
Relation | Description |
---|---|
|
link to this session note |
|
link to the project of this session note |
|
link to the exploratory execution of this session note |
|
link to the attachments of this session note |
|
link to the issues of this session note |
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
Parameter | Description |
---|---|
|
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 |
---|---|
|
number of the page to retrieve (optional) |
|
size of the page to retrieve (optional) |
|
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 |
---|---|---|
|
|
the issues of this session note |
|
|
the remote issue id of the issue linked to the session note. |
|
|
the url of the issue linked to the session note. |
|
|
the page size for that query |
|
|
total number of elements the user is allowed to read |
|
|
how many pages can be browsed |
|
|
the page number |
|
|
related links |
Links
Relation | Description |
---|---|
|
link to the first page (optional) |
|
link to the previous page (optional) |
|
link to this page |
|
link to the next page (optional) |
|
link to the last page (optional) |