Trace Filters

Get Trace Filter Details¶

Parameters

Name	Description
id *	Numeric ID of the Trace Filter. Type: integer (path)

Responses

Code

Description

200

Trace Filter data.

Media type: application/json

Example Value:

{
    "id": 0,
    "name": "string",
    "filter": "string",
    "projects": [
        {
            "id": 0,
            "name": "string"
        }
    ]
}

404

Resource was not found.

Update a Trace Filter¶

Role: Admin, or the user who created the Trace Filter.

name (at least 5 characters) and filter are required.

Parameters

Name	Description
id *	Numeric ID of the Trace Filter. Type: integer (path)

Request body required

{
    "name": "string",
    "filter": "string"
}

Responses

Code	Description
200	Trace Filter was updated successfully.
404	Resource was not found.

Delete a Trace Filter¶

Parameters

Name	Description
id *	Numeric ID of the Trace Filter. Type: integer (path)

Responses

Code	Description
200	Trace Filter was deleted successfully.
404	Resource was not found.
409	Resource cannot be deleted.

List Trace Filters¶

Parameters

Name	Description
page	The page to list entries. Type: string (query) Default value: 0
size	The page size for listing entries. Type: string (query) Default value: 20
sort	The sort type for listing entries. Type: string (query)
prj	The project list for filtering entries. Type: string (query)

Responses

Code

Description

200

OK

Media type: application/json

Example Value:

{
    "totalElements": 0,
    "totalPages": 0,
    "number": 0,
    "sort": {
        "sorted": true,
        "unsorted": true,
        "empty": true
    },
    "size": 0,
    "content": [
        {
            "id": 0,
            "name": "string",
            "projects": [
                {
                    "id": 0,
                    "name": "string"
                }
            ]
        }
    ],
    "first": true,
    "last": true,
    "pageable": {
        "sort": {
            "sorted": true,
            "unsorted": true,
            "empty": true
        },
        "offset": 0,
        "paged": true,
        "unpaged": true,
        "pageNumber": 0,
        "pageSize": 0
    },
    "numberOfElements": 0,
    "empty": true
}

Create a Trace Filter¶

Role: Standard and above.

name (at least 5 characters) and filter are required.

Parameters

No parameters

Request body required

{
    "name": "string",
    "filter": "string"
}

Responses

Code

Description

201

ID of the Trace Filter.

Media type: application/json

Example Value:

{
    "id": 0
}

409

Name needs to be unique.

List Test Cases using this Trace Filter¶

Role: Guest and above.

Parameters

Name	Description
id *	Numeric ID of the Trace Filter. Type: integer (path)
page	Zero-based page number. Default 0. Type: integer (query)
size	Page size. Default 20. Type: integer (query)
sort	`<field>,asc` or `<field>,desc`. Type: string (query)

Responses

Code

Description

200

A page of the Test Cases that use this Trace Filter.

Media type: application/json

Example Value:

{
"content": [
    {
        "id": 0,
        "name": "string",
        "description": "string",
        "testStepCount": 0,
        "deviceList": [
            "string"
        ],
        "created": "string",
        "updated": "string",
        "projects": [
            {
                "id": 0,
                "name": "string"
            }
        ],
        "disabled": false,
        "disableReason": "string",
        "tags": [
            "string"
        ],
        "running": false,
        "runningExecutionId": null,
        "aiGenerated": false
    }
],
"totalElements": 0,
"totalPages": 0,
"number": 0,
"size": 20
}

404

Resource was not found.