API Traceability

A single unified API returns all required data for a Jira requirement (Alt ID) in a single response. This design eliminates per-test-case API calls, reducing execution time and increasing system performance, scalability, and responsiveness.

  • All mapped test cases

  • Custom field details (For example, Test Class)

  • Test step details

  • Execution status

To add the new API, do the following:

  1. Select GET and add the following:

    https://{hostName}/flex/services/rest/latest/advancesearch/detailsTraceability/{altId}
  2. Add the following response:

    {
        "resultSize": 8,
        "results": [
            {
                "id": 5,
                "testId": 496,
                "name": "Test1",
                "projectName": "Test1",
                "projectId": 22,
                "testCaseId": 3,
                "testCaseVersionId": 2,
                "requirementIds": [
                    161,
                    138,
                    43
                ],
                "releaseId": 23,
                "releaseName": "Release 1.0",
                "testResult": {
                    "scheduleId": 4,
                    "executionDate": 1767699850413,
                    "executionStatus": "Fail",
                    "executionStatusColor": "#CC3300",
                    "phaseName": "folder2",
                    "cycleName": "c1",
                    "testerId": 25,
                    "defects": [
                        {
                            "id": 46,
                            "status": "To Do1",
                            "issueKey": "DP-7"
                        }
                    ]
                },
                "steps": [
                    {
                        "step": "test1",
                        "stepData": "data1",
                        "expectedResult": "result1"
                    },
                    {
                        "step": "new1",
                        "stepData": "new2",
                        "expectedResult": "new3"
                    }
                ],
                "customFields": {
                    "multiselect": "Multi1",
                    "check2": "true",
                    "text1": "selectall",
                    "picklist": "picklist1"
                }
            },
            {
                "id": 868,
                "testId": 3,
                "name": "Untitled",
                "projectName": "Test1",
                "projectId": 22,
                "testCaseId": 3,
                "testCaseVersionId": 1,
                "requirementIds": [
                    161,
                    138,
                    43
                ],
                "releaseId": 62,
                "releaseName": "Release 1.0 - Copy",
                "testResult": {
                    "scheduleId": 424,
                    "phaseName": "folder2",
                    "cycleName": "c1",
                    "testerId": 1
                },
                "customFields": {}
            },
            {
                "id": 6,
                "testId": 4,
                "name": "Untitled",
                "projectName": "Test1",
                "projectId": 22,
                "testCaseId": 4,
                "testCaseVersionId": 1,
                "requirementIds": [
                    176,
                    161,
                    138
                ],
                "releaseId": 23,
                "releaseName": "Release 1.0",
                "testResult": {
                    "scheduleId": 6,
                    "phaseName": "folder2",
                    "cycleName": "c1",
                    "testerId": 25
                },
                "customFields": {}
            },
            {
                "id": 870,
                "testId": 4,
                "name": "Untitled",
                "projectName": "Test1",
                "projectId": 22,
                "testCaseId": 4,
                "testCaseVersionId": 1,
                "requirementIds": [
                    161,
                    138
                ],
                "releaseId": 62,
                "releaseName": "Release 1.0 - Copy",
                "testResult": {
                    "scheduleId": 426,
                    "phaseName": "folder2",
                    "cycleName": "c1",
                    "testerId": 1
                },
                "customFields": {}
            },
            {
                "id": 7,
                "testId": 5,
                "name": "Untitled",
                "projectName": "Test1",
                "projectId": 22,
                "testCaseId": 5,
                "testCaseVersionId": 1,
                "requirementIds": [
                    176,
                    161,
                    138
                ],
                "releaseId": 23,
                "releaseName": "Release 1.0",
                "testResult": {
                    "scheduleId": 7,
                    "phaseName": "folder2",
                    "cycleName": "c1",
                    "testerId": 25
                },
                "customFields": {}
            },
            {
                "id": 872,
                "testId": 5,
                "name": "Untitled",
                "projectName": "Test1",
                "projectId": 22,
                "testCaseId": 5,
                "testCaseVersionId": 1,
                "requirementIds": [
                    161,
                    138
                ],
                "releaseId": 62,
                "releaseName": "Release 1.0 - Copy",
                "testResult": {
                    "scheduleId": 427,
                    "phaseName": "folder2",
                    "cycleName": "c1",
                    "testerId": 1
                },
                "customFields": {}
            },
            {
                "id": 8,
                "testId": 6,
                "name": "Untitled",
                "projectName": "Test1",
                "projectId": 22,
                "testCaseId": 6,
                "testCaseVersionId": 1,
                "requirementIds": [
                    176,
                    161
                ],
                "releaseId": 23,
                "releaseName": "Release 1.0",
                "testResult": {
                    "scheduleId": 11,
                    "phaseName": "folder2",
                    "cycleName": "c1",
                    "testerId": 25
                },
                "customFields": {}
            },
            {
                "id": 874,
                "testId": 6,
                "name": "Untitled",
                "projectName": "Test1",
                "projectId": 22,
                "testCaseId": 6,
                "testCaseVersionId": 1,
                "requirementIds": [
                    161
                ],
                "releaseId": 62,
                "releaseName": "Release 1.0 - Copy",
                "testResult": {
                    "scheduleId": 431,
                    "phaseName": "folder2",
                    "cycleName": "c1",
                    "testerId": 1
                },
                "customFields": {}
            }
        ]
    }
  3. Click Send.

Publication date: