Skip to content

Latest commit

 

History

History
673 lines (413 loc) · 22.1 KB

TestRunsApi.md

File metadata and controls

673 lines (413 loc) · 22.1 KB

TestRunsApi

All URIs are relative to http://localhost

Method HTTP request Description
apiV2TestRunsDelete DELETE /api/v2/testRuns Delete multiple test runs
apiV2TestRunsIdAutoTestsNamespacesGet GET /api/v2/testRuns/{id}/autoTestsNamespaces Get autotest classes and namespaces in test run
apiV2TestRunsIdDelete DELETE /api/v2/testRuns/{id} Delete test run
apiV2TestRunsIdPurgePost POST /api/v2/testRuns/{id}/purge Permanently delete test run from archive
apiV2TestRunsIdRerunsPost POST /api/v2/testRuns/{id}/reruns Manual autotests rerun in test run
apiV2TestRunsIdRestorePost POST /api/v2/testRuns/{id}/restore Restore test run from the archive
apiV2TestRunsIdStatisticsFilterPost POST /api/v2/testRuns/{id}/statistics/filter Search for the test run test results and build statistics
apiV2TestRunsIdTestPointsResultsGet GET /api/v2/testRuns/{id}/testPoints/results Get test results from the test run grouped by test points
apiV2TestRunsIdTestResultsBulkPut PUT /api/v2/testRuns/{id}/testResults/bulk Partial edit of multiple test results in the test run
apiV2TestRunsIdTestResultsLastModifiedModificationDateGet GET /api/v2/testRuns/{id}/testResults/lastModified/modificationDate Get modification date of last test result of the test run
apiV2TestRunsPurgeBulkPost POST /api/v2/testRuns/purge/bulk Permanently delete multiple test runs from archive
apiV2TestRunsRestoreBulkPost POST /api/v2/testRuns/restore/bulk Restore multiple test runs from the archive
apiV2TestRunsSearchPost POST /api/v2/testRuns/search Search for test runs
apiV2TestRunsUpdateMultiplePost POST /api/v2/testRuns/updateMultiple Update multiple test runs
completeTestRun POST /api/v2/testRuns/{id}/complete Complete TestRun
createAndFillByAutoTests POST /api/v2/testRuns/byAutoTests Create test runs based on autotests and configurations
createAndFillByConfigurations POST /api/v2/testRuns/byConfigurations Create test runs picking the needed test points
createAndFillByWorkItems POST /api/v2/testRuns/byWorkItems Create test run based on configurations and work items
createEmpty POST /api/v2/testRuns Create empty TestRun
getTestRunById GET /api/v2/testRuns/{id} Get TestRun by Id
setAutoTestResultsForTestRun POST /api/v2/testRuns/{id}/testResults Send test results to the test runs in the system
startTestRun POST /api/v2/testRuns/{id}/start Start TestRun
stopTestRun POST /api/v2/testRuns/{id}/stop Stop TestRun
updateEmpty PUT /api/v2/testRuns Update empty TestRun

apiV2TestRunsDelete

Integer apiV2TestRunsDelete(TestRunSelectApiModel)

Delete multiple test runs

 Use case   User sets selection parameters of test runs   System search and delete collection of test runs   System returns the number of deleted test runs

Parameters

Name Type Description Notes
TestRunSelectApiModel TestRunSelectApiModel [optional]

Return type

Integer

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2TestRunsIdAutoTestsNamespacesGet

AutoTestNamespacesCountResponse apiV2TestRunsIdAutoTestsNamespacesGet(id)

Get autotest classes and namespaces in test run

Parameters

Name Type Description Notes
id UUID [default to null]

Return type

AutoTestNamespacesCountResponse

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2TestRunsIdDelete

apiV2TestRunsIdDelete(id)

Delete test run

 Use case   User sets test run internal (guid format) identifier   System search and delete test run

Parameters

Name Type Description Notes
id UUID Test run internal (UUID) identifier [default to null]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2TestRunsIdPurgePost

apiV2TestRunsIdPurgePost(id)

Permanently delete test run from archive

 Use case   User sets archived test run internal (guid format) identifier   System search and purge archived test run

Parameters

Name Type Description Notes
id UUID Test run internal (UUID) identifier [default to null]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2TestRunsIdRerunsPost

ManualRerunApiResult apiV2TestRunsIdRerunsPost(id, ManualRerunSelectApiModel)

Manual autotests rerun in test run

Parameters

Name Type Description Notes
id UUID [default to null]
ManualRerunSelectApiModel ManualRerunSelectApiModel [optional]

Return type

ManualRerunApiResult

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2TestRunsIdRestorePost

apiV2TestRunsIdRestorePost(id)

Restore test run from the archive

 Use case   User sets archived test run internal (guid format) identifier   System search and restore test run

Parameters

Name Type Description Notes
id UUID Unique ID of the test run [default to null]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2TestRunsIdStatisticsFilterPost

TestResultsStatisticsApiResult apiV2TestRunsIdStatisticsFilterPost(id, TestRunStatisticsFilterApiModel)

Search for the test run test results and build statistics

Parameters

Name Type Description Notes
id UUID Test run unique ID [default to null]
TestRunStatisticsFilterApiModel TestRunStatisticsFilterApiModel [optional]

Return type

TestResultsStatisticsApiResult

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2TestRunsIdTestPointsResultsGet

List apiV2TestRunsIdTestPointsResultsGet(id)

Get test results from the test run grouped by test points

Parameters

Name Type Description Notes
id UUID Test run unique ID [default to null]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2TestRunsIdTestResultsBulkPut

apiV2TestRunsIdTestResultsBulkPut(id, TestRunTestResultsPartialBulkSetModel)

Partial edit of multiple test results in the test run

Parameters

Name Type Description Notes
id UUID Test run unique ID [default to null]
TestRunTestResultsPartialBulkSetModel TestRunTestResultsPartialBulkSetModel [optional]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2TestRunsIdTestResultsLastModifiedModificationDateGet

Date apiV2TestRunsIdTestResultsLastModifiedModificationDateGet(id)

Get modification date of last test result of the test run

Parameters

Name Type Description Notes
id UUID Test run unique ID [default to null]

Return type

Date

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

apiV2TestRunsPurgeBulkPost

Integer apiV2TestRunsPurgeBulkPost(TestRunSelectApiModel)

Permanently delete multiple test runs from archive

 Use case   User sets selection parameters of archived test runs   System search and delete collection of archived test runs   System returns the number of deleted archived test runs

Parameters

Name Type Description Notes
TestRunSelectApiModel TestRunSelectApiModel [optional]

Return type

Integer

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2TestRunsRestoreBulkPost

Integer apiV2TestRunsRestoreBulkPost(TestRunSelectApiModel)

Restore multiple test runs from the archive

 Use case   User sets selection parameters of archived test runs   System search and restore collection of archived test runs   System returns the number of restored test runs

Parameters

Name Type Description Notes
TestRunSelectApiModel TestRunSelectApiModel [optional]

Return type

Integer

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2TestRunsSearchPost

List apiV2TestRunsSearchPost(Skip, Take, OrderBy, SearchField, SearchValue, TestRunFilterApiModel)

Search for test runs

Parameters

Name Type Description Notes
Skip Integer Amount of items to be skipped (offset) [optional] [default to null]
Take Integer Amount of items to be taken (limit) [optional] [default to null]
OrderBy String SQL-like ORDER BY statement (column1 ASC DESC , column2 ASC
SearchField String Property name for searching [optional] [default to null]
SearchValue String Value for searching [optional] [default to null]
TestRunFilterApiModel TestRunFilterApiModel [optional]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

apiV2TestRunsUpdateMultiplePost

apiV2TestRunsUpdateMultiplePost(UpdateMultipleTestRunsApiModel)

Update multiple test runs

Parameters

Name Type Description Notes
UpdateMultipleTestRunsApiModel UpdateMultipleTestRunsApiModel [optional]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

completeTestRun

completeTestRun(id)

Complete TestRun

 Use case   User sets test run identifier   User runs method execution   System completes test run   System returns no content response

Parameters

Name Type Description Notes
id UUID Test Run internal identifier (GUID format) [default to null]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

createAndFillByAutoTests

TestRunV2ApiResult createAndFillByAutoTests(CreateTestRunAndFillByAutoTestsApiModel)

Create test runs based on autotests and configurations

This method creates a test run based on an autotest and a configuration.  The difference between the `POST /api/v2/testRuns/byWorkItems` and `POST /api/v2/testRuns/byConfigurations` methods is  that in this method there is no need to create a test plan and work items (test cases and checklists).

Parameters

Name Type Description Notes
CreateTestRunAndFillByAutoTestsApiModel CreateTestRunAndFillByAutoTestsApiModel [optional]

Return type

TestRunV2ApiResult

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createAndFillByConfigurations

TestRunV2ApiResult createAndFillByConfigurations(CreateTestRunAndFillByConfigurationsApiModel)

Create test runs picking the needed test points

This method creates a test run based on a combination of a configuration and a work item(test case or checklist).  Before you create a test run using this method, make sure to create a test plan. Work items must be automated.  This method is different from the `POST /api/v2/testRuns/byWorkItems` method because of the ability to send a  jagged array within the \"<b>testPointSelectors</b>\" parameter.

Parameters

Name Type Description Notes
CreateTestRunAndFillByConfigurationsApiModel CreateTestRunAndFillByConfigurationsApiModel [optional]

Return type

TestRunV2ApiResult

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createAndFillByWorkItems

TestRunV2ApiResult createAndFillByWorkItems(CreateTestRunAndFillByWorkItemsApiModel)

Create test run based on configurations and work items

This method creates a test run based on a combination of configuration and work item (test case or checklist).  Before you create a test run using this method, make sure to create a test plan.  Work items must be automated.

Parameters

Name Type Description Notes
CreateTestRunAndFillByWorkItemsApiModel CreateTestRunAndFillByWorkItemsApiModel [optional]

Return type

TestRunV2ApiResult

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createEmpty

TestRunV2ApiResult createEmpty(CreateEmptyTestRunApiModel)

Create empty TestRun

 Use case   User sets test run model (listed in the request example)   User runs method execution   System creates test run   System returns test run model

Parameters

Name Type Description Notes
CreateEmptyTestRunApiModel CreateEmptyTestRunApiModel [optional]

Return type

TestRunV2ApiResult

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

getTestRunById

TestRunV2ApiResult getTestRunById(id)

Get TestRun by Id

 Use case   User sets test run identifier   User runs method execution   System finds test run   System returns test run

Parameters

Name Type Description Notes
id UUID Test Run internal identifier (GUID format) [default to null]

Return type

TestRunV2ApiResult

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

setAutoTestResultsForTestRun

List setAutoTestResultsForTestRun(id, AutoTestResultsForTestRunModel)

Send test results to the test runs in the system

This method sends test results to the test management system.

Parameters

Name Type Description Notes
id UUID Test Run internal identifier (GUID format) [default to null]
AutoTestResultsForTestRunModel List [optional]

Return type

List

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

startTestRun

startTestRun(id)

Start TestRun

 Use case   User sets test run identifier   User runs method execution   System starts test run   System returns no content response

Parameters

Name Type Description Notes
id UUID Test Run internal identifier (GUID format) [default to null]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

stopTestRun

stopTestRun(id)

Stop TestRun

 Use case   User sets test run identifier   User runs method execution   System stops test run   System returns no content response

Parameters

Name Type Description Notes
id UUID Test Run internal identifier (GUID format) [default to null]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

updateEmpty

updateEmpty(UpdateEmptyTestRunApiModel)

Update empty TestRun

 Use case   User sets test run properties (listed in the request example)   User runs method execution   System updates test run   System returns returns no content response

Parameters

Name Type Description Notes
UpdateEmptyTestRunApiModel UpdateEmptyTestRunApiModel [optional]

Return type

null (empty response body)

Authorization

[Bearer or PrivateToken](../README.md#Bearer or PrivateToken)

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json