Skip to content

RiskAnalyticsDataProcessorApi.md

Latest commit

 

History

History
158 lines (122 loc) · 6.57 KB

RiskAnalyticsDataProcessorApi.md

File metadata and controls

158 lines (122 loc) · 6.57 KB

RiskAnalyticsDataProcessorApi

All URIs are relative to http://localhost

Method HTTP request Description
riskAnalyticsDataProcessorGetRiskContext GET /api/v3/risk_events/{risk_id}/context Summary: Get Risk Event Context Description: Retrieve the context of the given risk ID. This context will be used for LLM interactions.
riskAnalyticsDataProcessorGetRiskPredefinedQuestions GET /api/v3/risk_events/{risk_id}/questions Summary: Get Risk Event Predefined Questions Description: Retrieve the Predefined Questions of the given risk ID. This Predefined Questions will be used quick actions recommendations.

riskAnalyticsDataProcessorGetRiskContext

Riskanalyticsdataprocessorv3GetRiskContextResponse riskAnalyticsDataProcessorGetRiskContext(riskId, timezone)

Summary: Get Risk Event Context Description: Retrieve the context of the given risk ID. This context will be used for LLM interactions.

Example

// Import classes:
import com.ibm.security.ApiClient;
import com.ibm.security.ApiException;
import com.ibm.security.Configuration;
import com.ibm.security.auth.*;
import com.ibm.security.models.*;
import com.ibm.security.guardium.RiskAnalyticsDataProcessorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

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

    RiskAnalyticsDataProcessorApi apiInstance = new RiskAnalyticsDataProcessorApi(defaultClient);
    Integer riskId = 56; // Integer | Risk id.
    String timezone = "timezone_example"; // String | Timezone in IANA format.
    try {
      Riskanalyticsdataprocessorv3GetRiskContextResponse result = apiInstance.riskAnalyticsDataProcessorGetRiskContext(riskId, timezone);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RiskAnalyticsDataProcessorApi#riskAnalyticsDataProcessorGetRiskContext");
      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
riskId Integer Risk id.
timezone String Timezone in IANA format. [optional]

Return type

Riskanalyticsdataprocessorv3GetRiskContextResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -

riskAnalyticsDataProcessorGetRiskPredefinedQuestions

Riskanalyticsdataprocessorv3GetRiskPredefinedQuestionsResponse riskAnalyticsDataProcessorGetRiskPredefinedQuestions(riskId)

Summary: Get Risk Event Predefined Questions Description: Retrieve the Predefined Questions of the given risk ID. This Predefined Questions will be used quick actions recommendations.

Example

// Import classes:
import com.ibm.security.ApiClient;
import com.ibm.security.ApiException;
import com.ibm.security.Configuration;
import com.ibm.security.auth.*;
import com.ibm.security.models.*;
import com.ibm.security.guardium.RiskAnalyticsDataProcessorApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

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

    RiskAnalyticsDataProcessorApi apiInstance = new RiskAnalyticsDataProcessorApi(defaultClient);
    Integer riskId = 56; // Integer | Risk id.
    try {
      Riskanalyticsdataprocessorv3GetRiskPredefinedQuestionsResponse result = apiInstance.riskAnalyticsDataProcessorGetRiskPredefinedQuestions(riskId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RiskAnalyticsDataProcessorApi#riskAnalyticsDataProcessorGetRiskPredefinedQuestions");
      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
riskId Integer Risk id.

Return type

Riskanalyticsdataprocessorv3GetRiskPredefinedQuestionsResponse

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 A successful response. -
0 An unexpected error response. -