QTM4J: Unlink Test Cases from Test Cycle
qtm4j_unlink_test_cases_from_test_cycleRemove test cases from a QTM4J test cycle by keys, filter criteria, or unlink all at once. Clean up cycles before repopulating them.
Instructions
Unlink test cases from a QTM4J test cycle by test case keys, filter criteria, or all at once with unlinkAll.
Toolset: Test Cycles
Parameters:
cycleKey (string) required: Test Cycle key (e.g., 'SCRUM-TR-1'). Resolved to the internal cycle UID automatically.
testCaseKeys (array): Test case keys to unlink (e.g., ['SCRUM-TC-1', 'SCRUM-TC-2']). Resolved to internal IDs and latest versions automatically. Provide this OR filter or unlinkAll — not combined.
unlinkAll (boolean): If true, all test cases are unlinked from the cycle. Ignores testCaseKeys and filter.
filter (object): Filter criteria to select test cases to unlink. projectId is auto-filled from the active project context.
Output Description: Confirmation with the cycle key and unlinked: true. Warnings included if any test cases could not be resolved or unlinked.
Use Cases: 1. Remove specific test cases from a test cycle by key 2. Unlink all test cases from a test cycle at once 3. Remove test cases matching a filter from a cycle (e.g., all 'Done' test cases) 4. Clean up a test cycle before repopulating it
Examples:
Unlink two specific test cases
{
"cycleKey": "SCRUM-TR-1",
"testCaseKeys": [
"SCRUM-TC-10",
"SCRUM-TC-11"
]
}Expected Output: Test cases unlinked from test cycle
Unlink all test cases from a cycle
{
"cycleKey": "SCRUM-TR-1",
"unlinkAll": true
}Expected Output: All test cases unlinked from cycle
Unlink test cases matching a status filter
{
"cycleKey": "SCRUM-TR-5",
"filter": {
"status": [
"Done"
],
"labels": [
"Deprecated"
]
}
}Expected Output: Filtered test cases unlinked from cycle
Hints: 1. PREREQUISITE: set_project_context must be called before this tool. NEVER auto-select a project. 2. CYCLE KEY FORMAT: '{PROJECT_KEY}-TR-{id}' — e.g. 'SCRUM-TR-1'. Resolved to internal UID automatically. 3. TEST CASE KEY FORMAT: '{PROJECT_KEY}-TC-{number}' — e.g. 'SCRUM-TC-145'. 4. Provide exactly one of: testCaseKeys, unlinkAll, or filter. 5. unlinkAll: true removes every test case from the cycle — no need to list them individually. 6. projectId in filter is auto-filled from the active project context — do not set it manually. 7. If a test case key cannot be resolved, it is reported in warnings and others are still unlinked.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter | No | Filter criteria to select test cases to unlink. projectId is auto-filled from the active project context. | |
| cycleKey | Yes | Test Cycle key (e.g., 'SCRUM-TR-1'). Resolved to the internal cycle UID automatically. | |
| unlinkAll | No | If true, all test cases are unlinked from the cycle. Ignores testCaseKeys and filter. | |
| testCaseKeys | No | Test case keys to unlink (e.g., ['SCRUM-TC-1', 'SCRUM-TC-2']). Resolved to internal IDs and latest versions automatically. Provide this OR filter or unlinkAll — not combined. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| linked | No | ||
| cycleKey | Yes | ||
| unlinked | No |