GET/projects/{ProjectId}/testsets

Applies to QAComplete 12.80 SaaS, last modified on April 20, 2021

Returns a list of a project’s test sets.

Use the operation to get a list of all test sets defined in a specified QAComplete project.

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 Read privilege for the Test Sets.

Request Format

To get information on test sets, send a GET request to the following URL:

http://{server}/rest-api/service/api/v2/projects/{ProjectId}/testsets?offset={offset}&limit={limit}&Filter={filter}

ProjectId  :  integer, required

The ID of the project.

offset  :  integer, default: 0

The number of test sets to skip before counting the test sets to return. The default value is 0, which is the offset of the first item. For details, see Paging Through Results Using Offset and Limit.

limit  :  integer, default: 25

The maximum number of test sets to return.

filter  :  string

The filter expression to apply to the returned list. See Search Filters.

A sample request:

GET http://yourserver.com/rest-api/service/api/v2/projects/11873/testsets HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==

A sample request made by using cURL:

curl -u john@example.com:p@ssword -H "Accept: application/json" http://yourserver.com/service/api/v2/projects/11873/testsets

Response Format

If successful, the operation responds with HTTP status code 200 and returns a JSON object with information about the test sets.

A sample response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1104


{
    "metadata": {
       "result_set": {
          "count": 1,
          "offset": 0,
          "limit": 25,
          "total": 1
       },
        "permissions": {
            "acl": 7
       }
    },
    "results": [
      {
        "id": 182,
        "project_id": 11873,
        "folder_id": 8,
        "folder_name": "Regression Tests",
        "create_user_id": 25264,
        "update_user_id": 25264,
        "owner_user_id": 25264,
        "assignee_user_id": 25264,
        "title": "Automated Tests",
        "is_active": true,
        "is_sequential": true,
        "status_code": "Approved",
        "priority_code": "3-Low",
        "execution_type": "Automated",
        "description": "Automated UI tests",
        "date_created": "2015-07-31T10:19:10.5870000",
        "date_updated": "2015-09-09T09:28:27.0000000",
        "assigned_to_name": "Smith, John",
        "user_name": "Smith, John",
        "owner_name": "Smith, John",
        "nbr_tests": 2,
        "last_run_status": "Passed",
        "last_run_date": "2015-09-06T10:53:07.0000000",
        "last_run_by_user_id": 25264,
        "last_run_by_name": "Smith, John",
        "nbr_times_run": 2,
        "avg_run_time": 375,
        "avg_run_time_formated": "00:06:15",
        "nbr_files": 0,
        "nbr_notes": 0,
        "last_run_release_id": 204,
        "last_run_release_name": "Internal BETA Release",
        "last_run_test_config_id": 114,
        "last_run_test_config_name": "Configuration A",
        "allow_run": true,
        "nbr_schedules": 1
      }
    ]
  }

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.

See Also

Test Sets Resources

Highlight search results