Zum Hauptinhalt springen

Test Case in Run

TMT API (1.0.0)

Download OpenAPI specification:Download

API working with Test cases in run

Get test case execution detail

Return detailed information of a test execution document

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_CASE_EXECUTION

required
object

Responses

Request samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "GET_TEST_CASE_EXECUTION_55e7567c-c3ff-4c76-904f-05508a7bddda",
  • "method": "GET_TEST_CASE_EXECUTION",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "GET_TEST_CASE_EXECUTION_55e7567c-c3ff-4c76-904f-05508a7bddda",
  • "result": {
    }
}

Get test case executions

Return detailed information of multiple test execution documents

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_CASE_EXECUTIONS

required
object

Responses

Request samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "GetTestExecutionsOperation",
  • "method": "GET_TEST_EXECUTIONS",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "GetTestExecutionsOperation",
  • "result": {
    }
}

Add test cases to run

Add test cases of a test suite into a test run
Notice:

  • This is not applicable for closed test run
  • All test cases must be in the same suite
  • The test suite must be added into the Run first before adding TC to 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

ADD_TEST_CASES_TO_RUN

required
object

Responses

Request samples

Content type
application/json
{
  • "id": "ADD_TEST_CASES_TO_RUN_1",
  • "method": "ADD_TEST_CASES_TO_RUN",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "ADD_TEST_CASES_TO_RUN_1",
  • "result": null
}

Add test cases to run by id

Add test cases of a test suite into a test run by using test case's id
Notice:

  • This is not applicable for closed test run
  • All test cases must be in the same suite
  • Test suites cointaing test cases which were not added to the test run yet will be added automatically
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_TEST_CASES_TO_RUN_BY_ID

required
object

Responses

Request samples

Content type
application/json
{
  • "id": "ADD_TEST_CASES_TO_RUN_1",
  • "method": "ADD_TEST_CASES_TO_RUN_BY_ID",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "ADD_TEST_CASES_TO_RUN_1",
  • "result": null
}

Add test cases to run async by id

Add test cases of a test suite into a test run. The process submit a task request to add the test case into Run asynchronously. The operation simply returns the document reference of the task request. Which you can refer to get the task status.
Notice:

  • This is not applicable for closed test run
  • All test cases must be in the same suite
  • Test suites containing test cases which were not added to the test run yet will be added automatically
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_TEST_CASES_TO_RUN_BY_ID

required
object

Responses

Request samples

Content type
application/json
{
  • "id": "ADD_TEST_CASES_TO_RUN_1",
  • "method": "ADD_TEST_CASES_TO_RUN_BY_ID",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "ADD_TEST_CASES_TO_RUN_1",
  • "result": null
}

Delete test cases from run

Delete test cases from run. This is not applicable for closed 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_CASES_FROM_RUN

required
object

Responses

Request samples

Content type
application/json
{
  • "id": "DELETE_TEST_CASES_FROM_RUN-1",
  • "method": "DELETE_TEST_CASES_FROM_RUN",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "ADD_TEST_CASES_TO_RUN_1",
  • "result": null
}

Update a test case execution

Update content of a test case execution. This is not applicable for closed test run
Notice: The result must be not Untested during the update test execution

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

SAVE_TEST_CASE_EXECUTION

required
object

Responses

Request samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "SAVE_TEST_CASE_EXECUTION_42835c59-72d6-43d5-94d6-95b75aaa415b",
  • "method": "SAVE_TEST_CASE_EXECUTION",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "SAVE_TEST_CASE_EXECUTION_42835c59-72d6-43d5-94d6-95b75aaa415b",
  • "result": null
}

Update multiple test case executions

Update content of multiple test case executions. This is not applicable for closed test run
The process submit a task request to modify the test executions asynchronously. The operation simply returns the document reference of the task request. Which you can refer to get the task status.

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

SAVE_TEST_EXECUTIONS_ASYNC

required
object

Responses

Request samples

Content type
application/json
{
  • "id": "SAVE_TEST_EXECUTIONS_ASYNC-123",
  • "method": "SAVE_TEST_EXECUTIONS_ASYNC",
  • "params": {
    }
}

Response samples

Content type
application/json
{
  • "jsonrpc": "2.0",
  • "id": "SAVE_TEST_EXECUTIONS_ASYNC-123",
  • "result": "TaskRequest-dm/661666"
}