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 a test suite document by its document reference using the GET_TMT_DOCUMENT operation.

Authorizations:

bearerAuth

Request Body schema: application/json

required

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

Responses

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

Request samples

• Payload

Content type

application/json

{

• "id": "GET_TMT_DOCUMENT-1",
• "method": "GET_TMT_DOCUMENT",
• "jsonrpc": "2.0",
• "params": {

  • "docRef": "TestSuite-dm/de462a40-40b2-49dc-9848-f253c3a37766"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "GET_TMT_DOCUMENT-1",
• "result": {

  • "docRef": "TestSuite-dm/de462a40-40b2-49dc-9848-f253c3a37766",
  • "documentModelName": "TestSuite-dm",
  • "document": {

    • "Root": {

      • "General": {

        • "Id": "S_22",
        • "Order": "4.05",
        • "ProjectId": "P_6",
        • "ProjectVersionNumber": "5.0.0",
        • "SearchableTags": null,
        • "SubprojectId": "_",
        • "TechnicalId": "270adeb2-0c75-4479-891d-5616b245f7e2",
        • "TenantId": "T_1",
        • "Title": "Here is the test suite",
        • "RecommendedPriority": {

          • "Value": "MEDIUM"

          }

        },
      • "Metadata": {

        • "CreatedBy": "tmtdev",
        • "CreatedOn": 1732689508783,
        • "DisplayCreatedOn": "2024-11-27T06:38:28",
        • "DisplayEditedOn": "2026-05-07T02:43:15",
        • "EditedBy": "tmtdoc",
        • "EditedOn": 1778121795261,
        • "IsImported": false,
        • "AssignedToVersion": { },
        • "LatestTestCaseExecutionData": {

          • "TestCaseId": "C_1",
          • "TestCaseTitle": "1 edited",
          • "TestRunId": "R_5",
          • "TestedOn": "2026-01-19T04:51:40"

          }

        }

      },
    • "__meta": {

      • "createdAt": "2026-04-14T08:37:08",
      • "creator": "SYSTEM",
      • "docRef": "TestSuite-dm/de462a40-40b2-49dc-9848-f253c3a37766",
      • "modelReference": "TestSuite-dm",
      • "modelVersion": null,
      • "modifiedAt": "2026-05-07T02:43:14",
      • "modifier": "tmtdoc"

      }

    }

  }

}

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

{

• "jsonrpc": "2.0",
• "id": "LIST_TEST_SUITES_be255843-c709-4d92-a018-2a1107bc5af2",
• "method": "LIST_TEST_SUITES",
• "params": {

  • "testCaseFilters": [ ],
  • "projectSpec": {

    • "projectId": "P_6",
    • "subProjectId": "_",
    • "projectVersionNumber": "5.0.0"

    },
  • "query": {

    • "targetDocumentModel": "TestSuite-dm",
    • "projectionName": "document",
    • "constraint": null,
    • "sort": [

      • {

        • "field": "/Root/General/Order",
        • "direction": "ASC",
        • "nullHandling": "NULLS_LAST",
        • "ignoreCase": true

        }

      ],
    • "paging": {

      • "pageNumber": 0,
      • "pageSize": 50

      }

    }

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "LIST_TEST_SUITES_be255843-c709-4d92-a018-2a1107bc5af2",
• "result": {

  • "fullSize": 5,
  • "page": {

    • "pageNumber": 0,
    • "pageSize": 50

    },
  • "entries": [

    • {

      • "docRef": "TestSuite-dm/5a6e558b-9f66-491f-9dce-95cc170d4d4b",
      • "documentModelName": "TestSuite-dm",
      • "document": {

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

          • "General": {

            • "Id": "S_21",
            • "Order": "0.2",
            • "ProjectId": "P_6",
            • "ProjectVersionNumber": "5.0.0",
            • "SubprojectId": "_",
            • "TechnicalId": "62f87d74-a0cc-4bf6-bb72-6030998f2d47",
            • "TenantId": "T_1",
            • "Title": "1",
            • "RecommendedPriority": {

              • "Value": "MEDIUM"

              }

            },
          • "Metadata": {

            • "CreatedBy": "tmtdev",
            • "CreatedOn": 1732689505974,
            • "DisplayCreatedOn": "2024-11-27T06:38:25",
            • "DisplayEditedOn": "2024-11-27T06:47:15",
            • "EditedBy": "tmtdev",
            • "EditedOn": 1732690035626,
            • "IsImported": false

            },
          • "DisplayFields": {

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

            }

          },
        • "__meta": {

          • "createdAt": "2026-04-14T08:37:07",
          • "creator": "SYSTEM",
          • "docRef": "TestSuite-dm/5a6e558b-9f66-491f-9dce-95cc170d4d4b",
          • "modelReference": "TestSuite-dm",
          • "modelVersion": null,
          • "modifiedAt": "2026-04-14T08:37:07",
          • "modifier": "SYSTEM"

          }

        }

      },
    • {

      • "docRef": "TestSuite-dm/80c16135-046c-4eb1-a821-6362683b4a70",
      • "documentModelName": "TestSuite-dm",
      • "document": {

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

          • "General": {

            • "Id": "S_20",
            • "Order": "0.3",
            • "ProjectId": "P_6",
            • "ProjectVersionNumber": "5.0.0",
            • "SubprojectId": "_",
            • "TechnicalId": "5cdbdedc-9e68-462e-b969-d0454ec7ab4c",
            • "TenantId": "T_1",
            • "Title": "1",
            • "RecommendedPriority": {

              • "Value": "MEDIUM"

              }

            },
          • "Metadata": {

            • "CreatedBy": "tmtdev",
            • "CreatedOn": 1732689501554,
            • "DisplayCreatedOn": "2024-11-27T06:38:21",
            • "DisplayEditedOn": "2024-11-27T06:47:15",
            • "EditedBy": "tmtdev",
            • "EditedOn": 1732690035860,
            • "IsImported": false

            },
          • "DisplayFields": {

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

            }

          },
        • "__meta": {

          • "createdAt": "2026-04-14T08:37:07",
          • "creator": "SYSTEM",
          • "docRef": "TestSuite-dm/80c16135-046c-4eb1-a821-6362683b4a70",
          • "modelReference": "TestSuite-dm",
          • "modelVersion": null,
          • "modifiedAt": "2026-04-14T08:37:07",
          • "modifier": "SYSTEM"

          }

        }

      },
    • {

      • "docRef": "TestSuite-dm/3bebee20-fa5c-455e-b965-9c99699f8d73",
      • "documentModelName": "TestSuite-dm",
      • "document": {

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

          • "General": {

            • "Id": "S_19",
            • "Order": "0.4",
            • "ProjectId": "P_6",
            • "ProjectVersionNumber": "5.0.0",
            • "SubprojectId": "_",
            • "TechnicalId": "1da1521a-3e85-44eb-9299-5037b4ad395a",
            • "TenantId": "T_1",
            • "Title": "1",
            • "RecommendedPriority": {

              • "Value": "MEDIUM"

              }

            },
          • "Metadata": {

            • "CreatedBy": "tmtdev",
            • "CreatedOn": 1732689499375,
            • "DisplayCreatedOn": "2024-11-27T06:38:19",
            • "DisplayEditedOn": "2024-11-27T06:47:16",
            • "EditedBy": "tmtdev",
            • "EditedOn": 1732690036102,
            • "IsImported": false

            },
          • "DisplayFields": {

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

            }

          },
        • "__meta": {

          • "createdAt": "2026-04-14T08:37:07",
          • "creator": "SYSTEM",
          • "docRef": "TestSuite-dm/3bebee20-fa5c-455e-b965-9c99699f8d73",
          • "modelReference": "TestSuite-dm",
          • "modelVersion": null,
          • "modifiedAt": "2026-04-14T08:37:07",
          • "modifier": "SYSTEM"

          }

        }

      },
    • {

      • "docRef": "TestSuite-dm/e0a40b91-d3ba-4e96-b16e-6f50ea635774",
      • "documentModelName": "TestSuite-dm",
      • "document": {

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

          • "General": {

            • "Id": "S_18",
            • "Order": "0.5",
            • "ProjectId": "P_6",
            • "ProjectVersionNumber": "5.0.0",
            • "SubprojectId": "_",
            • "TechnicalId": "fa4ee1d4-5753-4499-8533-007075fd1f5b",
            • "TenantId": "T_1",
            • "Title": "1",
            • "RecommendedPriority": {

              • "Value": "MEDIUM"

              }

            },
          • "Metadata": {

            • "CreatedBy": "tmtdev",
            • "CreatedOn": 1732689497192,
            • "DisplayCreatedOn": "2024-11-27T06:38:17",
            • "DisplayEditedOn": "2024-11-27T06:47:16",
            • "EditedBy": "tmtdev",
            • "EditedOn": 1732690036298,
            • "IsImported": false

            },
          • "DisplayFields": {

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

            }

          },
        • "__meta": {

          • "createdAt": "2026-04-14T08:37:06",
          • "creator": "SYSTEM",
          • "docRef": "TestSuite-dm/e0a40b91-d3ba-4e96-b16e-6f50ea635774",
          • "modelReference": "TestSuite-dm",
          • "modelVersion": null,
          • "modifiedAt": "2026-04-14T08:37:06",
          • "modifier": "SYSTEM"

          }

        }

      },
    • {

      • "docRef": "TestSuite-dm/c7c50f56-f266-4cf8-8f87-1905fff404e8",
      • "documentModelName": "TestSuite-dm",
      • "document": {

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

          • "General": {

            • "Id": "S_17",
            • "Order": "0.6",
            • "ProjectId": "P_6",
            • "ProjectVersionNumber": "5.0.0",
            • "SubprojectId": "_",
            • "TechnicalId": "19c011aa-e20a-48d6-b9e8-6e2258d7feaa",
            • "TenantId": "T_1",
            • "Title": "1",
            • "RecommendedPriority": {

              • "Value": "MEDIUM"

              }

            },
          • "Metadata": {

            • "CreatedBy": "tmtdev",
            • "CreatedOn": 1732689495033,
            • "DisplayCreatedOn": "2024-11-27T06:38:15",
            • "DisplayEditedOn": "2024-11-27T06:47:16",
            • "EditedBy": "tmtdev",
            • "EditedOn": 1732690036537,
            • "IsImported": false

            },
          • "DisplayFields": {

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

            }

          },
        • "__meta": {

          • "createdAt": "2026-04-14T08:37:06",
          • "creator": "SYSTEM",
          • "docRef": "TestSuite-dm/c7c50f56-f266-4cf8-8f87-1905fff404e8",
          • "modelReference": "TestSuite-dm",
          • "modelVersion": null,
          • "modifiedAt": "2026-04-14T08:37:06",
          • "modifier": "SYSTEM"

          }

        }

      }

    ],
  • "links": null,
  • "otherResults": {

    • "filterItemMap": {

      • "/Root/DisplayFields/AssigneesOfTestCases": [

        • {

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

          }

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

        • {

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

          }

        ],
      • "/Root/DisplayFields/SearchTagsFilter": [

        • {

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

          }

        ]

      }

    }

  }

}

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

{

• "jsonrpc": "2.0",
• "id": "TestRunTestSuite_TestSuites.DataProvider-1",
• "method": "GET_TEST_SUITES_IN_RUN",
• "params": {

  • "testRunDocRef": "TestRun-dm/f90f07d9-af24-4cf9-b8ab-26c808d2876a",
  • "page": {

    • "pageNumber": 0,
    • "pageSize": 50

    },
  • "sort": [

    • {

      • "field": "/target/Root/General/Title",
      • "direction": "ASC",
      • "nullHandling": "NULLS_LAST",
      • "ignoreCase": true

      }

    ]

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "TestRunTestSuite_TestSuites.DataProvider-1",
• "result": {

  • "fullSize": 1,
  • "page": {

    • "pageNumber": 0,
    • "pageSize": 50

    },
  • "entries": [

    • {

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

        • "target": {

          • "Root": {

            • "General": {

              • "Id": "S_1",
              • "ProjectId": "P_6",
              • "ProjectVersionNumber": "5.0.0",
              • "SubprojectId": "_",
              • "Tags": "",
              • "TenantId": "T_1",
              • "Title": "Suiet 1",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              },
            • "Metadata": {

              • "IsFrozenByClosedVersion": false

              },
            • "DisplayFields": {

              • "TotalRunningTestCases": 56,
              • "TotalTestCases": 56

              }

            },
          • "__meta": {

            • "docRef": "TestSuite-dm/92aed588-40e7-4cfb-bd9a-832f03b525ae"

            },
          • "docRef": "TestSuite-dm/92aed588-40e7-4cfb-bd9a-832f03b525ae"

          },
        • "relationship": {

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

            • "General": {

              • "Assignee": "tmtdev",
              • "ProjectId": "P_6",
              • "SubprojectId": "_",
              • "TenantId": "T_1",
              • "RecommendedPriority": {

                • "Value": "MEDIUM"

                }

              }

            },
          • "__meta": {

            • "createdAt": "2026-04-14T08:38:34",
            • "creator": "SYSTEM",
            • "docRef": "TestRunTestSuiteAdditionalFields-dm/589f4fc0-84e3-4785-aa2e-971abb425b06",
            • "modelReference": "TestRunTestSuiteAdditionalFields-dm",
            • "modelVersion": null,
            • "modifiedAt": "2026-04-14T08:38:34",
            • "modifier": "SYSTEM"

            },
          • "docRef": "TestRunTestSuiteAdditionalFields-dm/589f4fc0-84e3-4785-aa2e-971abb425b06"

          }

        }

      }

    ],
  • "links": null,
  • "otherResults": null

  }

}