API zum Abrufen von Dashboards
Bestimmte Daten aus RiskBoards können über eine API abgerufen werden (aktuell Dashboards). Hierzu muss im entsprechenden Benutzer ein API Key hinterlegt werden, dieser wird als Hash in der Datenbank gespeichert.
Der Abruf der Dashboards erfolgt über ein GET mit folgenden beiden Header Informationen:
X-UserId: Die Id des jeweiligen Benutzers (in den meisten Fällen der Benutzername)
X-ApiKey: der festgelegte API Key
Die URL zum Abruf der Dashboards ist:
https://SERVERNAME/riskboards/dashboards/dashboards
Beispiel Postman:
Die Rückgabe erfolgt als Json.
Beispiel Json:
[
{
"Id": "0e8e8c1c-ea3e-4409-bc8f-7db74baa6377",
"Name": "OCC",
"Version": "V1.0",
"Description": null,
"Menu": false,
"SimulationMenu": false,
"SortOrder": 15,
"Default": false,
"AutoRefresh": 60,
"EnableExport": true,
"EnableAnalysing": false,
"Definition": ".........",
"Statistic": true,
"AssignedRoles": [
"DashboardAccessGroup2"
],
"ChannelsEnabled": false,
"DefaultTags": null,
"OptionalTags": null,
"FilterTagSource": null,
"CreatedBy": null,
"Created": null,
"CodeItemWidgetOptionsPrepared": null,
"Updated": "2025-06-17T16:17:56.599032",
"UpdatedBy": "RiskBoardsSuperUser",
"DataKey": "1."
},
{
"Id": "1b6f8abd-e9bc-4c38-a6c9-7413b590c6ae",
"Name": "TestBE",
"Version": null,
"Description": null,
"Menu": false,
"SimulationMenu": false,
"SortOrder": 10,
"Default": false,
"AutoRefresh": 0,
"EnableExport": true,
"EnableAnalysing": false,
"Definition": ".........",
"Statistic": true,
"AssignedRoles": null,
"ChannelsEnabled": false,
"DefaultTags": null,
"OptionalTags": null,
"FilterTagSource": null,
"CreatedBy": "RiskBoardsSuperUser",
"Created": "2025-03-17T09:33:36.7017064",
"CodeItemWidgetOptionsPrepared": null,
"Updated": "2025-03-17T09:33:36.7017064",
"UpdatedBy": "RiskBoardsSuperUser",
"DataKey": "1."
}
]