Skip to content

SectionsApi.md

Latest commit

 

History

History
613 lines (482 loc) · 24.2 KB

SectionsApi.md

File metadata and controls

613 lines (482 loc) · 24.2 KB

SectionsApi

All URIs are relative to http://localhost

Method HTTP request Description
apiV2SectionsIdPatch PATCH /api/v2/sections/{id} Patch section
createSection POST /api/v2/sections Create section
deleteSection DELETE /api/v2/sections/{id} Delete section
getSectionById GET /api/v2/sections/{id} Get section
getWorkItemsBySectionId GET /api/v2/sections/{id}/workItems Get section work items
move POST /api/v2/sections/move Move section with all work items into another section
rename POST /api/v2/sections/rename Rename section
updateSection PUT /api/v2/sections Update section

apiV2SectionsIdPatch

apiV2SectionsIdPatch(id, operation)

Patch section

See <a href=&quot;https://www.rfc-editor.org/rfc/rfc6902\" target=&quot;_blank&quot;>RFC 6902: JavaScript Object Notation (JSON) Patch</a> for details

Example

// Import classes:
import io.test_gear.client.invoker.ApiClient;
import io.test_gear.client.invoker.ApiException;
import io.test_gear.client.invoker.Configuration;
import io.test_gear.client.invoker.auth.*;
import io.test_gear.client.invoker.models.*;
import io.test_gear.client.api.SectionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    SectionsApi apiInstance = new SectionsApi(defaultClient);
    UUID id = UUID.randomUUID(); // UUID | Section internal (UUID) identifier
    List<Operation> operation = Arrays.asList(); // List<Operation> | 
    try {
      apiInstance.apiV2SectionsIdPatch(id, operation);
    } catch (ApiException e) {
      System.err.println("Exception when calling SectionsApi#apiV2SectionsIdPatch");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id UUID Section internal (UUID) identifier
operation List<Operation> [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

HTTP response details

Status code Description Response headers
204 No Content -
403 Update permission for section is required -

createSection

SectionWithStepsModel createSection(sectionPostModel)

Create section

<br>Use case <br>User sets section properties (listed in request example) <br>User runs method execution <br>System creates section property values <br>System returns section (listed in response example)

Example

// Import classes:
import io.test_gear.client.invoker.ApiClient;
import io.test_gear.client.invoker.ApiException;
import io.test_gear.client.invoker.Configuration;
import io.test_gear.client.invoker.auth.*;
import io.test_gear.client.invoker.models.*;
import io.test_gear.client.api.SectionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    SectionsApi apiInstance = new SectionsApi(defaultClient);
    SectionPostModel sectionPostModel = new SectionPostModel(); // SectionPostModel | 
    try {
      SectionWithStepsModel result = apiInstance.createSection(sectionPostModel);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SectionsApi#createSection");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
sectionPostModel SectionPostModel [optional]

Return type

SectionWithStepsModel

Authorization

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

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 Created -
400 Cannot create section without parent ID -
401 Unauthorized -
403 Update permission for test library is required -
404 Parent section with provided ID was not found -
409 Section with the same name already exists in the parent section -

deleteSection

deleteSection(id)

Delete section

<br>Use case <br>User sets section identifier <br>User runs method execution <br>System search section by the identifier <br>System search and delete nested sections of the found section <br>System search and delete workitems related to the found nested sections <br>System deletes initial section and related workitem <br>System returns no content response

Example

// Import classes:
import io.test_gear.client.invoker.ApiClient;
import io.test_gear.client.invoker.ApiException;
import io.test_gear.client.invoker.Configuration;
import io.test_gear.client.invoker.auth.*;
import io.test_gear.client.invoker.models.*;
import io.test_gear.client.api.SectionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    SectionsApi apiInstance = new SectionsApi(defaultClient);
    UUID id = UUID.randomUUID(); // UUID | Section internal (UUID) identifier
    try {
      apiInstance.deleteSection(id);
    } catch (ApiException e) {
      System.err.println("Exception when calling SectionsApi#deleteSection");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id UUID Section internal (UUID) identifier

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

HTTP response details

Status code Description Response headers
409 Conflict -
400 Bad Request -
401 Unauthorized -
403 Delete permission for test library is required -
204 No Content -
404 Section with provided ID was not found -
422 Cannot delete root section -

getSectionById

SectionWithStepsModel getSectionById(id, isDeleted)

Get section

<br>Use case <br>User sets section internal (guid format) identifier <br>User runs method execution <br>System search section by the section identifier <br> [Optional] If isDeleted flag equals false, deleted work items are not being searched. If true, deleted work items are also being searched, null for all work items. <br>System returns section

Example

// Import classes:
import io.test_gear.client.invoker.ApiClient;
import io.test_gear.client.invoker.ApiException;
import io.test_gear.client.invoker.Configuration;
import io.test_gear.client.invoker.auth.*;
import io.test_gear.client.invoker.models.*;
import io.test_gear.client.api.SectionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    SectionsApi apiInstance = new SectionsApi(defaultClient);
    UUID id = UUID.randomUUID(); // UUID | Section internal (UUID) identifier
    DeletionState isDeleted = DeletionState.fromValue("Any"); // DeletionState | 
    try {
      SectionWithStepsModel result = apiInstance.getSectionById(id, isDeleted);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SectionsApi#getSectionById");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id UUID Section internal (UUID) identifier
isDeleted DeletionState [optional] [enum: Any, Deleted, NotDeleted]

Return type

SectionWithStepsModel

Authorization

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

HTTP request headers

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

HTTP response details

Status code Description Response headers
404 Section with provided ID was not found -
400 Bad Request -
403 Read permission for test library is required -
200 Success -
401 Unauthorized -

getWorkItemsBySectionId

List<WorkItemShortModel> getWorkItemsBySectionId(id, isDeleted, tagNames, includeIterations, skip, take, orderBy, searchField, searchValue)

Get section work items

<br>Use case <br>User sets section identifier <br>User runs method execution <br>System search section by the identifier <br>System search work items related to the section <br> [Optional] If isDeleted flag equals false, deleted work items are not being searched. If true, deleted work items are also being searched, null for all work items. <br>System returns work item collection

Example

// Import classes:
import io.test_gear.client.invoker.ApiClient;
import io.test_gear.client.invoker.ApiException;
import io.test_gear.client.invoker.Configuration;
import io.test_gear.client.invoker.auth.*;
import io.test_gear.client.invoker.models.*;
import io.test_gear.client.api.SectionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    SectionsApi apiInstance = new SectionsApi(defaultClient);
    UUID id = UUID.randomUUID(); // UUID | Section internal (UUID) identifier
    Boolean isDeleted = false; // Boolean | Requested section is deleted
    List<String> tagNames = Arrays.asList(); // List<String> | List of work item tags
    Boolean includeIterations = true; // Boolean | 
    Integer skip = 56; // Integer | Amount of items to be skipped (offset)
    Integer take = 56; // Integer | Amount of items to be taken (limit)
    String orderBy = "orderBy_example"; // String | SQL-like  ORDER BY statement (column1 ASC|DESC , column2 ASC|DESC)
    String searchField = "searchField_example"; // String | Property name for searching
    String searchValue = "searchValue_example"; // String | Value for searching
    try {
      List<WorkItemShortModel> result = apiInstance.getWorkItemsBySectionId(id, isDeleted, tagNames, includeIterations, skip, take, orderBy, searchField, searchValue);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SectionsApi#getWorkItemsBySectionId");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
id UUID Section internal (UUID) identifier
isDeleted Boolean Requested section is deleted [optional] [default to false]
tagNames List<String> List of work item tags [optional]
includeIterations Boolean [optional] [default to true]
skip Integer Amount of items to be skipped (offset) [optional]
take Integer Amount of items to be taken (limit) [optional]
orderBy String SQL-like ORDER BY statement (column1 ASC DESC , column2 ASC
searchField String Property name for searching [optional]
searchValue String Value for searching [optional]

Return type

List<WorkItemShortModel>

Authorization

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

HTTP request headers

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

HTTP response details

Status code Description Response headers
404 Section with provided ID was not found -
400 <br>- `orderBy` statement must have one `.` and no `,` symbols <br>- `orderBy` statement has invalid length <br>- `orderBy` statement must have UUID as attribute key <br>- Search field was not found -
200 Success * Pagination-Skip - Skipped amount of items
* Pagination-Take - Taken items
* Pagination-Pages - Expected number of pages
* Pagination-Total-Items - Total count of items
401 Unauthorized -
403 Read permission for test library is required -

move

move(sectionMoveModel)

Move section with all work items into another section

Example

// Import classes:
import io.test_gear.client.invoker.ApiClient;
import io.test_gear.client.invoker.ApiException;
import io.test_gear.client.invoker.Configuration;
import io.test_gear.client.invoker.auth.*;
import io.test_gear.client.invoker.models.*;
import io.test_gear.client.api.SectionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    SectionsApi apiInstance = new SectionsApi(defaultClient);
    SectionMoveModel sectionMoveModel = new SectionMoveModel(); // SectionMoveModel | 
    try {
      apiInstance.move(sectionMoveModel);
    } catch (ApiException e) {
      System.err.println("Exception when calling SectionsApi#move");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
sectionMoveModel SectionMoveModel [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

HTTP response details

Status code Description Response headers
204 No Content -
403 Update permission for test library is required -

rename

rename(sectionRenameModel)

Rename section

<br>Use case <br>User sets section identifier and new name (listed in request example) <br>User runs method execution <br>System search section by the identifier <br>System updates section name using the new name <br>System returns no content response

Example

// Import classes:
import io.test_gear.client.invoker.ApiClient;
import io.test_gear.client.invoker.ApiException;
import io.test_gear.client.invoker.Configuration;
import io.test_gear.client.invoker.auth.*;
import io.test_gear.client.invoker.models.*;
import io.test_gear.client.api.SectionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    SectionsApi apiInstance = new SectionsApi(defaultClient);
    SectionRenameModel sectionRenameModel = new SectionRenameModel(); // SectionRenameModel | 
    try {
      apiInstance.rename(sectionRenameModel);
    } catch (ApiException e) {
      System.err.println("Exception when calling SectionsApi#rename");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
sectionRenameModel SectionRenameModel [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

HTTP response details

Status code Description Response headers
403 Update permission for test library is required -
404 Section with provided ID was not found -
409 Section with the same name already exists in the parent section -
204 No Content -
401 Unauthorized -
422 Root section cannot be renamed -

updateSection

updateSection(sectionPutModel)

Update section

<br>Use case <br>User sets section properties (listed in request example) <br>User runs method execution <br>System search section by the identifier <br>System updates section using the property values <br>System returns no content response

Example

// Import classes:
import io.test_gear.client.invoker.ApiClient;
import io.test_gear.client.invoker.ApiException;
import io.test_gear.client.invoker.Configuration;
import io.test_gear.client.invoker.auth.*;
import io.test_gear.client.invoker.models.*;
import io.test_gear.client.api.SectionsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure API key authorization: Bearer or PrivateToken
    ApiKeyAuth Bearer or PrivateToken = (ApiKeyAuth) defaultClient.getAuthentication("Bearer or PrivateToken");
    Bearer or PrivateToken.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //Bearer or PrivateToken.setApiKeyPrefix("Token");

    SectionsApi apiInstance = new SectionsApi(defaultClient);
    SectionPutModel sectionPutModel = new SectionPutModel(); // SectionPutModel | 
    try {
      apiInstance.updateSection(sectionPutModel);
    } catch (ApiException e) {
      System.err.println("Exception when calling SectionsApi#updateSection");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
sectionPutModel SectionPutModel [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

HTTP response details

Status code Description Response headers
400 <br>- ID is invalid <br>- Root section cannot be create -
204 No Content -
401 Unauthorized -
403 Update permission for test library is required -
404 <br>- Section cannot be found <br>- Parent section cannot be found <br>- Project cannot be found -
409 Section with the same name already exists in the parent section -
422 <br>- Root section cannot be edited <br>- Parent ID cannot be changed <br>- Project ID cannot be changed -