GetProjectTestcasesById

This method can be used for the following functionality: Get all testcases for a project you have access to, by project identifier (Id).

Parameters

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.

Headers

GET /api/ss/project/:id/testcases HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

id (string)

Identifier for the project.

Example:

GET /api/ss/project/5e64179c899bb708b55ea48c/testcases HTTP/1.1

status (string) (optional)

Test case status. Must be one of the following: Tested, Not-Tested, In-Progress, Not-Applicable

Example:

GET /api/ss/project/5e64179c899bb708b55ea48c/testcases?status=Tested HTTP/1.1

Example

The following example is a cURL request to get all Tested test cases on a project.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.

curl -X GET 'https://demo.attackforge.com/api/ss/project/5e64179c899bb708b55ea48c/testcases?status=Tested' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'

Response

Response contains an array of test case objects.

{
   "count": 999,
   "testcases":[
      {
         "testcase": "...",
         "details": "...",
         "details_html": "...",
         "status": "...",
         "tags": [
            "..."
         ],
         "id": "...",
         "created": "...",
         "locked": "...",
         "last_updated": "...",
         "last_updated_by": "...",
         "notes": [
            {
               "note": "...",
               "note_html": "...", 
               "created": "...", 
               "last_updated": "...", 
               "last_updated_by": "..."
            }
         ],
         "uploaded_files": [
            {
               "name": "...",
               "alternative_name": "...",
               "file_type": "...",
               "size": 999, 
               "uploaded_on": "..."
            }
         ],
         "testsuite": {
            "id": "...",
            "name": "...",
            "code": "...",
            "testcase": {
               "execution_flow": [
                  {
                    "title": "...",
                    "details": "...",
                    "details_html": "..."
                  }
               ],
               "custom_fields": [
                  {
                    "key": "...",
                    "value": "..."
                  }
                ]
             }
          }
      }
   ]
}