How can I add and update a note for an existing Agile Task using QAC API's?

[aamonto]

Hello,

Is there a way to add and update a note for an existing Agile Task using QAC API's? I already tried with the API request that is in the documentation site (https://support.smartbear.com/qacomplete/docs/developer/api/rest/api/reference/agile-tasks/id-patch....) but it is not working, in fact I can update other fields as "pct_complete" but when I tried to update an existing note by changing value for the "notes_description" field, it is not working; I am getting a 200 OK in the response of the PATCH method and I am also able to see the latest information of the Agile Task but the note isn't updated.

I also tried to add a new note by updating the "nbr_notes" field to the next consecutive number but it's the same case with the "notes_description" field, I just get the 200 OK response but nothing changes

[LexiAQA · Accepted solution]

Hi,

There is a special API section for handling notes:

https://support.smartbear.com/qacomplete/docs/developer/api/rest/api/reference/notes/index.html

To update a note, you can use the PUT/projects/{ProjectId}/{EntityCode}/{EntityId}/notes/{Id} method.

You can check how this method works via the Swagger UI:

https://app.qacomplete.smartbear.com/rest-api/swagger/index.html#!/api/putapiv1projectsProjectIdEnti...

[aamonto]

I already tried with the proposed solution and it worked. Thank you for you help!!!!

For those that want to add/update notes for Agile Tasks you can use the POST and PUT Method but using the EntityCode as ProjectTasks, for example this will be an example for GET and POST Methods:

GET 

https://rest.qacomplete.smartbear.com/rest-api/service/api/v1/projects/<projectID>/ProjectTasks/<agileTaskID>/notes 

POST

https://rest.qacomplete.smartbear.com/rest-api/service/api/v1/projects/<projectID>/ProjectTasks/<agileTaskID>/notes 

Request's Body

{
"Description": "Note 1"
}