Risk Assessment Dashboard APIs

Get Overall Summary (GET)

See <see cref="IOpenRiskAssessmentDashboardService.GetOverallSummary"/>.

Route

URI	/api/v1/RiskAssessmentDashboard/OverallSummary
Method	GET
Result	JSON – RiskAssessmentDashboardResultSummary

Parameters

None

Response Structure Returns RiskAssessmentDashboardResultSummary object containing:

• Score: The risk assessment score ranging between 0 and 100.

• Count: The number of issues found within this scenario (e.g. the number of recursive groups).

• TotalCount: The total number of entities to be compared against (e.g. the total number of groups).

Example

GET http://localhost/api/v1/RiskAssessmentDashboard/OverallSummary

Example Response

{     "Score": 0.0,     "Count": 1,     "TotalCount": 1 }

Get Scenario Details (GET)

See <see cref="IOpenRiskAssessmentDashboardService.GetScenarioDetails"/>.

Route

URI	/api/v1/RiskAssessmentDashboard/ScenarioDetails/{id}
Method	GET
Result	JSON – RiskAssessmentScenarioDetails

Parameters

Name	Type	Mandatory	Description
id	Guid	Yes

Response Structure Returns RiskAssessmentScenarioDetails object containing:

• Paragraphs: A list of paragraphs with headers.

• PositionOfOverallData: The position of the overall data (score, total counts) relative to the <see cref="Paragraphs"/>. The value must be between 0 and <see cref="Paragraphs"/>.Length, inclusively. (0 means before the first paragraph, and <see cref="Paragraphs"/>.Length means after the last paragraph.)

• PositionOfDetailedData: The position of the detailed data (e.g. split according to providers) and diagrams. <seealso cref="PositionOfOverallData"/>

Example

GET http://localhost/api/v1/RiskAssessmentDashboard/ScenarioDetails/{id}

Example Response

{     "Paragraphs": {},     "PositionOfOverallData": 1,     "PositionOfDetailedData": 1 }

Refresh (POST)

See <see cref="IOpenRiskAssessmentDashboardService.RefreshScenario"/>.

Route

URI	/api/v1/RiskAssessmentDashboard/ScenarioDetails/{id}/Refresh
Method	POST
Result	JSON – ChangeResult

Parameters

Name	Type	Mandatory	Description
id	Guid	Yes

Response Structure Returns ChangeResult object containing:

- Success: bool value

- Data: object value

- ResponseId: Guid? value

- ErrorDetails: ExternalInterfaceException value

Example

POST http://localhost/api/v1/RiskAssessmentDashboard/ScenarioDetails/{id}/Refresh

Example Response

{     "Success": true,     "Data": {},     "ResponseId": "123e4567-e89b-12d3-a456-426614174000",     "ErrorDetails": {} }

Get Scenario Result Summaries (GET)

See <see cref="IOpenRiskAssessmentDashboardService.GetScenarioResultSummaries"/>.

Route

URI	/api/v1/RiskAssessmentDashboard/ScenarioResultSummaries
Method	GET
Result	JSON – RiskAssessmentDashboardResultSummary[]

Parameters

None

Response Structure Returns RiskAssessmentDashboardResultSummary[] object containing:

• Score: The risk assessment score ranging between 0 and 100.

• Count: The number of issues found within this scenario (e.g. the number of recursive groups).

• TotalCount: The total number of entities to be compared against (e.g. the total number of groups).

Example

GET http://localhost/api/v1/RiskAssessmentDashboard/ScenarioResultSummaries

Example Response

{     "Score": 0.0,     "Count": 1,     "TotalCount": 1 }

Get Scenario Result Summary (GET)

See <see cref="IOpenRiskAssessmentDashboardService.GetScenarioResultSummary"/>.

Route

URI	/api/v1/RiskAssessmentDashboard/ScenarioResultSummary/{id}
Method	GET
Result	JSON – RiskAssessmentDashboardResultSummary

Parameters

Name	Type	Mandatory	Description
id	Guid	Yes

Response Structure Returns RiskAssessmentDashboardResultSummary object containing:

• Score: The risk assessment score ranging between 0 and 100.

• Count: The number of issues found within this scenario (e.g. the number of recursive groups).

• TotalCount: The total number of entities to be compared against (e.g. the total number of groups).

Example

GET http://localhost/api/v1/RiskAssessmentDashboard/ScenarioResultSummary/{id}

Example Response

{     "Score": 0.0,     "Count": 1,     "TotalCount": 1 }