QMetry: Fetch Test Cases Linked to Test Suite
qmetry_fetch_test_cases_linked_to_test_suiteGet test cases linked or not linked to a test suite in QMetry. Supports filtering and pagination for execution planning, gap analysis, and coverage verification.
Instructions
Get test cases that are linked (or not linked) to a specific test suite in QMetry
Toolset: Test Suites
Parameters:
projectKey (string): Project key - unique identifier for the project (default: "default")
baseUrl (string): The base URL for the QMetry instance (must be a valid URL)
tsID (number) required: Test Suite numeric ID. CRITICAL: the parameter name is 'tsID' — do NOT use 'testSuiteId', 'testSuiteID', 'suiteId', or other variants. Accepts a string or number. NOTE: To get the tsID - Call API 'Testsuite/Fetch Testsuite' From the response, get value of following attribute -> data[].id
getLinked (boolean): True to get only those issues that are linked with this Test case Run, False to get those issues which are not linked with this Test case Run. Default value true (get linked issues). (default: true)
start (number): Start index for pagination - defaults to 0 (default: 0)
page (number): Page number to return (starts from 1) (default: 1)
limit (number): Number of records (default 10). (default: 10)
filter (string): Filter criteria as JSON string (default '[]') (default: "[]")
Output Description: JSON object with test cases array containing test case details, properties, and suite linkage information
Use Cases: 1. Get all test cases linked to a specific test suite for execution planning 2. Find test cases that are NOT linked to a test suite (gap analysis) 3. Analyze test suite composition and coverage 4. Filter linked test cases by various criteria 5. Plan test execution based on test suite structure 6. Generate test suite reports and documentation 7. Validate test suite contents before execution 8. Manage test case organization within test suites 9. Export test suite details for external reporting 10. Verify test case assignments in test suites
Examples:
Get all test cases linked to test suite ID 1497291 (default behavior)
{
"tsID": 1497291
}Expected Output: List of test cases linked to the test suite with test case details and metadata
Get all test cases linked to test suite ID 1497291 (explicit)
{
"tsID": 1497291,
"getLinked": true
}Expected Output: List of test cases linked to the test suite with test case details and metadata
Get test cases NOT linked to test suite (gap analysis)
{
"tsID": 1497291,
"getLinked": false
}Expected Output: List of test cases that are NOT linked to the test suite
Get linked test cases with custom pagination
{
"tsID": 1497291,
"getLinked": true,
"page": 1,
"limit": 25
}Expected Output: Paginated list of linked test cases with 50 items per page
Filter linked test cases by priority (using default getLinked=true)
{
"tsID": 1497291,
"filter": "[{\"value\":[1,2],\"type\":\"list\",\"field\":\"priorityAlias\"}]"
}Expected Output: High and medium priority test cases linked to the suite
Filter linked test cases by status
{
"tsID": 1497291,
"getLinked": true,
"filter": "[{\"value\":[1],\"type\":\"list\",\"field\":\"testCaseStateAlias\"}]"
}Expected Output: Active test cases linked to the test suite
Hints: 1. CRITICAL: tsID parameter is REQUIRED - this is the Test Suite numeric ID 2. getLinked parameter is OPTIONAL - defaults to true if not provided 3. HOW TO GET tsID: 4. 1. Call API 'Testsuite/Fetch Testsuite' to get available test suites 5. 2. From the response, get value of following attribute -> data[].id 6. 3. Example: Test Suite 'Regression Suite' might have ID 1497291 7. tsID is NOT the same as tsFolderID - tsID refers to a specific test suite, not a folder 8. getLinked=true (default): Returns test cases that ARE linked to the test suite 9. getLinked=false: Returns test cases that are NOT linked to the test suite (useful for gap analysis) 10. If getLinked is not specified, it defaults to true (linked test cases) 11. FILTER CAPABILITIES: Support filtering by test case properties 12. FILTER FIELDS: priorityAlias (list), testCaseStateAlias (list), testingTypeAlias (list), testCaseTypeAlias (list), componentAlias (list), owner (list) 13. PRIORITY IDs: Typically 1=High, 2=Medium, 3=Low (verify with your QMetry instance) 14. STATUS IDs: Typically 1=Active, 2=Review, 3=Deprecated (verify with your QMetry instance) 15. TESTING TYPE IDs: Typically 1=Manual, 2=Automated (verify with your QMetry instance) 16. TYPE IDs: Typically 1=Functional, 2=Integration, 3=System (verify with your QMetry instance) 17. Multiple filter conditions are combined with AND logic 18. Use pagination for large result sets (start, page, limit parameters) 19. This tool is essential for test suite management and execution planning 20. Helps verify test suite composition before test runs 21. Critical for understanding test coverage within specific suites 22. Use for test suite analysis and optimization
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number to return (starts from 1) | |
| tsID | Yes | Test Suite numeric ID. CRITICAL: the parameter name is 'tsID' — do NOT use 'testSuiteId', 'testSuiteID', 'suiteId', or other variants. Accepts a string or number. NOTE: To get the tsID - Call API 'Testsuite/Fetch Testsuite' From the response, get value of following attribute -> data[<index>].id | |
| limit | No | Number of records (default 10). | |
| start | No | Start index for pagination - defaults to 0 | |
| filter | No | Filter criteria as JSON string (default '[]') | [] |
| baseUrl | No | The base URL for the QMetry instance (must be a valid URL) | |
| getLinked | No | True to get only those issues that are linked with this Test case Run, False to get those issues which are not linked with this Test case Run. Default value true (get linked issues). | |
| projectKey | No | Project key - unique identifier for the project | default |