Introduction
How Does it Work?
Creating a Connection
To make another network go to menu -> Admin -> Fields -> Create Field.
View Connection Details
Go to menu -> Admin -> Fields -> List Fields.
You will see a list of fields. You can view a field by clicking on the it's ID (in green). You can also edit or delete the field.
Fields are stored in the database in the "additional_field" table. A typical entry will look as below.
id: 3
group_id: 1
name: Additional Field
type: varchar
values:
placement: system
API / Web Access?
You can access the /fields collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.
API Routes
Request Method | ID | Action | Resulting Function | URL Example | Notes |
|---|---|---|---|---|---|
| GET | n | collection | /fields | Returns a list of fields. | |
| GET | y | read | /fields/{id} | Returns a field's details. | |
| PATCH | y | update | /fields/{id} | Update an attribute of a fields entry. | |
| POST | n | create | /fields | Insert a new fields entry. | |
| DELETE | y | delete | /fields/{id} | Delete a fields entry. |
Web Application Routes
Request Method | ID | Action | Resulting Function | URL Example | Notes |
|---|---|---|---|---|---|
| GET | n | create | create_form | /fields/create | Displays a standard web form for submission to POST /fields. |
| GET | y | update | update_form | /fields/{id}/update | Show the connection's details with the option to update attributes using PATCH to /fields/{id} |