Returns the list of notes (comments) added to the specified item (a defect, requirement and so on) in QAComplete.
Use the operation to get a list of notes (comments) added to the specified item (a defect, requirement and so on). To specify the item whose notes you want to get, use the item’s ID and entity code (item type), as well as the ID of the project to which the item belongs.
In QAComplete, you can view notes on the Notes tab of the needed item.
To get data of an individual note, use the …/notes/{Id} (GET) operation.
Authentication
Basic authentication using a user’s login and password. See Authentication for details.
Security Rights
The authenticating user must belong to a security group that has the Read privilege for the entity (Defects, Tests and so on) that contains the notes.
Request Format
To get information on notes, send a GET request to the following URL:
ProjectId : integer, required
The ID of the project, to which the item belongs.
EntityCode : string, required
The type of the item, whose notes you want to get. Possible values:
- Releases
- Bugs (defects)
- FunctionalSpecs (requirements)
- Tests
- TestSets
- TestSteps
EntityId : integer, required
The ID of the item (a defect, requirement, and so on) that has notes.
offset : integer, default: 0
The number of notes to skip before counting the returned notes. The default value is 0, which is the offset of the first item. For details, see Paging Through Results Using Offset and Limit.
limit : integer, default: 25
The maximum number of notes to return in the response.
A sample request:
GET http://yourserver.com/rest-api/service/api/v1/projects/11873/Bugs/12/notes HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==
A sample request made by using cURL:
curl -u [email protected]:p@ssword -H "Accept: application/json" http://yourserver.com/service/api/v1/projects/11873/Bugs/12/notes
Response Format
On success, the operation responds with HTTP status code 200 and returns a JSON object with the notes information.
A sample response:
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 653
{
"metadata": {
"result_set": {
"count": 2,
"offset": 0,
"limit": 25,
"total": 2
},
"permissions": {
"acl": 7
}
},
"results": [
{
"id": "1",
"date_created": "2015-09-08T01:20:31.4970000",
"date_updated": "2015-09-08T01:20:31.4970000",
"description": "Note 1",
"entity_code": "Bugs",
"fk_id": 12,
"original_id": 0,
"notes_type_code": "Notes",
"seq": 1,
"update_user_id": 25264,
"user_name": "Smith, John"
},
{
"id": "2",
"date_created": "2015-09-09T05:13:39.7100000",
"date_updated": "2015-09-09T05:13:39.7100000",
"description": "Note 2",
"entity_code": "Bugs",
"fk_id": 12,
"original_id": 0,
"notes_type_code": "Notes",
"seq": 2,
"update_user_id": 25264,
"user_name": "Smith, John"
}
]
}
Metadata about the note list.
Pagination information about the note list. (See Paging Through Results Using Offset and Limit).
The number of returned notes.
The offset of the first note requested.
The maximum number of notes requested.
The total number of item’s notes.
The authenticating user’s rights to access notes.
Access rights:
- 0 - None
- 1 - Read
- 2 - Update
- 3 - Read and update
- 4 - Delete
- 5 - Read and delete
- 7 - Full access
An array of notes.
The unique identifier of the note.
The ID of the item (defect, requirement and so on) that contains the note.
The type of the item to which the note belongs:
- Releases
- Bugs (defects)
- FunctionalSpecs (requirements)
- Tests
- TestSets
- TestSteps
The note content. Can include HTML markup.
The date and time when the note was added.
The date and time the note was last updated.
If the entity, to which the note belongs, is synchronized with a JIRA item, the property specifies the ID of the corresponding comment in JIRA.
Reserved.
The note’s index among other notes assigned to the item.
The ID of the last user who updated the note.
The name of the last user who updated the note (in the LastName, FirstName format).
Error responses
If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.
If the project with the specified ProjectId does not exist or the authenticating user does not have rights to access the project, the operation returns the Access is denied error.
If an item with the specified EntityCode or EntityId does not exist, the operation returns the File or directory not found error.