Skip to content

Latest commit

 

History

History
2585 lines (1885 loc) · 81 KB

TestplansApi.md

File metadata and controls

2585 lines (1885 loc) · 81 KB

TestplansApi

Method HTTP request Description
addAttachmentToItem POST /testplans/{id}/attachments Add an existing attachment to the item with the specified ID
addItemLink POST /testplans/{id}/links Create a new link for the item with the specified ID
addTagToItem POST /testplans/{id}/tags Add an existing tag to the item with the specified ID
addTestGroup POST /testplans/{id}/testgroups Create a new test group to the test plan with the specified ID
createTestCycle POST /testplans/{id}/testcycles Create a new test cycle
createTestPlan POST /testplans Create a new test plan
deleteItemLink DELETE /testplans/{id}/links/{linkId} Delete the link with the specified ID
deleteTestCase DELETE /testplans/{id}/testgroups/{testGroupId}/testcases/{testCaseId} Remove an existing test case from the test group
deleteTestGroup DELETE /testplans/{id}/testgroups/{testGroupId} Delete the test group with the specified ID
deleteTestPlan DELETE /testplans/{id} Delete the test plan with the specified ID
getActivities GET /testplans/{id}/activities Get all activities for the test plan with the specified ID
getAttachments GET /testplans/{id}/attachments Get all attachments for the item with the specified ID
getDownstreamRelated GET /testplans/{id}/downstreamrelated Get all downstream related items for the test plan with the specified ID
getDownstreamRelationships GET /testplans/{id}/downstreamrelationships Get all downstream relationships for the test plan with the specified ID
getItemComments GET /testplans/{id}/comments Get all comments for the item with the specified ID
getItemLinks GET /testplans/{id}/links Get all links for the item with the specified ID
getLinkById GET /testplans/{id}/links/{linkId} Get the link with the specified ID
getLock GET /testplans/{id}/lock Get the locked state, last locked date, and last locked by user for the item with the specified ID
getTagOnItem GET /testplans/{id}/tags/{tagId} Get the tag with the specified ID
getTagsOnItem GET /testplans/{id}/tags Get all tags for the item with the specified ID
getTestCaseById GET /testplans/{id}/testgroups/{testGroupId}/testcases/{testCaseId} Get the test case with the specified ID
getTestCases GET /testplans/{id}/testgroups/{testGroupId}/testcases Get all test cases associated with the test group with the specified ID
getTestCycles GET /testplans/{id}/testcycles Get all test cycles for the test plan with the specified ID
getTestGroupById GET /testplans/{id}/testgroups/{testGroupId} Get the test group with the specified ID
getTestGroups GET /testplans/{id}/testgroups Get all test groups for the test plan with the specified ID
getTestPlan GET /testplans/{id} Get the test plan with the specified ID
getTestPlans GET /testplans Get all test plans in the project with the specified ID
getUpstreamRelated GET /testplans/{id}/upstreamrelated Get all upstream related items for the test plan with the specified ID
getUpstreamRelationships GET /testplans/{id}/upstreamrelationships Get all upstream relationships for the test plan with the specified ID
getVersionOnItem4 GET /testplans/{id}/versions/{versionNum} Get the numbered version for the item with the specified ID
getVersionedItem4 GET /testplans/{id}/versions/{versionNum}/versioneditem Get the snapshot of the test plan at the specified version
getVersionsOnItem4 GET /testplans/{id}/versions Get all versions for the item with the specified ID
patchTestPlan PATCH /testplans/{id} Update the test plan with the specified ID
postTestCase POST /testplans/{id}/testgroups/{testGroupId}/testcases Add an existing test case to the test group with the specified ID
removeAttachmentFromItem DELETE /testplans/{id}/attachments/{attachmentId} Remove an existing attachment from the item
removeTagFromItem DELETE /testplans/{id}/tags/{tagId} Remove an existing tag from the item with the specified ID
toggleArchivedStatus PUT /testplans/{id}/archived Update the archived status of the test plan
updateItemLink PUT /testplans/{id}/links/{linkId} Update the link with the specified ID
updateLock PUT /testplans/{id}/lock Update the locked state of the item with the specified ID
updateTestGroup PUT /testplans/{id}/testgroups/{testGroupId} Update the test group with the specified ID
updateTestPlan PUT /testplans/{id} Update the test plan with the specified ID

addAttachmentToItem

CreatedResponse addAttachmentToItem(body, id)

Add an existing attachment to 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
RequestItemAttachment body = new RequestItemAttachment(); // RequestItemAttachment | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.addAttachmentToItem(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#addAttachmentToItem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestItemAttachment
id Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

addItemLink

CreatedResponse addItemLink(body, id)

Create a new link 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
RequestLink body = new RequestLink(); // RequestLink | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.addItemLink(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#addItemLink");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestLink
id Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

addTagToItem

CreatedResponse addTagToItem(body, id)

Add an existing tag to 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
RequestItemTag body = new RequestItemTag(); // RequestItemTag | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.addTagToItem(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#addTagToItem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestItemTag
id Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

addTestGroup

CreatedResponse addTestGroup(body, id)

Create a new test group to the test plan 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
RequestTestGroup body = new RequestTestGroup(); // RequestTestGroup | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.addTestGroup(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#addTestGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestTestGroup
id Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

createTestCycle

CreatedResponse createTestCycle(body, id)

Create a new 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
RequestTestCycle body = new RequestTestCycle(); // RequestTestCycle | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.createTestCycle(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#createTestCycle");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestTestCycle
id Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

createTestPlan

CreatedResponse createTestPlan(body)

Create a new test plan

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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
RequestTestPlan body = new RequestTestPlan(); // RequestTestPlan | 
try {
    CreatedResponse result = apiInstance.createTestPlan(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#createTestPlan");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestTestPlan

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

deleteItemLink

AbstractRestResponse deleteItemLink(linkId, id)

Delete the link 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer linkId = 56; // Integer | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.deleteItemLink(linkId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#deleteItemLink");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
linkId Integer
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

deleteTestCase

AbstractRestResponse deleteTestCase(testCaseId, testGroupId, id)

Remove an existing test case from the test group

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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer testCaseId = 56; // Integer | 
Integer testGroupId = 56; // Integer | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.deleteTestCase(testCaseId, testGroupId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#deleteTestCase");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
testCaseId Integer
testGroupId Integer
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

deleteTestGroup

AbstractRestResponse deleteTestGroup(testGroupId, id)

Delete the test group 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer testGroupId = 56; // Integer | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.deleteTestGroup(testGroupId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#deleteTestGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
testGroupId Integer
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

deleteTestPlan

AbstractRestResponse deleteTestPlan(id)

Delete the test plan 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.TestplansApi;

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");

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

Parameters

Name Type Description Notes
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

getActivities

ActivityDataListWrapper getActivities(id, startAt, maxResults, include)

Get all activities for the test plan 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer id = 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 {
    ActivityDataListWrapper result = apiInstance.getActivities(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getActivities");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id 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

ActivityDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getAttachments

AttachmentDataListWrapper getAttachments(id, startAt, maxResults, include)

Get all attachments 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer id = 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 {
    AttachmentDataListWrapper result = apiInstance.getAttachments(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getAttachments");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id 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

AttachmentDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getDownstreamRelated

AbstractItemDataListWrapper getDownstreamRelated(id, startAt, maxResults, include)

Get all downstream related items for the test plan 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer id = 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 {
    AbstractItemDataListWrapper result = apiInstance.getDownstreamRelated(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getDownstreamRelated");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id 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

AbstractItemDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getDownstreamRelationships

RelationshipDataListWrapper getDownstreamRelationships(id, startAt, maxResults, include)

Get all downstream relationships for the test plan 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer id = 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 {
    RelationshipDataListWrapper result = apiInstance.getDownstreamRelationships(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getDownstreamRelationships");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id 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

RelationshipDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getItemComments

CommentDataListWrapper getItemComments(id, startAt, maxResults, rootCommentsOnly, include)

Get all comments 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.TestplansApi;

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");

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

Parameters

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

Return type

CommentDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getItemLinks

LinkDataListWrapper getItemLinks(id, startAt, maxResults, include)

Get all links 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer id = 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 {
    LinkDataListWrapper result = apiInstance.getItemLinks(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getItemLinks");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id 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

LinkDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getLinkById

LinkDataWrapper getLinkById(linkId, id, include)

Get the link 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.TestplansApi;

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");

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

Parameters

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

Return type

LinkDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getLock

LockDataWrapper getLock(id, include)

Get the locked state, last locked date, and last locked by user 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.TestplansApi;

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");

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

Parameters

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

Return type

LockDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTagOnItem

TagDataWrapper getTagOnItem(tagId, id, include)

Get the tag 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.TestplansApi;

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");

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

Parameters

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

Return type

TagDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTagsOnItem

TagDataListWrapper getTagsOnItem(id, startAt, maxResults, include)

Get all tags 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer id = 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 {
    TagDataListWrapper result = apiInstance.getTagsOnItem(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getTagsOnItem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id 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

TagDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTestCaseById

ItemDataWrapper getTestCaseById(testCaseId, testGroupId, id, include)

Get the test case 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.TestplansApi;

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");

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

Parameters

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

Return type

ItemDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTestCases

ItemDataListWrapper getTestCases(testGroupId, id, startAt, maxResults, include)

Get all test cases associated with the test group 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer testGroupId = 56; // Integer | 
Integer id = 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 {
    ItemDataListWrapper result = apiInstance.getTestCases(testGroupId, id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getTestCases");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
testGroupId Integer
id 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

ItemDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTestCycles

TestCycleDataListWrapper getTestCycles(id, startAt, maxResults, include)

Get all test cycles for the test plan 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer id = 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 {
    TestCycleDataListWrapper result = apiInstance.getTestCycles(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getTestCycles");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id 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

TestCycleDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTestGroupById

TestGroupDataWrapper getTestGroupById(testGroupId, id, include)

Get the test group 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.TestplansApi;

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");

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

Parameters

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

Return type

TestGroupDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTestGroups

TestGroupDataListWrapper getTestGroups(id, startAt, maxResults, include)

Get all test groups for the test plan 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer id = 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 {
    TestGroupDataListWrapper result = apiInstance.getTestGroups(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getTestGroups");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id 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

TestGroupDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTestPlan

TestPlanDataWrapper getTestPlan(id, include)

Get the test plan 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.TestplansApi;

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");

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

Parameters

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

Return type

TestPlanDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getTestPlans

TestPlanDataListWrapper getTestPlans(project, startAt, maxResults, include)

Get all test plans in the project 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer project = 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 {
    TestPlanDataListWrapper result = apiInstance.getTestPlans(project, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getTestPlans");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
project 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

TestPlanDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getUpstreamRelated

AbstractItemDataListWrapper getUpstreamRelated(id, startAt, maxResults, include)

Get all upstream related items for the test plan 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer id = 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 {
    AbstractItemDataListWrapper result = apiInstance.getUpstreamRelated(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getUpstreamRelated");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id 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

AbstractItemDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getUpstreamRelationships

RelationshipDataListWrapper getUpstreamRelationships(id, startAt, maxResults, include)

Get all upstream relationships for the test plan 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer id = 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 {
    RelationshipDataListWrapper result = apiInstance.getUpstreamRelationships(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getUpstreamRelationships");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id 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

RelationshipDataListWrapper

Authorization

basic, oauth2

HTTP request headers

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

getVersionOnItem4

VersionDataWrapper getVersionOnItem4(versionNum, id, 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer versionNum = 56; // Integer | 
Integer id = 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.getVersionOnItem4(versionNum, id, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getVersionOnItem4");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
versionNum Integer
id 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

getVersionedItem4

VersionedTestPlanDataWrapper getVersionedItem4(versionNum, id, include)

Get the snapshot of the test plan 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.TestplansApi;

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");

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

Parameters

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

Return type

VersionedTestPlanDataWrapper

Authorization

basic, oauth2

HTTP request headers

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

getVersionsOnItem4

VersionDataListWrapper getVersionsOnItem4(id, 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer id = 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.getVersionsOnItem4(id, startAt, maxResults, include);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#getVersionsOnItem4");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id 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

patchTestPlan

AbstractRestResponse patchTestPlan(body, id)

Update the test plan 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.TestplansApi;

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");

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

Parameters

Name Type Description Notes
body List<RequestPatchOperation>
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

postTestCase

CreatedResponse postTestCase(body, testGroupId, id)

Add an existing test case to the test group 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
RequestTestGroupTestCase body = new RequestTestGroupTestCase(); // RequestTestGroupTestCase | 
Integer testGroupId = 56; // Integer | 
Integer id = 56; // Integer | 
try {
    CreatedResponse result = apiInstance.postTestCase(body, testGroupId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#postTestCase");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestTestGroupTestCase
testGroupId Integer
id Integer

Return type

CreatedResponse

Authorization

basic, oauth2

HTTP request headers

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

removeAttachmentFromItem

AbstractRestResponse removeAttachmentFromItem(attachmentId, id)

Remove an existing attachment from the item

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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer attachmentId = 56; // Integer | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.removeAttachmentFromItem(attachmentId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#removeAttachmentFromItem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
attachmentId Integer
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

removeTagFromItem

AbstractRestResponse removeTagFromItem(tagId, id)

Remove an existing tag from 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer tagId = 56; // Integer | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.removeTagFromItem(tagId, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#removeTagFromItem");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
tagId Integer
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

toggleArchivedStatus

AbstractRestResponse toggleArchivedStatus(body, id)

Update the archived status of the test plan

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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
RequestArchivedStatus body = new RequestArchivedStatus(); // RequestArchivedStatus | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.toggleArchivedStatus(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#toggleArchivedStatus");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestArchivedStatus
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

updateItemLink

AbstractRestResponse updateItemLink(linkId, body, id)

Update the link 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer linkId = 56; // Integer | 
RequestLink body = new RequestLink(); // RequestLink | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.updateItemLink(linkId, body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#updateItemLink");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
linkId Integer
body RequestLink
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

updateLock

AbstractRestResponse updateLock(body, id)

Update the locked state of 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
RequestLock body = new RequestLock(); // RequestLock | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.updateLock(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#updateLock");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestLock
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

updateTestGroup

AbstractRestResponse updateTestGroup(testGroupId, body, id)

Update the test group 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
Integer testGroupId = 56; // Integer | 
RequestTestGroup body = new RequestTestGroup(); // RequestTestGroup | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.updateTestGroup(testGroupId, body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#updateTestGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
testGroupId Integer
body RequestTestGroup
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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

updateTestPlan

AbstractRestResponse updateTestPlan(body, id)

Update the test plan 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.TestplansApi;

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");

TestplansApi apiInstance = new TestplansApi();
RequestTestPlan body = new RequestTestPlan(); // RequestTestPlan | 
Integer id = 56; // Integer | 
try {
    AbstractRestResponse result = apiInstance.updateTestPlan(body, id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling TestplansApi#updateTestPlan");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body RequestTestPlan
id Integer

Return type

AbstractRestResponse

Authorization

basic, oauth2

HTTP request headers

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