Folder

• postGet test folder detail
• postCreate a new test folder
• postUpdate test folder
• postDelete a test folder

API docs by Redocly

TMT API (1.0.0)

Download OpenAPI specification:Download

API working with Test folders in TMT

Get test folder detail

Get content of a test folder by given 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 Folder)

Request samples

• Payload

Content type

application/json

{

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

  • "docRef": "TestFolder-dm/20753"

  }

}

Response samples

• 200

Content type

application/json

{

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

  • "docRef": "TestFolder-dm/20753",
  • "documentModelName": "TestFolder-dm",
  • "document": {

    • "Root": {

      • "General": {

        • "ProjectId": "P_9",
        • "ProjectVersionNumber": "1.2.0",
        • "SubprojectId": "SP_1",
        • "TestSuiteId": "S_1",
        • "Title": "Responsiveness",
        • "Id": "F_2",
        • "TechnicalId": "88f3d26c-2b6a-4535-a5d2-2e0a6b72d40a",
        • "TenantId": "T_1",
        • "Description": "Folder cotnains the test cases that tests the responsiveness"

        },
      • "Metadata": {

        • "CreatedBy": "tmtdev",
        • "DisplayCreatedOn": "2023-03-07T12:41:29",
        • "CreatedOn": 1678192889715,
        • "EditedBy": "trung",
        • "DisplayEditedOn": "2024-11-12T04:57:36",
        • "EditedOn": 1731387456687,
        • "IsImported": false

        },
      • "Attachments": [

        • {

          • "FileName": "16K.jpg",
          • "CreatedAt": "2024-11-12T04:57:11",
          • "UploadOn": "2024-11-12",
          • "OriginalFileName": "16K.jpg",
          • "UploadBy": "trung",
          • "Referenced": false,
          • "CopyNumber": 0,
          • "ThumbnailId": "f2c2ee04-b8f6-490d-b6f0-68e1ac486a76",
          • "File": {

            • "content": null,
            • "attachment_id": "2c384792-c948-44c9-9212-95376ac75000",
            • "internal_filename": "1731387430179-12e66177-78d4-4eee-b598-faa629e7ddc8.jpg",
            • "original_filename": "16K.jpg",
            • "size": 86838,
            • "mime_type": "image/jpeg"

            }

          }

        ]

      },
    • "__meta": {

      • "creator": "SYSTEM",
      • "modifier": "trung",
      • "docRef": "TestFolder-dm/20753",
      • "modelReference": "TestFolder-dm",
      • "createdAt": "2023-08-09T06:45:07",
      • "modifiedAt": "2024-11-12T04:57:36",
      • "modelVersion": null

      }

    }

  }

}

Create a new test folder

Create a new test folder and add it into a test case tree.
The new test folder will be located at the end of the folder (or the test suite if it is at the root level)

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 CREATE_TEST_CASE_TREE_NODE
required	object

Responses

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

Request samples

• Payload

Content type

application/json

{

• "id": "addTestFolder_d471998c-cfdf-432c-9e9b-a449713e2ce6",
• "method": "CREATE_TEST_CASE_TREE_NODE",
• "jsonrpc": "2.0",
• "params": {

  • "document": {

    • "Root": {

      • "General": {

        • "ProjectId": "P_9",
        • "ProjectVersionNumber": "1.2.0",
        • "SubprojectId": "SP_1",
        • "TestSuiteId": "S_1",
        • "Title": "Subscription",
        • "Description": "Contain the test cases that tests the subscription feature"

        },
      • "Attachments": [

        • {

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

            • "content": null,
            • "attachment_id": "7449ab68-bd5c-4034-b79f-563a402f47f0",
            • "internal_filename": "1731394529389-8f161c46-a102-4911-a7ac-f11c7aa71c8d.jpg",
            • "original_filename": "16K.jpg",
            • "size": 86838,
            • "mime_type": "image/jpeg"

            },
          • "CreatedAt": "2024-11-12T06:55:30",
          • "UploadOn": "2024-11-12",
          • "OriginalFileName": "16K.jpg",
          • "UploadBy": "trung",
          • "Referenced": false,
          • "CopyNumber": 0,
          • "ThumbnailId": "dc6c84de-fe26-496b-8377-b46e21025511"

          }

        ]

      },
    • "id": "-1"

    },
  • "documentModelName": "TestFolder-dm",
  • "locale": "en",
  • "parentNodeDocRef": "TestSuite-dm/20740"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "addTestFolder_d471998c-cfdf-432c-9e9b-a449713e2ce6",
• "result": {

  • "linkDescriptor": {

    • "relationshipModel": "TestSuiteTestCaseFolder-rm",
    • "entities": [

      • {

        • "role": "TestSuite",
        • "modelName": "TestSuite-dm",
        • "docRef": "TestSuite-dm/20740"

        },
      • {

        • "role": "TestCaseFolderSupertype",
        • "modelName": "TestFolder-dm",
        • "docRef": "TestFolder-dm/47532e25-b336-4375-a72b-b5173fe58571"

        }

      ],
    • "predecessorLinkRef": null,
    • "position": "BOTTOM"

    },
  • "id": "947429"

  }

}

Update test folder

Update test folder content

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 (UPDATE_TEST_CASE_TREE_NODE)

Request samples

• Payload

Content type

application/json

{

• "id": "modifyTestFolder_7ed09ca9-955b-43be-9aa4-95afd8e9d20c",
• "method": "UPDATE_TEST_CASE_TREE_NODE",
• "jsonrpc": "2.0",
• "params": {

  • "document": {

    • "Root": {

      • "General": {

        • "ProjectId": "P_9",
        • "ProjectVersionNumber": "1.2.0",
        • "SubprojectId": "SP_1",
        • "TestSuiteId": "S_1",
        • "Title": "Responsiveness",
        • "Id": "F_2",
        • "TechnicalId": "88f3d26c-2b6a-4535-a5d2-2e0a6b72d40a",
        • "TenantId": "T_1",
        • "Description": "EDITED Folder cotnains the test cases that tests the responsiveness"

        },
      • "Metadata": {

        • "CreatedBy": "tmtdev",
        • "DisplayCreatedOn": "2023-03-07T12:41:29",
        • "CreatedOn": 1678192889715,
        • "EditedBy": "trung",
        • "DisplayEditedOn": "2024-11-12T04:57:36",
        • "EditedOn": 1731387456687,
        • "IsImported": false

        },
      • "Attachments": [

        • {

          • "FileName": "16K.jpg",
          • "CreatedAt": "2024-11-12T04:57:11",
          • "UploadOn": "2024-11-12",
          • "OriginalFileName": "16K.jpg",
          • "UploadBy": "trung",
          • "Referenced": false,
          • "CopyNumber": 0,
          • "ThumbnailId": "f2c2ee04-b8f6-490d-b6f0-68e1ac486a76",
          • "File": {

            • "content": null,
            • "attachment_id": "2c384792-c948-44c9-9212-95376ac75000",
            • "internal_filename": "1731387430179-12e66177-78d4-4eee-b598-faa629e7ddc8.jpg",
            • "original_filename": "16K.jpg",
            • "size": 86838,
            • "mime_type": "image/jpeg"

            }

          }

        ]

      },
    • "__meta": {

      • "creator": "SYSTEM",
      • "modifier": "trung",
      • "docRef": "TestFolder-dm/20753",
      • "modelReference": "TestFolder-dm",
      • "createdAt": "2023-08-09T06:45:07",
      • "modifiedAt": "2024-11-12T04:57:36",
      • "modelVersion": null

      }

    },
  • "locale": "en",
  • "docRef": "TestFolder-dm/20753"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "modifyTestFolder_7ed09ca9-955b-43be-9aa4-95afd8e9d20c",
• "result": {

  • "docRef": "TestFolder-dm/20753",
  • "documentModelName": "TestFolder-dm",
  • "document": {

    • "Root": {

      • "General": {

        • "Title": "Responsiveness",
        • "Id": "F_2",
        • "Description": "EDITED Folder cotnains the test cases that tests the responsiveness"

        }

      }

    }

  }

}

Delete a test folder

Delete a test folder and its content. All test cases within test folder must not be in any open 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_DOCUMENT
required	object

Responses

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

Request samples

• Payload

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "DELETE_FOLDER_01",
• "method": "DELETE_FOLDER",
• "params": {

  • "docRef": "TestFolder-dm/47532e25-b336-4375-a72b-b5173fe58571"

  }

}

Response samples

• 200

Content type

application/json

{

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

}