Test Suite

• postGet test suite detail
• postAdd test suite
• postList test suites
• postUpdate test suite
• postDelete a test suite
• postGet test suites in a test run

API docs by Redocly

TMT API (1.0.0)

Download OpenAPI specification:Download

API working with Test suites in TMT

Get test suite detail

Get content of a test suite by given test suite document reference

Authorizations:

bearerAuth

header Parameters

Project-Id required	string Project Id or the project document reference
Subproject-Id	string Sub Project Id or the project document reference. It might be required if you want to access the sub project's resource

Request Body schema: application/json

required

id required	string id of the operation
jsonrpc required	string must be 2.0
method required	string GET_DOCUMENT
required	object

Responses

https://q12-tmt.com/api/v2/rpc (GET_DOCUMENT for Test Suite)

Request samples

• Payload

Content type

application/json

{

• "jsonrpc": "2.0",
• "method": "GET_DOCUMENT",
• "id": "GET_DOCUMENT-10",
• "params": {

  • "docRef": "TestSuite-dm/1614"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "GET_DOCUMENT-10",
• "result": {

  • "docRef": "TestSuite-dm/1614",
  • "documentModelName": "TestSuite-dm",
  • "document": {

    • "Root": {

      • "General": {

        • "ProjectId": "P_9",
        • "ProjectVersionNumber": "1.0.0",
        • "SubprojectId": "SP_2",
        • "Title": "00 Incoming order",
        • "Id": "S_14",
        • "TechnicalId": "c1cd1a9b-5313-4fb0-8f05-ce194820c8d4",
        • "TenantId": "T_1",
        • "Order": "1",
        • "Tags": "order",
        • "Description": "This suites contains the test cases that test for the incoming orders",
        • "SearchableTags": "|[order]|",
        • "RecommendedPriority": {

          • "Value": "MEDIUM"

          },
        • "SearchTags": [

          • {

            • "Value": "order"

            }

          ]

        },
      • "Metadata": {

        • "CreatedBy": "peter.parker",
        • "DisplayCreatedOn": "2022-12-05T13:13:57",
        • "CreatedOn": 1670246037200,
        • "EditedBy": "trung",
        • "DisplayEditedOn": "2024-11-11T03:42:35",
        • "EditedOn": 1731296555565,
        • "AssignedToVersion": {

          • "AssignedToNumber": "1.0.0",
          • "AssignedToTitle": "ERP & PIM"

          },
        • "LatestTestCaseExecutionData": {

          • "TestedOn": "2023-08-07T12:17:15",
          • "TestedBy": "peter.lange",
          • "TestRunId": "R_3",
          • "TestRunTitle": "Run 1",
          • "VersionId": "1.0.0",
          • "VersionTitle": "ERP & PIM",
          • "TestCaseId": "C_39",
          • "TestCaseTitle": "Yet another test case"

          }

        },
      • "Attachments": [

        • {

          • "FileName": "index.country.m3u",
          • "CreatedAt": "2024-11-11T03:42:30",
          • "UploadOn": "2024-11-11",
          • "OriginalFileName": "index.country.m3u",
          • "UploadBy": "trung",
          • "Referenced": false,
          • "CopyNumber": 0,
          • "ThumbnailId": "",
          • "File": {

            • "content": null,
            • "attachment_id": "4e66782a-65e6-427a-9aaf-7a1c365d9290",
            • "internal_filename": "1731296538385-adb3718b-9bed-4e6a-acb8-112c2a975d4c.m3u",
            • "original_filename": "index.country.m3u",
            • "size": 3973812,
            • "mime_type": "application/vnd.apple.mpegurl"

            }

          }

        ]

      },
    • "__meta": {

      • "creator": "peter.parker",
      • "modifier": "trung",
      • "docRef": "TestSuite-dm/1614",
      • "modelReference": "TestSuite-dm",
      • "createdAt": "2022-12-05T13:13:57",
      • "modifiedAt": "2024-11-11T03:42:35",
      • "modelVersion": null

      }

    }

  }

}

Add test suite

Add a new test suite

Authorizations:

bearerAuth

header Parameters

Project-Id required	string Project Id or the project document reference
Subproject-Id	string Sub Project Id or the project document reference. It might be required if you want to access the sub project's resource

Request Body schema: application/json

required

id required	string id of the operation
jsonrpc required	string must be 2.0
method required	string ADD_DOCUMENT
required	object

Responses

https://q12-tmt.com/api/v2/rpc (ADD_DOCUMENT for Test suite)

Request samples

• Payload

Content type

application/json

{

• "id": "ADD_TEST_SUITE",
• "method": "ADD_DOCUMENT",
• "params": {

  • "document": {

    • "Root": {

      • "General": {

        • "RecommendedPriority": {

          • "Value": "HIGH"

          },
        • "ProjectId": "P_9",
        • "ProjectVersionNumber": "1.0.0",
        • "SubprojectId": "SP_2",
        • "Title": "Cart management",
        • "Tags": "cart,shopping",
        • "Description": "Manage the operation on a cart, e.g add/remove products into cart"

        },
      • "Attachments": [

        • {

          • "FileName": "16K.jpg",
          • "File": {

            • "content": null,
            • "attachment_id": "7cfd7350-8839-4683-a20c-f4de5068c9d6",
            • "internal_filename": "1731307906841-6fd09549-27f7-4959-a8f7-faefacdbda3c.jpg",
            • "original_filename": "16K.jpg",
            • "size": 86838,
            • "mime_type": "image/jpeg"

            },
          • "CreatedAt": "2024-11-11T06:51:48",
          • "UploadOn": "2024-11-11",
          • "OriginalFileName": "16K.jpg",
          • "UploadBy": "trung",
          • "Referenced": false,
          • "CopyNumber": 0,
          • "ThumbnailId": "e5c3456e-4d85-4307-aa7b-a65facddb6e7"

          }

        ]

      },
    • "id": "-1"

    },
  • "documentModelName": "TestSuite-dm",
  • "locale": "en"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "ADD_TEST_SUITE",
• "result": {

  • "docRef": "TestSuite-dm/6c1de7de-04af-498e-848d-fea2d30e2ab5"

  }

}

List test suites

List of test suites for given project version

Authorizations:

bearerAuth

header Parameters

Project-Id required	string Project Id or the project document reference
Subproject-Id	string Sub Project Id or the project document reference. It might be required if you want to access the sub project's resource

Request Body schema: application/json

required

id required	string id of the operation
jsonrpc required	string must be 2.0
method required	any LIST_TEST_SUITES
required	object

Responses

https://q12-tmt.com/api/v2/rpc (LIST_TEST_SUITES)

Request samples

• Payload

Content type

application/json

{

• "id": "TestSuites.DataProvider-12",
• "jsonrpc": "2.0",
• "method": "LIST_TEST_SUITES",
• "params": {

  • "projectSpec": {

    • "projectId": "P_9",
    • "subProjectId": "SP_2",
    • "projectVersionNumber": "1.0.0"

    },
  • "filter": {

    • "filters": [ ],
    • "fulltext": "",
    • "lang": ""

    },
  • "page": {

    • "offset": 0,
    • "limit": 50

    },
  • "sort": [

    • {

      • "order": "Root.General.Order ASC"

      }

    ]

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "TestSuites.DataProvider-12",
• "result": {

  • "result": {

    • "fullSize": 9,
    • "page": {

      • "offset": 0,
      • "limit": 50

      },
    • "entries": [

      • {

        • "docRef": "TestSuite-dm/1614",
        • "documentModelName": "TestSuite-dm",
        • "document": {

          • "Root": {

            • "General": {

              • "ProjectId": "P_9",
              • "ProjectVersionNumber": "1.0.0",
              • "SubprojectId": "SP_2",
              • "Title": "00 Incoming order",
              • "Id": "S_14",
              • "TechnicalId": "c1cd1a9b-5313-4fb0-8f05-ce194820c8d4",
              • "TenantId": "T_1",
              • "Order": "1",
              • "Tags": "order",
              • "Description": "This suites contains the test cases that test for the incoming orders",
              • "SearchableTags": "|[order]|",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                },
              • "SearchTags": [

                • {

                  • "Value": "order"

                  }

                ]

              },
            • "Metadata": {

              • "CreatedBy": "peter.parker",
              • "DisplayCreatedOn": "2022-12-05T13:13:57",
              • "CreatedOn": 1670246037200,
              • "EditedBy": "trung",
              • "DisplayEditedOn": "2024-11-11T03:42:35",
              • "EditedOn": 1731296555565,
              • "AssignedToVersion": {

                • "AssignedToNumber": "1.0.0",
                • "AssignedToTitle": "ERP & PIM"

                },
              • "LatestTestCaseExecutionData": {

                • "TestedOn": "2023-08-07T12:17:15",
                • "TestedBy": "peter.lange",
                • "TestRunId": "R_3",
                • "TestRunTitle": "Run 1",
                • "VersionId": "1.0.0",
                • "VersionTitle": "ERP & PIM",
                • "TestCaseId": "C_39",
                • "TestCaseTitle": "Yet another test case"

                }

              },
            • "Attachments": [

              • {

                • "FileName": "index.country.m3u",
                • "CreatedAt": "2024-11-11T03:42:30",
                • "UploadOn": "2024-11-11",
                • "OriginalFileName": "index.country.m3u",
                • "UploadBy": "trung",
                • "Referenced": false,
                • "CopyNumber": 0,
                • "ThumbnailId": "",
                • "File": {

                  • "content": null,
                  • "attachment_id": "4e66782a-65e6-427a-9aaf-7a1c365d9290",
                  • "internal_filename": "1731296538385-adb3718b-9bed-4e6a-acb8-112c2a975d4c.m3u",
                  • "original_filename": "index.country.m3u",
                  • "size": 3973812,
                  • "mime_type": "application/vnd.apple.mpegurl"

                  }

                }

              ],
            • "DisplayFields": {

              • "TotalTestCases": 1,
              • "PercentageOfAutomatedCases": "0.00%",
              • "AutomationCoverage": [

                • {

                  • "name": "TO_BE_EVALUATED",
                  • "count": 0

                  },
                • {

                  • "name": "TO_BE_AUTOMATED",
                  • "count": 0

                  },
                • {

                  • "name": "AUTOMATED",
                  • "count": 0

                  },
                • {

                  • "name": "NOT_TO_BE_AUTOMATED",
                  • "count": 0

                  },
                • {

                  • "name": "NOT_DEFINED",
                  • "count": 1

                  }

                ],
              • "AssigneesOfTestCases": [ ],
              • "TestCasesWithAssignee": "0.00%"

              }

            },
          • "__meta": {

            • "creator": "peter.parker",
            • "modifier": "trung",
            • "docRef": "TestSuite-dm/1614",
            • "modelReference": "TestSuite-dm",
            • "createdAt": "2022-12-05T13:13:57",
            • "modifiedAt": "2024-11-11T03:42:35",
            • "modelVersion": null

            }

          }

        },
      • {

        • "docRef": "TestSuite-dm/1615",
        • "documentModelName": "TestSuite-dm",
        • "document": {

          • "Root": {

            • "General": {

              • "ProjectId": "P_9",
              • "ProjectVersionNumber": "1.0.0",
              • "SubprojectId": "SP_2",
              • "Title": "01 Payment types and capturing",
              • "Id": "S_15",
              • "TechnicalId": "d773eab2-f92d-43e1-9ca7-ee3ee1ebd2a6",
              • "TenantId": "T_1",
              • "Order": "2",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              },
            • "Metadata": {

              • "CreatedBy": "peter.parker",
              • "DisplayCreatedOn": "2022-12-05T13:14:09",
              • "CreatedOn": 1670246049789,
              • "EditedBy": "peter.parker",
              • "DisplayEditedOn": "2022-12-05T13:14:18",
              • "EditedOn": 1670246058338,
              • "AssignedToVersion": {

                • "AssignedToNumber": "1.0.0",
                • "AssignedToTitle": "ERP & PIM"

                }

              },
            • "DisplayFields": {

              • "TotalTestCases": 0,
              • "PercentageOfAutomatedCases": "-",
              • "AutomationCoverage": [ ],
              • "AssigneesOfTestCases": [ ],
              • "TestCasesWithAssignee": "-"

              }

            },
          • "__meta": {

            • "creator": "peter.parker",
            • "modifier": "peter.parker",
            • "docRef": "TestSuite-dm/1615",
            • "modelReference": "TestSuite-dm",
            • "createdAt": "2022-12-05T13:14:09",
            • "modifiedAt": "2023-11-20T03:59:04",
            • "modelVersion": null

            }

          }

        },
      • {

        • "docRef": "TestSuite-dm/1616",
        • "documentModelName": "TestSuite-dm",
        • "document": {

          • "Root": {

            • "General": {

              • "ProjectId": "P_9",
              • "ProjectVersionNumber": "1.0.0",
              • "SubprojectId": "SP_2",
              • "Title": "02 Pending payments",
              • "Id": "S_16",
              • "TechnicalId": "584fa015-7f25-438b-b9ad-15ec5e4c886f",
              • "TenantId": "T_1",
              • "Order": "3",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              },
            • "Metadata": {

              • "CreatedBy": "peter.parker",
              • "DisplayCreatedOn": "2022-12-05T13:14:28",
              • "CreatedOn": 1670246068283,
              • "EditedBy": "peter.parker",
              • "DisplayEditedOn": "2022-12-05T13:14:35",
              • "EditedOn": 1670246075967,
              • "AssignedToVersion": {

                • "AssignedToNumber": "1.0.0",
                • "AssignedToTitle": "ERP & PIM"

                }

              },
            • "DisplayFields": {

              • "TotalTestCases": 0,
              • "PercentageOfAutomatedCases": "-",
              • "AutomationCoverage": [ ],
              • "AssigneesOfTestCases": [ ],
              • "TestCasesWithAssignee": "-"

              }

            },
          • "__meta": {

            • "creator": "peter.parker",
            • "modifier": "peter.parker",
            • "docRef": "TestSuite-dm/1616",
            • "modelReference": "TestSuite-dm",
            • "createdAt": "2022-12-05T13:14:28",
            • "modifiedAt": "2023-11-20T03:59:04",
            • "modelVersion": null

            }

          }

        },
      • {

        • "docRef": "TestSuite-dm/1617",
        • "documentModelName": "TestSuite-dm",
        • "document": {

          • "id": "-1",
          • "Root": {

            • "General": {

              • "ProjectId": "P_9",
              • "ProjectVersionNumber": "1.0.0",
              • "SubprojectId": "SP_2",
              • "Title": "03 Refund process",
              • "Id": "S_17",
              • "TechnicalId": "e6a9b94f-ed94-4e43-9ee2-fbf56085d7f3",
              • "TenantId": "T_1",
              • "Order": "4",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              },
            • "Metadata": {

              • "CreatedBy": "peter.parker",
              • "DisplayCreatedOn": "2022-12-05T13:14:47",
              • "CreatedOn": 1670246087904,
              • "EditedBy": "peter.parker",
              • "DisplayEditedOn": "2022-12-05T13:14:47",
              • "EditedOn": 1670246087904

              },
            • "DisplayFields": {

              • "TotalTestCases": 0,
              • "PercentageOfAutomatedCases": "-",
              • "AutomationCoverage": [ ],
              • "AssigneesOfTestCases": [ ],
              • "TestCasesWithAssignee": "-"

              }

            },
          • "__meta": {

            • "creator": "peter.parker",
            • "modifier": "peter.parker",
            • "docRef": "TestSuite-dm/1617",
            • "modelReference": "TestSuite-dm",
            • "createdAt": "2022-12-05T13:14:47",
            • "modifiedAt": "2023-11-20T03:59:04",
            • "modelVersion": null

            }

          }

        },
      • {

        • "docRef": "TestSuite-dm/1618",
        • "documentModelName": "TestSuite-dm",
        • "document": {

          • "id": "-1",
          • "Root": {

            • "General": {

              • "ProjectId": "P_9",
              • "ProjectVersionNumber": "1.0.0",
              • "SubprojectId": "SP_2",
              • "Title": "04 Product management",
              • "Id": "S_18",
              • "TechnicalId": "fdc5bbcd-46fc-4ea7-abb4-a9cebbec4f26",
              • "TenantId": "T_1",
              • "Order": "5",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              },
            • "Metadata": {

              • "CreatedBy": "peter.parker",
              • "DisplayCreatedOn": "2022-12-05T13:15:07",
              • "CreatedOn": 1670246107453,
              • "EditedBy": "peter.parker",
              • "DisplayEditedOn": "2022-12-05T13:15:07",
              • "EditedOn": 1670246107453

              },
            • "DisplayFields": {

              • "TotalTestCases": 0,
              • "PercentageOfAutomatedCases": "-",
              • "AutomationCoverage": [ ],
              • "AssigneesOfTestCases": [ ],
              • "TestCasesWithAssignee": "-"

              }

            },
          • "__meta": {

            • "creator": "peter.parker",
            • "modifier": "peter.parker",
            • "docRef": "TestSuite-dm/1618",
            • "modelReference": "TestSuite-dm",
            • "createdAt": "2022-12-05T13:15:07",
            • "modifiedAt": "2023-11-20T03:59:04",
            • "modelVersion": null

            }

          }

        },
      • {

        • "docRef": "TestSuite-dm/1620",
        • "documentModelName": "TestSuite-dm",
        • "document": {

          • "Root": {

            • "General": {

              • "ProjectId": "P_9",
              • "ProjectVersionNumber": "1.0.0",
              • "SubprojectId": "SP_2",
              • "Title": "05 Services and Interfaces",
              • "Id": "S_20",
              • "TechnicalId": "244d1c90-f48c-4cd0-a802-3f2e4a61829b",
              • "TenantId": "T_1",
              • "Order": "6",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              },
            • "Metadata": {

              • "CreatedBy": "peter.parker",
              • "DisplayCreatedOn": "2022-12-05T13:16:03",
              • "CreatedOn": 1670246163370,
              • "EditedBy": "peter.parker",
              • "DisplayEditedOn": "2022-12-05T13:16:36",
              • "EditedOn": 1670246196913

              },
            • "DisplayFields": {

              • "TotalTestCases": 0,
              • "PercentageOfAutomatedCases": "-",
              • "AutomationCoverage": [ ],
              • "AssigneesOfTestCases": [ ],
              • "TestCasesWithAssignee": "-"

              }

            },
          • "__meta": {

            • "creator": "peter.parker",
            • "modifier": "peter.parker",
            • "docRef": "TestSuite-dm/1620",
            • "modelReference": "TestSuite-dm",
            • "createdAt": "2022-12-05T13:16:03",
            • "modifiedAt": "2023-11-20T03:59:04",
            • "modelVersion": null

            }

          }

        },
      • {

        • "docRef": "TestSuite-dm/1621",
        • "documentModelName": "TestSuite-dm",
        • "document": {

          • "id": "-1",
          • "Root": {

            • "General": {

              • "ProjectId": "P_9",
              • "ProjectVersionNumber": "1.0.0",
              • "SubprojectId": "SP_2",
              • "Title": "06 Price lists",
              • "Id": "S_21",
              • "TechnicalId": "f371e373-fbdf-46fb-945d-d39f03332852",
              • "TenantId": "T_1",
              • "Order": "7",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              },
            • "Metadata": {

              • "CreatedBy": "peter.parker",
              • "DisplayCreatedOn": "2022-12-05T13:17:33",
              • "CreatedOn": 1670246253261,
              • "EditedBy": "peter.parker",
              • "DisplayEditedOn": "2022-12-05T13:17:33",
              • "EditedOn": 1670246253261

              },
            • "DisplayFields": {

              • "TotalTestCases": 1,
              • "PercentageOfAutomatedCases": "0.00%",
              • "AutomationCoverage": [

                • {

                  • "name": "TO_BE_EVALUATED",
                  • "count": 0

                  },
                • {

                  • "name": "TO_BE_AUTOMATED",
                  • "count": 0

                  },
                • {

                  • "name": "AUTOMATED",
                  • "count": 0

                  },
                • {

                  • "name": "NOT_TO_BE_AUTOMATED",
                  • "count": 0

                  },
                • {

                  • "name": "NOT_DEFINED",
                  • "count": 1

                  }

                ],
              • "AssigneesOfTestCases": [ ],
              • "TestCasesWithAssignee": "0.00%"

              }

            },
          • "__meta": {

            • "creator": "peter.parker",
            • "modifier": "peter.parker",
            • "docRef": "TestSuite-dm/1621",
            • "modelReference": "TestSuite-dm",
            • "createdAt": "2022-12-05T13:17:33",
            • "modifiedAt": "2023-11-20T03:59:04",
            • "modelVersion": null

            }

          }

        },
      • {

        • "docRef": "TestSuite-dm/1619",
        • "documentModelName": "TestSuite-dm",
        • "document": {

          • "Root": {

            • "General": {

              • "ProjectId": "P_9",
              • "ProjectVersionNumber": "1.0.0",
              • "SubprojectId": "SP_2",
              • "Title": "07 Remove customers, GDPR",
              • "Id": "S_19",
              • "TechnicalId": "8e354d75-53ea-445f-9119-e4a2b0265850",
              • "TenantId": "T_1",
              • "Order": "8",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              },
            • "Metadata": {

              • "CreatedBy": "peter.parker",
              • "DisplayCreatedOn": "2022-12-05T13:15:31",
              • "CreatedOn": 1670246131615,
              • "EditedBy": "peter.parker",
              • "DisplayEditedOn": "2022-12-05T13:16:49",
              • "EditedOn": 1670246209069,
              • "AssignedToVersion": {

                • "AssignedToNumber": "1.0.0",
                • "AssignedToTitle": "ERP & PIM"

                }

              },
            • "DisplayFields": {

              • "TotalTestCases": 0,
              • "PercentageOfAutomatedCases": "-",
              • "AutomationCoverage": [ ],
              • "AssigneesOfTestCases": [ ],
              • "TestCasesWithAssignee": "-"

              }

            },
          • "__meta": {

            • "creator": "peter.parker",
            • "modifier": "peter.parker",
            • "docRef": "TestSuite-dm/1619",
            • "modelReference": "TestSuite-dm",
            • "createdAt": "2022-12-05T13:15:31",
            • "modifiedAt": "2023-11-20T03:59:04",
            • "modelVersion": null

            }

          }

        },
      • {

        • "docRef": "TestSuite-dm/6c1de7de-04af-498e-848d-fea2d30e2ab5",
        • "documentModelName": "TestSuite-dm",
        • "document": {

          • "Root": {

            • "General": {

              • "ProjectId": "P_9",
              • "ProjectVersionNumber": "1.0.0",
              • "SubprojectId": "SP_2",
              • "Title": "Cart management",
              • "Tags": "cart,shopping",
              • "Description": "Manage the operation on a cart, e.g add/remove products into cart",
              • "Id": "S_22",
              • "TechnicalId": "a318e847-5932-4fc1-80b7-f8d8bdd0bbce",
              • "Order": "9",
              • "TenantId": "T_1",
              • "SearchableTags": "|[cart]|,|[shopping]|",
              • "RecommendedPriority": {

                • "Value": "HIGH"

                },
              • "SearchTags": [

                • {

                  • "Value": "cart"

                  },
                • {

                  • "Value": "shopping"

                  }

                ]

              },
            • "Metadata": {

              • "CreatedBy": "trung",
              • "DisplayCreatedOn": "2024-11-11T06:51:56",
              • "CreatedOn": 1731307916049,
              • "EditedBy": "trung",
              • "DisplayEditedOn": "2024-11-11T06:52:39",
              • "EditedOn": 1731307959239,
              • "AssignedToVersion": {

                • "AssignedToNumber": "1.0.0",
                • "AssignedToTitle": "ERP & PIM"

                }

              },
            • "Attachments": [

              • {

                • "FileName": "16K.jpg",
                • "CreatedAt": "2024-11-11T06:51:48",
                • "UploadOn": "2024-11-11",
                • "OriginalFileName": "16K.jpg",
                • "UploadBy": "trung",
                • "Referenced": false,
                • "CopyNumber": 0,
                • "ThumbnailId": "e5c3456e-4d85-4307-aa7b-a65facddb6e7",
                • "File": {

                  • "content": null,
                  • "attachment_id": "7cfd7350-8839-4683-a20c-f4de5068c9d6",
                  • "internal_filename": "1731307906841-6fd09549-27f7-4959-a8f7-faefacdbda3c.jpg",
                  • "original_filename": "16K.jpg",
                  • "size": 86838,
                  • "mime_type": "image/jpeg"

                  }

                }

              ],
            • "DisplayFields": {

              • "TotalTestCases": 0,
              • "PercentageOfAutomatedCases": "-",
              • "AutomationCoverage": [ ],
              • "AssigneesOfTestCases": [ ],
              • "TestCasesWithAssignee": "-"

              }

            },
          • "__meta": {

            • "creator": "trung",
            • "modifier": "trung",
            • "createdAt": "2024-11-11T06:51:55",
            • "modifiedAt": "2024-11-11T06:52:39",
            • "modelReference": "TestSuite-dm",
            • "docRef": "TestSuite-dm/6c1de7de-04af-498e-848d-fea2d30e2ab5",
            • "modelVersion": null

            }

          }

        }

      ]

    },
  • "filterItemMap": {

    • "Root.DisplayFields.AssigneesOfTestCases": [

      • {

        • "value": "none",
        • "label": "None"

        }

      ],
    • "Root.General.RecommendedPriority.Value": [

      • {

        • "value": "MEDIUM",
        • "label": "MEDIUM"

        },
      • {

        • "value": "HIGH",
        • "label": "HIGH"

        }

      ]

    }

  }

}

Update test suite

Update content of a test suite

Authorizations:

bearerAuth

header Parameters

Project-Id required	string Project Id or the project document reference
Subproject-Id	string Sub Project Id or the project document reference. It might be required if you want to access the sub project's resource

Request Body schema: application/json

required

id required	string id of the operation
jsonrpc required	string must be 2.0
method required	string MODIFY_DOCUMENT
required	object

Responses

https://q12-tmt.com/api/v2/rpc (MODIFY_DOCUMENT for Test suite)

Request samples

• Payload

Content type

application/json

{

• "id": "MODIFY_TEST_SUITE",
• "method": "MODIFY_DOCUMENT",
• "params": {

  • "document": {

    • "Root": {

      • "General": {

        • "ProjectId": "P_9",
        • "ProjectVersionNumber": "1.0.0",
        • "SubprojectId": "SP_2",
        • "Title": "Incoming order",
        • "Id": "S_14",
        • "TechnicalId": "c1cd1a9b-5313-4fb0-8f05-ce194820c8d4",
        • "TenantId": "T_1",
        • "Order": "1",
        • "Tags": "order,payment,address",
        • "Description": "This suites contains the test cases that test for the incoming orders",
        • "SearchableTags": "|[order]|",
        • "RecommendedPriority": {

          • "Value": "HIGH"

          },
        • "SearchTags": [

          • {

            • "Value": "order"

            }

          ]

        },
      • "Metadata": {

        • "CreatedBy": "peter.parker",
        • "DisplayCreatedOn": "2022-12-05T13:13:57",
        • "CreatedOn": 1670246037200,
        • "EditedBy": "trung",
        • "DisplayEditedOn": "2024-11-11T03:42:35",
        • "EditedOn": 1731296555565,
        • "AssignedToVersion": {

          • "AssignedToNumber": "1.0.0",
          • "AssignedToTitle": "ERP & PIM"

          },
        • "LatestTestCaseExecutionData": {

          • "TestedOn": "2023-08-07T12:17:15",
          • "TestedBy": "peter.lange",
          • "TestRunId": "R_3",
          • "TestRunTitle": "Run 1",
          • "VersionId": "1.0.0",
          • "VersionTitle": "ERP & PIM",
          • "TestCaseId": "C_39",
          • "TestCaseTitle": "Yet another test case"

          }

        },
      • "Attachments": [

        • {

          • "FileName": "index.country.m3u",
          • "CreatedAt": "2024-11-11T03:42:30",
          • "UploadOn": "2024-11-11",
          • "OriginalFileName": "index.country.m3u",
          • "UploadBy": "trung",
          • "Referenced": false,
          • "CopyNumber": 0,
          • "ThumbnailId": "",
          • "File": {

            • "content": null,
            • "attachment_id": "4e66782a-65e6-427a-9aaf-7a1c365d9290",
            • "internal_filename": "1731296538385-adb3718b-9bed-4e6a-acb8-112c2a975d4c.m3u",
            • "original_filename": "index.country.m3u",
            • "size": 3973812,
            • "mime_type": "application/vnd.apple.mpegurl"

            }

          }

        ]

      },
    • "__meta": {

      • "creator": "peter.parker",
      • "modifier": "trung",
      • "docRef": "TestSuite-dm/1614",
      • "modelReference": "TestSuite-dm",
      • "createdAt": "2022-12-05T13:13:57",
      • "modifiedAt": "2024-11-11T03:42:35",
      • "modelVersion": null

      }

    },
  • "locale": "en",
  • "docRef": "TestSuite-dm/1614"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "MODIFY_TEST_SUITE",
• "result": null

}

Delete a test suite

Trigger a task request to delete an existing test suite. Task request will then run on background
You can call Get task request periodically to get the task's status

Notice: A test suite is only deleted if it is not in any open test run

Authorizations:

bearerAuth

header Parameters

Project-Id required	string Project Id or the project document reference
Subproject-Id	string Sub Project Id or the project document reference. It might be required if you want to access the sub project's resource

Request Body schema: application/json

required

id required	string id of the operation
jsonrpc required	string must be 2.0
method required	string DELETE_TEST_SUITE
required	object

Responses

https://q12-tmt.com/api/v2/rpc (DELETE_TEST_SUITE)

Request samples

• Payload

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "delete_test_suite_operation_id_1",
• "method": "DELETE_TEST_SUITE",
• "params": {

  • "testSuiteDocRef": "TestSuite-dm/123"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "delete_test_suite_operation_id_1",
• "result": "OK"

}

Get test suites in a test run

Return all test suites that are in a test run

Authorizations:

bearerAuth

header Parameters

Project-Id required	string Project Id or the project document reference
Subproject-Id	string Sub Project Id or the project document reference. It might be required if you want to access the sub project's resource

Request Body schema: application/json

required

id required	string id of the operation
jsonrpc required	string must be 2.0
method required	string GET_TEST_SUITES_IN_RUN
required	object

Responses

https://q12-tmt.com/api/v2/rpc (GET_TEST_SUITES_IN_RUN)

Request samples

• Payload

Content type

application/json

{

• "id": "TestSuites.DataProvider-98",
• "jsonrpc": "2.0",
• "method": "GET_TEST_SUITES_IN_RUN",
• "params": {

  • "testRunDocRef": "TestRun-dm/19517",
  • "filter": {

    • "filters": [

      • "Root.General.ProjectId:P_9",
      • "Root.General.SubprojectId:SP_2",
      • "Root.General.ProjectVersionNumber:1.0.0"

      ],
    • "fulltext": "",
    • "lang": ""

    },
  • "page": {

    • "offset": 0,
    • "limit": 50

    },
  • "sort": [

    • {

      • "order": "target.Root.General.Title ASC"

      }

    ]

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "TestSuites.DataProvider-98",
• "result": {

  • "fullSize": 2,
  • "page": {

    • "offset": 0,
    • "limit": 50

    },
  • "entries": [

    • {

      • "docRef": "TestRunTestSuiteTestSuite-dm/18283",
      • "documentModelName": "TestRunTestSuiteTestSuite-dm",
      • "document": {

        • "target": {

          • "Root": {

            • "General": {

              • "ProjectId": "P_9",
              • "ProjectVersionNumber": "1.0.0",
              • "SubprojectId": "SP_2",
              • "Title": "01 Payment types and capturing",
              • "Id": "S_15",
              • "TechnicalId": "d773eab2-f92d-43e1-9ca7-ee3ee1ebd2a6",
              • "TenantId": "T_1",
              • "Order": "2",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              },
            • "Metadata": {

              • "CreatedBy": "peter.parker",
              • "DisplayCreatedOn": "2022-12-05T13:14:09",
              • "CreatedOn": 1670246049789,
              • "EditedBy": "peter.parker",
              • "DisplayEditedOn": "2022-12-05T13:14:18",
              • "EditedOn": 1670246058338,
              • "AssignedToVersion": {

                • "AssignedToNumber": "1.0.0",
                • "AssignedToTitle": "ERP & PIM"

                }

              },
            • "DisplayFields": {

              • "TotalRunningTestCases": 0,
              • "TotalTestCases": 0

              }

            },
          • "__meta": {

            • "creator": "peter.parker",
            • "modifier": "peter.parker",
            • "docRef": "TestSuite-dm/1615",
            • "modelReference": "TestSuite-dm",
            • "createdAt": "2022-12-05T13:14:09",
            • "modifiedAt": "2023-11-20T03:59:04",
            • "modelVersion": null

            },
          • "docRef": "TestSuite-dm/1615"

          },
        • "relationship": {

          • "id": "TestRunTestSuiteAdditionalFields-dm",
          • "Root": {

            • "General": {

              • "Assignee": "peter.lange",
              • "TenantId": "T_1",
              • "ProjectId": "P_9",
              • "SubprojectId": "SP_2",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              }

            },
          • "__meta": {

            • "creator": "peter.lange",
            • "modifier": "peter.lange",
            • "docRef": "TestRunTestSuiteAdditionalFields-dm/19519",
            • "modelReference": "TestRunTestSuiteAdditionalFields-dm",
            • "createdAt": "2023-08-07T12:12:51",
            • "modifiedAt": "2023-10-31T07:44:02",
            • "modelVersion": null

            },
          • "docRef": "TestRunTestSuiteAdditionalFields-dm/19519"

          }

        }

      },
    • {

      • "docRef": "TestRunTestSuiteTestSuite-dm/18284",
      • "documentModelName": "TestRunTestSuiteTestSuite-dm",
      • "document": {

        • "target": {

          • "Root": {

            • "General": {

              • "ProjectId": "P_9",
              • "ProjectVersionNumber": "1.0.0",
              • "SubprojectId": "SP_2",
              • "Title": "02 Pending payments",
              • "Id": "S_16",
              • "TechnicalId": "584fa015-7f25-438b-b9ad-15ec5e4c886f",
              • "TenantId": "T_1",
              • "Order": "3",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              },
            • "Metadata": {

              • "CreatedBy": "peter.parker",
              • "DisplayCreatedOn": "2022-12-05T13:14:28",
              • "CreatedOn": 1670246068283,
              • "EditedBy": "peter.parker",
              • "DisplayEditedOn": "2022-12-05T13:14:35",
              • "EditedOn": 1670246075967,
              • "AssignedToVersion": {

                • "AssignedToNumber": "1.0.0",
                • "AssignedToTitle": "ERP & PIM"

                }

              },
            • "DisplayFields": {

              • "TotalRunningTestCases": 0,
              • "TotalTestCases": 0

              }

            },
          • "__meta": {

            • "creator": "peter.parker",
            • "modifier": "peter.parker",
            • "docRef": "TestSuite-dm/1616",
            • "modelReference": "TestSuite-dm",
            • "createdAt": "2022-12-05T13:14:28",
            • "modifiedAt": "2023-11-20T03:59:04",
            • "modelVersion": null

            },
          • "docRef": "TestSuite-dm/1616"

          },
        • "relationship": {

          • "id": "TestRunTestSuiteAdditionalFields-dm",
          • "Root": {

            • "General": {

              • "Assignee": "peter.lange",
              • "TenantId": "T_1",
              • "ProjectId": "P_9",
              • "SubprojectId": "SP_2",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              }

            },
          • "__meta": {

            • "creator": "peter.lange",
            • "modifier": "peter.lange",
            • "docRef": "TestRunTestSuiteAdditionalFields-dm/19520",
            • "modelReference": "TestRunTestSuiteAdditionalFields-dm",
            • "createdAt": "2023-08-07T12:12:51",
            • "modifiedAt": "2023-10-31T07:44:02",
            • "modelVersion": null

            },
          • "docRef": "TestRunTestSuiteAdditionalFields-dm/19520"

          }

        }

      }

    ]

  }

}