Forum Discussion

aamonto's avatar
aamonto
Occasional Contributor
3 years ago

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

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/qa...
Agile Tasks
LexiAQA's avatar
LexiAQA
SmartBear Alumni (Retired)
3 years ago

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/putapiv1projectsProjectIdEntityCodeEntityIdnotesId

  • aamonto's avatar
    aamonto
    Occasional Contributor
    3 years ago

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