Automation

• postExport data structure
• postExport data detail
• postCreate a run for automation.
• getDownload the data structure detail

API docs by Redocly

TMT API (1.0.0)

Download OpenAPI specification:Download

API working with Automation

Export data structure

Export data structure of a project version, include Version, Test Suite, Test folder and Test case in a hierarchy. The process submit a task request to processing data asynchronously. The operation simply returns the document reference of the task request. Which you can refer to get the task status by calling Get task request

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

Responses

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

Request samples

• Payload

Content type

application/json

{

• "id": "EXPORT_QF_DATA_STRUCTURE",
• "jsonrpc": "2.0",
• "method": "EXPORT_QF_DATA_STRUCTURE",
• "params": {

  • "projectId": "P_1",
  • "subprojectId": "_",
  • "version": "1.0.0"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "EXPORT_QF_DATA_STRUCTURE",
• "result": "TaskRequest-dm/129000"

}

Export data detail

Export data detail of a project version, include Version, Test Suite, Test folder and Test case. The process submit a task request to processing data asynchronously. The operation simply returns the document reference of the task request. Which you can refer to get the task status by calling Get task request

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

Responses

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

Request samples

• Payload

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "EXPORT_QF_DATA_DETAIL",
• "method": "EXPORT_QF_DATA_DETAIL",
• "params": {

  • "projectId": "P_1",
  • "subprojectId": "_",
  • "version": "1.0.0"

  }

}

Response samples

• 200

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "EXPORT_QF_DATA_STRUCTURE",
• "result": "TaskRequest-dm/129000"

}

Create a run for automation.

Create a run for automation

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

Responses

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

Request samples

• Payload

Content type

application/json

{

• "jsonrpc": "2.0",
• "id": "CREATE_QF_RUN_123123",
• "method": "CREATE_QF_RUN",
• "params": {

  • "projectId": "P_28",
  • "subprojectId": "SP_1",
  • "version": "3.0.0",
  • "title": "Auto Run for QF"

  }

}

Response samples

• 200

Content type

application/json

{

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

  • "docRef": "TestRun-dm/661654"

  }

}

Download the data structure detail

Use the id from TaskRequest docRef to download the file exported from other APIs. Data is only available when the task request's status is DONE. That means you can call Get task request periodically to get the status before downloading

Authorizations:

bearerAuth

path Parameters

taskRequestId required

string Example: TaskRequest-dm/c2c83935-a22e-4257-ad0b-3db534e2e212 task request's document reference

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

Responses

https://q12-tmt.com/api/automation/data/{taskRequestId}

Response samples

• 200

Content type

application/json

Example

TmtStructureResponseTmtDetailResponseTmtStructureResponse

{

• "Project": {

  • "technicalId": "Project-dm/32003",
  • "id": "P_1",
  • "title": "Project"

  },
• "children": [

  • {

    • "Version": {

      • "technicalId": "Version-dm/32006",
      • "id": "7ad48175-b43f-44f4-a496-42bbb152ff31",
      • "title": "Migration"

      },
    • "children": [

      • {

        • "TestSuite": {

          • "technicalId": "TestSuite-dm/32008",
          • "id": "S_1",
          • "title": "Test Suite 1"

          },
        • "children": [

          • {

            • "TestFolder": {

              • "technicalId": "TestFolder-dm/32009",
              • "id": "F_1",
              • "title": "TestFolder 1"

              },
            • "children": [

              • {

                • "TestCase": {

                  • "technicalId": "TestCase-dm/32010",
                  • "id": "C_1",
                  • "title": "TestCase 1"

                  }

                }

              ]

            },
          • {

            • "TestCase": {

              • "technicalId": "TestCase-dm/32011",
              • "id": "C_2",
              • "title": "TestCase 2"

              }

            }

          ]

        }

      ]

    }

  ]

}