Skip to content

Latest commit

 

History

History
290 lines (216 loc) · 9.4 KB

IssueTemplateControllerApi.md

File metadata and controls

290 lines (216 loc) · 9.4 KB
Raw

IssueTemplateControllerApi

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

Method HTTP request Description
deleteIssueTemplate DELETE /issueTemplates/{id} delete
listIssueTemplate GET /issueTemplates list
multiDeleteIssueTemplate DELETE /issueTemplates multiDelete
readIssueTemplate GET /issueTemplates/{id} read
updateIssueTemplate PUT /issueTemplates/{id} update

deleteIssueTemplate

ApiResultVoid deleteIssueTemplate(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.IssueTemplateControllerApi;

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

IssueTemplateControllerApi apiInstance = new IssueTemplateControllerApi();
String id = "id_example"; // String | id
try {
    ApiResultVoid result = apiInstance.deleteIssueTemplate(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTemplateControllerApi#deleteIssueTemplate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String id

Return type

ApiResultVoid

Authorization

FortifyToken

HTTP request headers

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

listIssueTemplate

ApiResultListIssueTemplate listIssueTemplate(fields, start, limit, q, orderby)

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

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

IssueTemplateControllerApi apiInstance = new IssueTemplateControllerApi();
String fields = "fields_example"; // String | Output fields
Integer start = 0; // Integer | A start offset in object listing
Integer limit = 200; // Integer | A maximum number of returned objects in listing, if '-1' or '0' no limit is applied
String q = "q_example"; // String | A search query
String orderby = "orderby_example"; // String | Fields to order by
try {
    ApiResultListIssueTemplate result = apiInstance.listIssueTemplate(fields, start, limit, q, orderby);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTemplateControllerApi#listIssueTemplate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
fields String Output fields [optional]
start Integer A start offset in object listing [optional] [default to 0]
limit Integer A maximum number of returned objects in listing, if '-1' or '0' no limit is applied [optional] [default to 200]
q String A search query [optional]
orderby String Fields to order by [optional]

Return type

ApiResultListIssueTemplate

Authorization

FortifyToken

HTTP request headers

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

multiDeleteIssueTemplate

ApiResultVoid multiDeleteIssueTemplate(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.IssueTemplateControllerApi;

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

IssueTemplateControllerApi apiInstance = new IssueTemplateControllerApi();
String ids = "ids_example"; // String | A comma-separated list of resource identifiers
try {
    ApiResultVoid result = apiInstance.multiDeleteIssueTemplate(ids);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTemplateControllerApi#multiDeleteIssueTemplate");
    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

readIssueTemplate

ApiResultIssueTemplate readIssueTemplate(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.IssueTemplateControllerApi;

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

IssueTemplateControllerApi apiInstance = new IssueTemplateControllerApi();
String id = "id_example"; // String | id
String fields = "fields_example"; // String | Output fields
try {
    ApiResultIssueTemplate result = apiInstance.readIssueTemplate(id, fields);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTemplateControllerApi#readIssueTemplate");
    e.printStackTrace();
}

Parameters

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

Return type

ApiResultIssueTemplate

Authorization

FortifyToken

HTTP request headers

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

updateIssueTemplate

ApiResultIssueTemplate updateIssueTemplate(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.IssueTemplateControllerApi;

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

IssueTemplateControllerApi apiInstance = new IssueTemplateControllerApi();
String id = "id_example"; // String | id
IssueTemplate resource = new IssueTemplate(); // IssueTemplate | resource
try {
    ApiResultIssueTemplate result = apiInstance.updateIssueTemplate(id, resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling IssueTemplateControllerApi#updateIssueTemplate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String id
resource IssueTemplate resource

Return type

ApiResultIssueTemplate

Authorization

FortifyToken

HTTP request headers

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