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

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

Returns a list of test set items (tests).

Use the operation to get a list of items (tests) that a test set specified by its ID and the ID of the project, to which the test set belongs, has.

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 test set items, send a GET request to the following URL:

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

Id  :  integer, required

The ID of the test set whose items you want to get.

ProjectId  :  integer, required

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

offset  :  integer, default: 0

The number of test set items to skip before counting the test set items 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 set items 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/v1/projects/11873/testsets/182/items 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/v1/projects/11873/testsets/182/items

Response Format

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

A sample response:

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


{
    "metadata": {
       "result_set": {
          "count": 1,
          "offset": 0,
          "limit": 25,
          "total": 2
       },
        "permissions": {
            "acl": 7
       }
    },
    "results": [
      {
        "id": 1493,
        "project_id": 11873,
        "id": 182,
        "test_id": 2678,
        "seq": 1,
        "active": true,
        "is_stopped_on_fail": true,
        "assignee_user_id": 0,
        "default_host_id": 177,
        "date_created": "2015-07-31T10:19:10.5870000",
        "date_updated": "2015-09-09T09:28:27.0000000",
        "create_user_id": 25264,
        "update_user_id": 25264,
        "title": "Test input data",
        "nbr_steps": 0,
        "nbr_files": 0,
        "nbr_notes": 0
      },
      {
        "id": 1498,
        "project_id": 11873,
        "id": 182,
        "test_id": 2681,
        "seq": 2,
        "active": true,
        "is_stopped_on_fail": true,
        "assignee_user_id": 0,
        "default_host_id": 177,
        "date_created": "2015-08-09T09:27:45.6700000",
        "date_updated": "2015-09-09T10:28:27.0000000",
        "create_user_id": 25264,
        "update_user_id": 25264,
        "title": "Test report output",
        "nbr_steps": 0,
        "nbr_files": 0,
        "nbr_notes": 0
      }
    ]
  }

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