Skip to content

Latest commit

 

History

History
336 lines (248 loc) · 11.3 KB

BugfieldTemplateGroupControllerApi.md

File metadata and controls

336 lines (248 loc) · 11.3 KB

BugfieldTemplateGroupControllerApi

All URIs are relative to https://SSC:8080/ssc/api/v1

Method HTTP request Description
createBugfieldTemplateGroup POST /bugfieldTemplateGroups create
deleteBugfieldTemplateGroup DELETE /bugfieldTemplateGroups/{id} delete
listBugfieldTemplateGroup GET /bugfieldTemplateGroups list
multiDeleteBugfieldTemplateGroup DELETE /bugfieldTemplateGroups multiDelete
readBugfieldTemplateGroup GET /bugfieldTemplateGroups/{id} read
updateBugfieldTemplateGroup PUT /bugfieldTemplateGroups/{id} update

createBugfieldTemplateGroup

ApiResultBugfieldTemplateGroupDto createBugfieldTemplateGroup(data)

create

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.BugfieldTemplateGroupControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

BugfieldTemplateGroupControllerApi apiInstance = new BugfieldTemplateGroupControllerApi();
BugfieldTemplateGroupDto data = new BugfieldTemplateGroupDto(); // BugfieldTemplateGroupDto | data
try {
    ApiResultBugfieldTemplateGroupDto result = apiInstance.createBugfieldTemplateGroup(data);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BugfieldTemplateGroupControllerApi#createBugfieldTemplateGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
data BugfieldTemplateGroupDto data

Return type

ApiResultBugfieldTemplateGroupDto

Authorization

FortifyToken

HTTP request headers

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

deleteBugfieldTemplateGroup

ApiResultVoid deleteBugfieldTemplateGroup(id)

delete

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.BugfieldTemplateGroupControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

BugfieldTemplateGroupControllerApi apiInstance = new BugfieldTemplateGroupControllerApi();
Long id = 789L; // Long | id
try {
    ApiResultVoid result = apiInstance.deleteBugfieldTemplateGroup(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BugfieldTemplateGroupControllerApi#deleteBugfieldTemplateGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Long id

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

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

listBugfieldTemplateGroup

ApiResultListBugfieldTemplateGroupDto listBugfieldTemplateGroup(fields)

list

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.BugfieldTemplateGroupControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

BugfieldTemplateGroupControllerApi apiInstance = new BugfieldTemplateGroupControllerApi();
String fields = "fields_example"; // String | Output fields
try {
    ApiResultListBugfieldTemplateGroupDto result = apiInstance.listBugfieldTemplateGroup(fields);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BugfieldTemplateGroupControllerApi#listBugfieldTemplateGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
fields String Output fields [optional]

Return type

ApiResultListBugfieldTemplateGroupDto

Authorization

FortifyToken

HTTP request headers

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

multiDeleteBugfieldTemplateGroup

ApiResultVoid multiDeleteBugfieldTemplateGroup(ids)

multiDelete

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.BugfieldTemplateGroupControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

BugfieldTemplateGroupControllerApi apiInstance = new BugfieldTemplateGroupControllerApi();
String ids = "ids_example"; // String | A comma-separated list of resource identifiers
try {
    ApiResultVoid result = apiInstance.multiDeleteBugfieldTemplateGroup(ids);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BugfieldTemplateGroupControllerApi#multiDeleteBugfieldTemplateGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
ids String A comma-separated list of resource identifiers

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

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

readBugfieldTemplateGroup

ApiResultBugfieldTemplateGroupDto readBugfieldTemplateGroup(id, fields)

read

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.BugfieldTemplateGroupControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

BugfieldTemplateGroupControllerApi apiInstance = new BugfieldTemplateGroupControllerApi();
Long id = 789L; // Long | id
String fields = "fields_example"; // String | Output fields
try {
    ApiResultBugfieldTemplateGroupDto result = apiInstance.readBugfieldTemplateGroup(id, fields);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BugfieldTemplateGroupControllerApi#readBugfieldTemplateGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Long id
fields String Output fields [optional]

Return type

ApiResultBugfieldTemplateGroupDto

Authorization

FortifyToken

HTTP request headers

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

updateBugfieldTemplateGroup

ApiResultBugfieldTemplateGroupDto updateBugfieldTemplateGroup(id, resource)

update

Example

// Import classes:
//import com.fortify.ssc.restclient.ApiClient;
//import com.fortify.ssc.restclient.ApiException;
//import com.fortify.ssc.restclient.Configuration;
//import com.fortify.ssc.restclient.auth.*;
//import com.fortify.ssc.restclient.api.BugfieldTemplateGroupControllerApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: FortifyToken
ApiKeyAuth FortifyToken = (ApiKeyAuth) defaultClient.getAuthentication("FortifyToken");
FortifyToken.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//FortifyToken.setApiKeyPrefix("Token");

BugfieldTemplateGroupControllerApi apiInstance = new BugfieldTemplateGroupControllerApi();
Long id = 789L; // Long | id
BugfieldTemplateGroupDto resource = new BugfieldTemplateGroupDto(); // BugfieldTemplateGroupDto | resource
try {
    ApiResultBugfieldTemplateGroupDto result = apiInstance.updateBugfieldTemplateGroup(id, resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BugfieldTemplateGroupControllerApi#updateBugfieldTemplateGroup");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id Long id
resource BugfieldTemplateGroupDto resource

Return type

ApiResultBugfieldTemplateGroupDto

Authorization

FortifyToken

HTTP request headers

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