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

Applies to QAComplete 12.92 SaaS, last modified on October 13, 2021

Updates the specified note (comment).

Use the operation to replace the contents of an existing note with new contents in QAComplete.

To add a new note to an item, use the …/notes (POST) 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 Update privilege for the entity (Defects, Tests and so on) that contains the note.

Request Format

To update the note, send a PUT request to the following URL:

http://{server}/rest-api/service/api/v1/projects/{ProjectId}/{EntityCode}/{EntityId}/files/{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 to update. 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 you want to update.

Body parameters

In the request body, pass the RequestNotesPut object that describes the note’s new contents.

{
  "Description": "string",
  "OriginalId": "int",
  "UpdateUserId": "int"
}

The parameters you do not specify are set to their default values.

Description  :  string, required

The note content. Can include HTML markup.

OriginalId  :  integer

If the entity, to which the note belongs, is synchronized with a JIRA item, the OriginalId property specifies the ID of the corresponding comment in JIRA. Default value is 0.

UpdateUserId  :  integer

The ID of the user who last updated the note. Default value is the current user’s ID.

A sample request:

PUT 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
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==
Content-Length: 29

{
  "Description": "Note 1"
}

A sample request made by using cURL:

curl -u john@example.com:p@ssword -d {"Description": "Note 1"} -H "Content-Type: application/json" -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 updated note information.

A sample response:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: 300


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