QTM4J: Link Test Cases to Requirement
qtm4j_link_test_cases_to_requirementLink test cases to a Jira requirement by key or filter to establish traceability.
Instructions
Link test cases to a Jira requirement in QTM4J by test case keys or filter criteria. Test case keys are resolved to internal IDs automatically.
Toolset: Requirements
Parameters:
requirementKey (string) required: Jira requirement key (e.g., 'SCRUM-1'). Resolved to the internal Jira issue ID automatically.
testCaseKeys (array): Test case keys to link (e.g., ['SCRUM-TC-1', 'SCRUM-TC-2']). Resolved to internal IDs and latest versions automatically. Provide this OR filter — not both.
filter (object): Filter criteria to select test cases to link. Use instead of testCaseKeys when selecting by criteria. projectId is auto-filled from the active project context.
sort (string): Sort order for filter results in 'field:asc|desc' format (e.g., 'key:asc'). Allowable fields: key, summary, created, updated, estimatedTime, status, priority, latestVersionNo, flakyScore, passRateScore.
Output Description: Confirmation with the requirement key and linked: true. Warnings included if any test cases could not be resolved or linked.
Use Cases: 1. Link specific test cases to a Jira story or bug by requirement key 2. Build traceability between Jira requirements and QTM4J test cases 3. Link all test cases matching a filter to a requirement 4. Associate test cases with a requirement as part of sprint planning
Examples:
Link two test cases by key
{
"requirementKey": "SCRUM-1",
"testCaseKeys": [
"SCRUM-TC-10",
"SCRUM-TC-11"
]
}Expected Output: Test cases linked to requirement SCRUM-1
Link test cases matching a filter
{
"requirementKey": "SCRUM-1",
"filter": {
"priority": [
"High"
],
"status": [
"To Do"
]
}
}Expected Output: Filtered test cases linked to requirement
Link test cases in a specific folder
{
"requirementKey": "SCRUM-5",
"filter": {
"folderId": 42,
"withChild": true
},
"sort": "key:asc"
}Expected Output: Folder test cases linked to requirement
Hints: 1. PREREQUISITE: set_project_context must be called before this tool. NEVER auto-select a project. 2. REQUIREMENT KEY FORMAT: '{PROJECT_KEY}-{number}' — e.g. 'SCRUM-1'. 3. TEST CASE KEY FORMAT: '{PROJECT_KEY}-TC-{number}' — e.g. 'SCRUM-TC-145'. 4. Provide either testCaseKeys or filter — not both. 5. projectId in filter is auto-filled from the active project context — do not set it manually. 6. filter.excludeRequirementId excludes test cases already linked to that requirement ID. 7. If a test case key cannot be resolved, it is reported in warnings and other test cases are still linked.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort order for filter results in 'field:asc|desc' format (e.g., 'key:asc'). Allowable fields: key, summary, created, updated, estimatedTime, status, priority, latestVersionNo, flakyScore, passRateScore. | |
| filter | No | Filter criteria to select test cases to link. Use instead of testCaseKeys when selecting by criteria. projectId is auto-filled from the active project context. | |
| testCaseKeys | No | Test case keys to link (e.g., ['SCRUM-TC-1', 'SCRUM-TC-2']). Resolved to internal IDs and latest versions automatically. Provide this OR filter — not both. | |
| requirementKey | Yes | Jira requirement key (e.g., 'SCRUM-1'). Resolved to the internal Jira issue ID automatically. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| linked | No | ||
| unlinked | No | ||
| requirementKey | Yes |