Introduction
How Does it Work?
View Database Details
Go to menu: Admin -> Database -> List Tables.
You will see a list of tables that are part of the database if the your user has database::read permission.
You can view a the details of the listed tables by clicking on the blue view button. It will list the attributes of the table, the number of row and the table structure. In addition, there is an option to export the data of the table on 3 formats (CSV, SQL and XML), the data will be appended at the end of the current view.
The following example shows the values exported on CSV format for the table "Roles".
API / Web Access
You can access the /database collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.
Access is provided as part of a roles permissions. Database is a standard resource and have read permissions only.
API Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes | Example Response |
|---|---|---|---|---|---|---|---|
| GET | y | read | database::read | /database/{name} | Returns a table details. | database_read.json | |
| GET | n | collection | database::read | /database | Returns the tables of the database. | database_collection.json |