ListDashboards API
This API fetches the List of Dashboards created in the Server which includes all the widgets configured in the Dashboards as there is no concept of assigning the dashboards/widgets to operators. But the data which is to be populated will be based on the monitors assigned for the user.
Syntax
API for XML Response:
https://[HOST]:[PORT]/AppManager/xml/ListDashboards?apikey=[ Api Key ]
API for JSON Response:
https://[HOST]:[PORT]/AppManager/json/ListDashboards?apikey=[ API Key ]
Supported HTTP methods: GET
Allowed roles: Administrator, Operator
Response Details
| Field | Description |
|---|
| DashboardId | This is the username. |
| DashboardName | This is the description of the user account given at the time of creation of user account |
| Widget | WidgetName -- This represents the display name of the widget
WidgetId -- This is the id of the widget created in this dashboard.
WidgetURL -- This is the link to the widget of this dashboard |
Sample Request
XML Input:
https://apm-prod-server:8443/AppManager/xml/ListDashboards?apikey=aaaaaabbbbbbccccccddddddeeeeee
XML Response:
<AppManager-response uri="/AppManager/xml/ListDashboards">
<result>
<response response-code="4000">
<Dashboard DashboardId="10000001" DashboardName="Default Dashboard">
<Widget WidgetName="Top N Monitors" WidgetId="10000040" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000040"/>
<Widget WidgetName="Current Availability " WidgetId="10000044" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000044"/>
<Widget WidgetName="Last 24 Hours / 30 Days Availability History" WidgetId="10000046" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000046"/>
<Widget WidgetName="Last 24 Hours / 30 Days Health History" WidgetId="10000047" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000047"/>
<Widget WidgetName="Availability,Health and Alarm Summary" WidgetId="10000048" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000048"/>
<Widget WidgetName="Monitor Groups" WidgetId="10000057" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000057"/>
<Widget WidgetName="Infrastructure Snapshot" WidgetId="10000078" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000078"/>
<Widget WidgetName="Recent 10 Alarms" WidgetId="10000079" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000079"/>
<Widget WidgetName="Performance Metric Widget" WidgetId="10000088" WidgetURL="/MyPage.do?method=getWidget&pageid=10000001&widgetid=10000088"/>
</Dashboard>
<Dashboard DashboardId="10000005" DashboardName="pavan dashboard">
<Widget WidgetName="Top N Monitors" WidgetId="10000007" WidgetURL="/MyPage.do?method=getWidget&pageid=10000005&widgetid=10000007"/>
<Widget WidgetName="Tabular Data" WidgetId="10000008" WidgetURL="/MyPage.do?method=getWidget&pageid=10000005&widgetid=10000008"/>
<Widget WidgetName="Recent 10 Alarms" WidgetId="10000009" WidgetURL="/MyPage.do?method=getWidget&pageid=10000005&widgetid=10000009"/>
</Dashboard>
</response>
</result>
</AppManager-response>
JSON Input:
https://apm-prod-server:8443/AppManager/json/ListDashboards?apikey=aaaaaabbbbbbccccccddddddeeeeee
JSON Response:
{"response-code":"4000","response":{"uri":"/AppManager/json/ListDashboards","result":[{"Widget":[{"WidgetName":"Monitor Groups","WidgetId":"20000001","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&widgetid=20000001"},{"WidgetName":"Infrastructure Snapshot","WidgetId":"20000002","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&widgetid=20000002"},{"WidgetName":"Recent 10 Alarms","WidgetId":"20000003","WidgetURL":"/MyPage.do?method=getWidget&pageid=20000001&widgetid=20000003"}],"DashboardId":"20000001","DashboardName":"Default Dashboard"}]}}
