RiskAnalyticsDataProcessorApi.md

.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()

Example

import { createConfiguration, RiskAnalyticsDataProcessorApi } from '';
import type { RiskAnalyticsDataProcessorApiRiskAnalyticsDataProcessorGetRiskContextRequest } from '';

const configuration = createConfiguration();
const apiInstance = new RiskAnalyticsDataProcessorApi(configuration);

const request: RiskAnalyticsDataProcessorApiRiskAnalyticsDataProcessorGetRiskContextRequest = {
    // Risk id.
  riskId: 1,
    // Timezone in IANA format. (optional)
  timezone: "timezone_example",
};

const data = await apiInstance.riskAnalyticsDataProcessorGetRiskContext(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
riskId	[number]	Risk id.	defaults to undefined
timezone	[string]	Timezone in IANA format.	(optional) defaults to undefined

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

riskAnalyticsDataProcessorGetRiskPredefinedQuestions

Riskanalyticsdataprocessorv3GetRiskPredefinedQuestionsResponse riskAnalyticsDataProcessorGetRiskPredefinedQuestions()

Example

import { createConfiguration, RiskAnalyticsDataProcessorApi } from '';
import type { RiskAnalyticsDataProcessorApiRiskAnalyticsDataProcessorGetRiskPredefinedQuestionsRequest } from '';

const configuration = createConfiguration();
const apiInstance = new RiskAnalyticsDataProcessorApi(configuration);

const request: RiskAnalyticsDataProcessorApiRiskAnalyticsDataProcessorGetRiskPredefinedQuestionsRequest = {
    // Risk id.
  riskId: 1,
};

const data = await apiInstance.riskAnalyticsDataProcessorGetRiskPredefinedQuestions(request);
console.log('API called successfully. Returned data:', data);

Parameters

Name	Type	Description	Notes
riskId	[number]	Risk id.	defaults to undefined

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]