Skip to content

Latest commit

 

History

History
568 lines (411 loc) · 18.6 KB

TestcyclesApi.md

File metadata and controls

568 lines (411 loc) · 18.6 KB

TestcyclesApi

Method HTTP request Description
deleteTestCycle DELETE /testcycles/{testCycleId} Delete the test cycle with the specified ID, including the test runs in the test cycle
getTestCycle GET /testcycles/{testCycleId} Get the test cycle with the specified ID
getTestCycleTestGroup GET /testcycles/{testCycleId}/testgroup/{testGroupId} Get the test cycle test group for the test cycle with the specified ID
getTestRuns GET /testcycles/{testCycleId}/testruns Get all test runs for the test cycle with the specified ID
getVersionOnItem3 GET /testcycles/{testCycleId}/versions/{versionNum} Get the numbered version for the item with the specified ID
getVersionedItem3 GET /testcycles/{testCycleId}/versions/{versionNum}/versioneditem Get the snapshot of the test cycle at the specified version
getVersionsOnItem3 GET /testcycles/{testCycleId}/versions Get all versions for the item with the specified ID
patchTestCycle PATCH /testcycles/{testCycleId} Update the test cycle with the specified ID, including regenerating the test runs in the test cycle
updateTestCycle PUT /testcycles/{testCycleId} Update the test cycle with the specified ID, including regenerating the test runs in the test cycle

deleteTestCycle

AbstractRestResponse deleteTestCycle(testCycleId)

Delete the test cycle with the specified ID, including the test runs in the test cycle

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.TestcyclesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TestcyclesApi apiInstance = new TestcyclesApi();
Integer testCycleId = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.deleteTestCycle(testCycleId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestcyclesApi#deleteTestCycle");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
testCycleId Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

getTestCycle

TestCycleDataWrapper getTestCycle(testCycleId, include)

Get the test cycle with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.TestcyclesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TestcyclesApi apiInstance = new TestcyclesApi();
Integer testCycleId = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    TestCycleDataWrapper result = apiInstance.getTestCycle(testCycleId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestcyclesApi#getTestCycle");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
testCycleId Integer
include List<String> Links to include as full objects in the linked map [optional]

Return type

TestCycleDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTestCycleTestGroup

TestCycleTestGroupDataWrapper getTestCycleTestGroup(testGroupId, testCycleId, include)

Get the test cycle test group for the test cycle with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.TestcyclesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TestcyclesApi apiInstance = new TestcyclesApi();
Integer testGroupId = 56; // Integer | Get the test group with the specified ID
Integer testCycleId = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    TestCycleTestGroupDataWrapper result = apiInstance.getTestCycleTestGroup(testGroupId, testCycleId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestcyclesApi#getTestCycleTestGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
testGroupId Integer Get the test group with the specified ID
testCycleId Integer
include List<String> Links to include as full objects in the linked map [optional]

Return type

TestCycleTestGroupDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTestRuns

TestRunDataListWrapper getTestRuns(testCycleId, startAt, maxResults, include)

Get all test runs for the test cycle with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.TestcyclesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TestcyclesApi apiInstance = new TestcyclesApi();
Integer testCycleId = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    TestRunDataListWrapper result = apiInstance.getTestRuns(testCycleId, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestcyclesApi#getTestRuns");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
testCycleId Integer
startAt Integer [optional]
maxResults Integer If not set, this defaults to 20. This cannot be larger than 50 [optional]
include List<String> Links to include as full objects in the linked map [optional]

Return type

TestRunDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getVersionOnItem3

VersionDataWrapper getVersionOnItem3(versionNum, testCycleId, include)

Get the numbered version for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.TestcyclesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TestcyclesApi apiInstance = new TestcyclesApi();
Integer versionNum = 56; // Integer | 
Integer testCycleId = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    VersionDataWrapper result = apiInstance.getVersionOnItem3(versionNum, testCycleId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestcyclesApi#getVersionOnItem3");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
versionNum Integer
testCycleId Integer
include List<String> Links to include as full objects in the linked map [optional]

Return type

VersionDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getVersionedItem3

VersionedTestCycleDataWrapper getVersionedItem3(versionNum, testCycleId, include)

Get the snapshot of the test cycle at the specified version

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.TestcyclesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TestcyclesApi apiInstance = new TestcyclesApi();
Integer versionNum = 56; // Integer | 
Integer testCycleId = 56; // Integer | 
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    VersionedTestCycleDataWrapper result = apiInstance.getVersionedItem3(versionNum, testCycleId, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestcyclesApi#getVersionedItem3");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
versionNum Integer
testCycleId Integer
include List<String> Links to include as full objects in the linked map [optional]

Return type

VersionedTestCycleDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getVersionsOnItem3

VersionDataListWrapper getVersionsOnItem3(testCycleId, startAt, maxResults, include)

Get all versions for the item with the specified ID

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.TestcyclesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TestcyclesApi apiInstance = new TestcyclesApi();
Integer testCycleId = 56; // Integer | 
Integer startAt = 56; // Integer | 
Integer maxResults = 56; // Integer | If not set, this defaults to 20. This cannot be larger than 50
List<String> include = Arrays.asList("include_example"); // List<String> | Links to include as full objects in the linked map
try {
    VersionDataListWrapper result = apiInstance.getVersionsOnItem3(testCycleId, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestcyclesApi#getVersionsOnItem3");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
testCycleId Integer
startAt Integer [optional]
maxResults Integer If not set, this defaults to 20. This cannot be larger than 50 [optional]
include List<String> Links to include as full objects in the linked map [optional]

Return type

VersionDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

patchTestCycle

AbstractRestResponse patchTestCycle(body, testCycleId)

Update the test cycle with the specified ID, including regenerating the test runs in the test cycle

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.TestcyclesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TestcyclesApi apiInstance = new TestcyclesApi();
List<RequestPatchOperation> body = Arrays.asList(new RequestPatchOperation()); // List<RequestPatchOperation> | 
Integer testCycleId = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.patchTestCycle(body, testCycleId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestcyclesApi#patchTestCycle");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body List<RequestPatchOperation>
testCycleId Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

updateTestCycle

AbstractRestResponse updateTestCycle(body, testCycleId)

Update the test cycle with the specified ID, including regenerating the test runs in the test cycle

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.TestcyclesApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basic
HttpBasicAuth basic = (HttpBasicAuth) defaultClient.getAuthentication("basic");
basic.setUsername("YOUR USERNAME");
basic.setPassword("YOUR PASSWORD");

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

TestcyclesApi apiInstance = new TestcyclesApi();
RequestTestCycle body = new RequestTestCycle(); // RequestTestCycle | 
Integer testCycleId = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.updateTestCycle(body, testCycleId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestcyclesApi#updateTestCycle");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestTestCycle
testCycleId Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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