Skip to content

Latest commit

 

History

History
344 lines (256 loc) · 11.3 KB

AlertDefinitionControllerApi.md

File metadata and controls

344 lines (256 loc) · 11.3 KB
Raw

AlertDefinitionControllerApi

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

Method HTTP request Description
createAlertDefinition POST /alertDefinitions create
deleteAlertDefinition DELETE /alertDefinitions/{id} delete
listAlertDefinition GET /alertDefinitions list
multiDeleteAlertDefinition DELETE /alertDefinitions multiDelete
readAlertDefinition GET /alertDefinitions/{id} read
updateAlertDefinition PUT /alertDefinitions/{id} update

createAlertDefinition

ApiResultAlertDefinitionDto createAlertDefinition(resource)

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

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

AlertDefinitionControllerApi apiInstance = new AlertDefinitionControllerApi();
AlertDefinitionDto resource = new AlertDefinitionDto(); // AlertDefinitionDto | resource
try {
    ApiResultAlertDefinitionDto result = apiInstance.createAlertDefinition(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AlertDefinitionControllerApi#createAlertDefinition");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
resource AlertDefinitionDto resource

Return type

ApiResultAlertDefinitionDto

Authorization

FortifyToken

HTTP request headers

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

deleteAlertDefinition

ApiResultVoid deleteAlertDefinition(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.AlertDefinitionControllerApi;

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

AlertDefinitionControllerApi apiInstance = new AlertDefinitionControllerApi();
Long id = 789L; // Long | id
try {
    ApiResultVoid result = apiInstance.deleteAlertDefinition(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AlertDefinitionControllerApi#deleteAlertDefinition");
    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

listAlertDefinition

ApiResultListAlertDefinitionDto listAlertDefinition(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.AlertDefinitionControllerApi;

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

AlertDefinitionControllerApi apiInstance = new AlertDefinitionControllerApi();
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 {
    ApiResultListAlertDefinitionDto result = apiInstance.listAlertDefinition(fields, start, limit, q, orderby);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AlertDefinitionControllerApi#listAlertDefinition");
    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

ApiResultListAlertDefinitionDto

Authorization

FortifyToken

HTTP request headers

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

multiDeleteAlertDefinition

ApiResultVoid multiDeleteAlertDefinition(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.AlertDefinitionControllerApi;

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

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

readAlertDefinition

ApiResultAlertDefinitionDto readAlertDefinition(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.AlertDefinitionControllerApi;

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

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

Parameters

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

Return type

ApiResultAlertDefinitionDto

Authorization

FortifyToken

HTTP request headers

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

updateAlertDefinition

ApiResultAlertDefinitionDto updateAlertDefinition(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.AlertDefinitionControllerApi;

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

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

Parameters

Name Type Description Notes
id Long id
resource AlertDefinitionDto resource

Return type

ApiResultAlertDefinitionDto

Authorization

FortifyToken

HTTP request headers

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