Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

*(Under Review for V2)

Introduction

How Does it Work?

View Database Details

Go to menu:  Manage   Admin -> Database -> List DatabaseTables.

You will see a list of tables that are part of the database if the your user has database::read permission.

Image RemovedImage Added

 


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.

Image Removed

 

The following example shows the values exported on CSV format for the table "Roles".

 

Image Removed

 

Image Added


API / Web Access

You can access the

...

collection using the normal Open-AudIT JSON based API. Just like any other collection. Please

...

Access is provided as part of a roles permissions. Summaries is a standard resource and can have create, read, update and delete 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
POSTn createsummaries::create/summariesInsert a new summaries entry. 
GETy readsummaries::read/summaries/{id}Returns a summaries details. 
PATCHy updatesummaries::update/summaries/{id}Update an attribute of a summaries entry. 
DELETEy deletesummaries::delete/summaries/{id}Delete a summaries entry. 
GETn collectionsummaries::read/summariesReturns a list of summaries. 
POSTnimportimportsummaries::create/summaries/importImport multiple connections using a CSV. 
GETyexecuteexecutesummaries::read/summaries/2/executeExecute (run) a summary and show the result. 

Web Application Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
GETncreatecreate_formsummaries::create/summaries/createDisplays a standard web form for submission to POST /summaries.
GETyupdateupdate_formsummaries::update/summaries/{id}/updateShow the summaries details with the option to update attributes using PATCH to /summaries/{id}
GETnimportimport_formsummaries::create/summaries/importDisplays a standard web form for submission to POST /summaries/import.

 

 

 

...

see The Open-AudIT API documentation for further details.