...
The schema for the database is below. It can also be found in the application is if the user has database::read permission by going to menu: Manage -> Database -> List Database, then clicking on the "integrations" table.
...
The API routes below are usable from both a JSON Restful API and the web interface.
API Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes | Example Response |
|---|---|---|---|---|---|---|---|
| GET | n | collection | integrations::read | /integrations | Returns a list of integrations. | ||
| POST | n | create | integrations::create | /integrations | Insert a new integrations entry. | ||
| GET | y | read | integrations::read | /integrations/{id} | Returns an integrations details. | ||
| PATCH | y | update | integrations::update | /integrations/{id} | Update the details of an integrations entry. | ||
| DELETE | y | delete | integrations::delete | /integrations/{id} | Delete an integrations entry. |
Web Application Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes |
|---|---|---|---|---|---|---|
| GET | n | create | create_form | integrations::create | /integrations/create | Displays a standard web form for submission to POST /integrations. |
| GET | y | update | update_form | integrations::update | /integrations/{id}/update | Show the attributes details with the option to update details using PATCH to /integrations/{id} |