GET/projects/{ProjectId}/{EntityCode}/{EntityId}/notes/{Id}

Applies to QAComplete 12.70 SaaS, last modified on January 11, 2021

Gets information on a note from QAComplete.

Use the operation to get information on a note (comment) specified by its ID and by the ID and entity code of the item to which the note is added.

To get a list of all the notes added to an item, use the /projects/{ProjectId}/{EntityCode}/{EntityId}/notes operation.

In QAComplete, you can view notes on the Notes tab of the needed item.

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 note.

Request Format

To get information on a note, send a GET request to the following URL:

http://{server}/rest-api/service/api/v1/projects/{ProjectId}/{EntityCode}/{EntityId}/notes/{Id}

ProjectId  :  integer, required

The ID of the project, to which the item belongs.

EntityCode  :  string, required

The type of the item, whose note 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 the note.

Id  :  integer, required

The ID of the note that you want to get.

A sample request:

GET http://yourserver.com/rest-api/service/api/v1/projects/11873/Bugs/12/notes/1 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==

A sample request made by using cURL:

curl -u john@example.com:p@ssword -H "Accept: application:json" http://yourserver.com/service/api/v1/projects/11873/Bugs/12/notes/1

Response Format

On success, the operation responds with HTTP status code 200 and returns a JSON object with the note information.

A sample response:

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



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

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, or a note with the specified Id does not exist, the operation returns the File or directory not found error.

See Also

Notes (Comments) Resources

Highlight search results