Comment on page
CreateTestcaseNote
This method can be used for the following functionality: Update a testcase on a project that you have Edit access to.
The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.
POST /api/ss/project/:projectId/testcase/:testcaseId/note HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close
projectId (string)
Id of the project.
Example:
POST /api/ss/project/5e7c29afa3362408cf502a11/testcase/:testcaseId/note HTTP/1.1
assetId (string)
Id of the testcase.
Example:
POST /api/ss/project/:projectId/testcase/5e7c29afa3362408cf502a18/note HTTP/1.1
note (string)
Testcase note.
Example:
{
"note": "Functionality was not working."
}
note_type (string)
Must be either PLAINTEXT or RICHTEXT. Defaults to PLAINTEXT if not specified.
Example:
{
"note_type": "RICHTEXT"
}
The following example is a cURL request to create a note on a testcase for a project.
Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
curl -X POST 'https://demo.attackforge.com/api/ss/project/5e7c29afa3362408cf502a11/testcase/5e7c29afa3362408cf502a18/note' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close' -d '{
"note": "Functionality was not working."
}'
Response contains a status.
{
"status": "Testcase Note Created"
}
Last modified 2mo ago