...
API / Web Access
You can access the /summaries collection 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. Summaries Database is a standard resource and can have create, read , update and delete permissions only.The
API
...
API Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes | Example Response | POST | n | create | summaries::create | /summaries | Insert a new summaries entry.|||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| GET | y | read | summariesdatabase::read | /summariesdatabase/{idname} | Returns a summaries details. | ||||||||||
| PATCH | y | update | summaries::update | /summaries/{id} | Update an attribute of a summaries entry. | ||||||||||
| DELETE | y | delete | summaries::delete | /summaries/{id} | Delete a summaries entry. | ||||||||||
| a table details. | database_read.json | ||||||||||||||
| GET | n | collection | summariesdatabase::read | /summaries | Returns a list of summaries. | ||||||||||
| POST | n | import | import | summaries::create | /summaries/import | Import multiple connections using a CSV. | |||||||||
| GET | y | execute | execute | summaries::read | /summaries/2/execute | Execute (run) a summary and show the result. |
Web Application Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes |
|---|---|---|---|---|---|---|
| GET | n | create | create_form | summaries::create | /summaries/create | Displays a standard web form for submission to POST /summaries. |
| GET | y | update | update_form | summaries::update | /summaries/{id}/update | Show the summaries details with the option to update attributes using PATCH to /summaries/{id} |
| GET | n | import | import_form | summaries::create | /summaries/import | Displays a standard web form for submission to POST /summaries/import. |
...
| database | Returns the tables of the database. | database_collection.json |