StarterTemplate ASP.NET Host

<back to all web services

RequestNotesById

The following routes are available for this service:
GET/service/api/v1/projects/{ProjectId}/{EntityCode}/{EntityId}/notes/{Id}Returns the note (comment) added to an itemThe authenticating user must have the Read privilege for the entity (Defects, Tests and so on) that contains the note.
Parameters:
NameParameterData TypeRequiredDescription
ProjectIdpathintYesThe ID of the project that contains the item
EntityCodepathstringYesThe type of the item that has the note
EntityIdpathintYesThe ID of the item that has the note
IdpathintYesThe ID of the note you need to get

To override the Content-type in your clients HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/RequestNotesById HTTP/1.1 
Host: rest.qacomplete.smartbear.com 
Content-Type: application/json
Content-Length: length

{"project_id":0,"entity_code":"String","entity_id":0,"id":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"id":0,"entity_id":0,"entity_code":"String","description":"String","date_created":"0001-01-01T00:00:00.0000000","date_updated":"0001-01-01T00:00:00.0000000","original_id":0,"seq":0,"update_user_id":0,"user_name":"String"}