GET/projects/{ProjectId}/testsets/{Id}

Applies to QAComplete 12.84 SaaS, last modified on July 19, 2021

Returns a test set by its ID.

Use the operation to get information on a test set specified by its ID and the ID of the project, to which the test set belongs.

To get information on all the test sets that the QAComplete project contains, use the …/testsets (GET) operation.

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 Test Sets.

Request Format

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

http://{server}/rest-api/service/api/v2/projects/{ProjectId}/testsets/{Id}

ProjectId  :  integer, required

The ID of the project to which the test set belongs.

Id  :  integer, required

The ID of the test set to get.

A sample request:

GET http://yourserver.com/rest-api/service/api/v2/projects/11873/testsets/182 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/182

Response Format

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

A sample response:

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



{
  "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": "Test input data",
  "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.

If the test set with the specified ID does not exist, the operation returns the Entity TestSet with Id Test_Set_ID was not found error.

See Also

Test Sets Resources

Highlight search results