Skip to content

Latest commit

 

History

History
328 lines (241 loc) · 10.8 KB

ConfigurationControllerApi.md

File metadata and controls

328 lines (241 loc) · 10.8 KB
Raw

ConfigurationControllerApi

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

Method HTTP request Description
getConfiguration GET /configuration get
getFullTextIndexStatusConfiguration GET /configuration/searchIndex getFullTextIndexStatus
readConfiguration GET /configuration/{id} read
updateConfiguration PUT /configuration update
validateAuditAssistantConnectionConfiguration POST /configuration/validateAuditAssistantConnection validateAuditAssistantConnection
validateReportConnectionConfiguration POST /configuration/validateReportConnection validateReportConnection

getConfiguration

ApiResultConfigProperties getConfiguration(group)

get

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

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

ConfigurationControllerApi apiInstance = new ConfigurationControllerApi();
String group = "group_example"; // String | group
try {
    ApiResultConfigProperties result = apiInstance.getConfiguration(group);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationControllerApi#getConfiguration");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
group String group [optional]

Return type

ApiResultConfigProperties

Authorization

FortifyToken

HTTP request headers

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

getFullTextIndexStatusConfiguration

ApiResultSearchIndexStatus getFullTextIndexStatusConfiguration()

getFullTextIndexStatus

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

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

ConfigurationControllerApi apiInstance = new ConfigurationControllerApi();
try {
    ApiResultSearchIndexStatus result = apiInstance.getFullTextIndexStatusConfiguration();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationControllerApi#getFullTextIndexStatusConfiguration");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

ApiResultSearchIndexStatus

Authorization

FortifyToken

HTTP request headers

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

readConfiguration

ApiResultConfigProperty readConfiguration(id)

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

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

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

Parameters

Name Type Description Notes
id String id

Return type

ApiResultConfigProperty

Authorization

FortifyToken

HTTP request headers

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

updateConfiguration

ApiResultConfigProperties updateConfiguration(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.ConfigurationControllerApi;

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

ConfigurationControllerApi apiInstance = new ConfigurationControllerApi();
ConfigProperties resource = new ConfigProperties(); // ConfigProperties | resource
try {
    ApiResultConfigProperties result = apiInstance.updateConfiguration(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationControllerApi#updateConfiguration");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
resource ConfigProperties resource

Return type

ApiResultConfigProperties

Authorization

FortifyToken

HTTP request headers

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

validateAuditAssistantConnectionConfiguration

ApiResultConfigProperties validateAuditAssistantConnectionConfiguration(resource)

validateAuditAssistantConnection

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

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

ConfigurationControllerApi apiInstance = new ConfigurationControllerApi();
ConfigProperties resource = new ConfigProperties(); // ConfigProperties | resource
try {
    ApiResultConfigProperties result = apiInstance.validateAuditAssistantConnectionConfiguration(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationControllerApi#validateAuditAssistantConnectionConfiguration");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
resource ConfigProperties resource

Return type

ApiResultConfigProperties

Authorization

FortifyToken

HTTP request headers

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

validateReportConnectionConfiguration

ApiResultConfigProperties validateReportConnectionConfiguration(resource)

validateReportConnection

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

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

ConfigurationControllerApi apiInstance = new ConfigurationControllerApi();
ConfigProperties resource = new ConfigProperties(); // ConfigProperties | resource
try {
    ApiResultConfigProperties result = apiInstance.validateReportConnectionConfiguration(resource);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConfigurationControllerApi#validateReportConnectionConfiguration");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
resource ConfigProperties resource

Return type

ApiResultConfigProperties

Authorization

FortifyToken

HTTP request headers

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