QTM4J: Link Requirements to Test Case
qtm4j_link_requirements_to_test_caseLink Jira requirements to a test case in QTM4J by requirement keys or JQL filter. Automatically resolves keys to internal IDs for traceability.
Instructions
Link one or more Jira requirements to a test case in QTM4J by requirement keys or JQL filter. Requirement keys are resolved to internal IDs automatically.
Toolset: Test Cases
Parameters:
key (string) required: Test case key in '{PROJECT_KEY}-TC-{number}' format (e.g., 'SCRUM-TC-145'). Required.
versionNo (number): Test case version number. Defaults to the latest version.
requirementKeys (array): List of requirement keys to link (e.g., ['SCRUM-1', 'SCRUM-2']). Resolved to internal IDs automatically. Provide this OR filter.jql — not both.
filter (object): JQL filter to select requirements to link. Use instead of requirementKeys when filtering by JQL.
Output Description: Confirmation with the test case key, version number, and linked: true. Warnings are included if any requirements could not be resolved or linked.
Use Cases: 1. Link one or more Jira requirements (stories, bugs, epics) to a test case 2. Associate requirements with a test case using a JQL filter 3. Build traceability between requirements and test cases 4. Link requirements to a specific test case version
Examples:
Link two requirements by key
{
"key": "SCRUM-TC-145",
"requirementKeys": [
"SCRUM-1",
"SCRUM-2"
]
}Expected Output: Requirements SCRUM-1 and SCRUM-2 linked to test case
Link requirements by JQL filter
{
"key": "SCRUM-TC-145",
"filter": {
"jql": "project = DEMO AND issuetype = Story"
}
}Expected Output: Requirements matched by JQL linked to test case
Link a requirement to a specific version
{
"key": "SCRUM-TC-85",
"versionNo": 2,
"requirementKeys": [
"SCRUM-10"
]
}Expected Output: Requirement linked to version 2 of test case
Hints: 1. PREREQUISITE: set_project_context must be called before this tool. NEVER auto-select a project. 2. KEY FORMAT: '{PROJECT_KEY}-TC-{number}' — e.g. 'SCRUM-TC-145'. 3. Requirement keys follow the Jira issue key format: '{PROJECT_KEY}-{number}' (e.g. 'SCRUM-1'). 4. Provide either requirementKeys or filter.jql — not both. 5. If a requirement key cannot be resolved or linked, it is reported in warnings and other requirements are still linked. 6. versionNo defaults to the latest version. Use search_test_cases to find available versions if needed.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | Test case key in '{PROJECT_KEY}-TC-{number}' format (e.g., 'SCRUM-TC-145'). Required. | |
| filter | No | JQL filter to select requirements to link. Use instead of requirementKeys when filtering by JQL. | |
| versionNo | No | Test case version number. Defaults to the latest version. | |
| requirementKeys | No | List of requirement keys to link (e.g., ['SCRUM-1', 'SCRUM-2']). Resolved to internal IDs automatically. Provide this OR filter.jql — not both. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | ||
| linked | Yes | ||
| versionNo | Yes |