...
Dashboard provide "at a glance" important visibility for changes occurring on your network as well as providing quick links to device types, manufacturers, and operating systems and so much more.
Database Schema
The schema for the database is below. It can also be found in the application is the user has database::read permission by going to menu: Manage -> Database -> List Database, then clicking on the "dashboards" table.
| Code Block |
|---|
CREATE TABLE `dashboards` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(100) NOT NULL DEFAULT '',
`org_id` int(10) unsigned NOT NULL DEFAULT '1',
`type` enum('default','org','user','') NOT NULL DEFAULT '',
`user_id` int(10) unsigned NOT NULL DEFAULT '0',
`description` text NOT NULL,
`sidebar` enum('y','n') NOT NULL DEFAULT 'y',
`options` text NOT NULL,
`edited_by` varchar(200) NOT NULL DEFAULT '',
`edited_date` datetime NOT NULL DEFAULT '2000-01-01 00:00:00',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8; |
API / Web Access
You can access the /dashboards collection using the normal Open-AudIT JSON based API. Just like any other collection (assuming you're an Enterprise user). Please see the API documentation for further details.
Access is provided as part of a roles permissions. Dashboards is a standard resource and can have create, read, update, delete and execute permissions.
The API routes below are usable from both a JSON Restful API and the web interface. The Web application routes are specifically designed to be called from the web interface (a browser).
API Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes | Example Response |
|---|---|---|---|---|---|---|---|
| GET | n | collection | dashboards::read | /dashboards | Returns a list of dashboards. | ||
| POST | n | create | dashboards::create | /dashboards | Insert a new dashboards entry. | ||
| GET | y | read | dashboards::read | /dashboards/{id} | Returns a dashboards details. | ||
| PATCH | y | update | dashboards::update | /dashboards/{id} | Update the details of a dashboards entry. | ||
| DELETE | y | delete | dashboards::delete | /dashboards/{id} | Delete a dashboards entry. | ||
| EXECUTE | y | execute | execute | dashboards::read | /dashboards/{id}/execute | Execute a dashboards and return the resulting dataset. |
Web Application Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes |
|---|---|---|---|---|---|---|
| GET | n | create | create_form | dashboards::create | /dashboards/create | Displays a standard web form for submission to POST /dashboards. |
| GET | y | update | update_form | dashboards::update | /dashboards/{id}/update | Show the dashboards details with the option to update details using PATCH to /dashboards/{id} |