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

Applies to QAComplete 12.90 SaaS & On-Premises, last modified on September 09, 2021

Deletes a note (comment) from an item in QAComplete.

Use the operation to delete a note (comment) from an item in your QAComplete project. To specify a note to delete, use the note’s ID, the ID and entity code of the item to which the note is added, and the ID of your QAComplete project.

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 Update privilege for the entity (Defects, Tests and so on) that contains the note.

Request Format

To delete a note, send a DELETE request to the following URL:

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

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 delete. Possible values:

  • Releases
  • Bugs (defects)
  • FunctionalSpecs (requirements)
  • Tests
  • TestSets
  • TestSteps

EntityId  :  integer, required

The ID of the item (a defect, requirement, and so on), to which the note is added.

Id  :  integer, required

The ID of the note you want to delete.

A sample request:

DELETE http://yourserver.com/rest-api/service/api/v1/projects/11873/Bugs/12/notes/1 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Content-Type: application/json
Accept: application/json, text/script, */*
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==

A sample request made by using cURL:

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

Response Format

On success, the operation returns an empty response with HTTP status code 200.

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