Table of Contents |
---|
Introduction
As at 1.12.8 we have introduced the Connections endpoint.
How Does it Work?
Creating a Connection
To make another network go to menu -> Admin -> This endpoint enables you to add the connections that are part of your network infrastructure, it allows you to customize a variety of attributes, specify where this connection is located and the organization that it belongs.
Creating a Connection
A connection can be created using the web interface if a user has a role that contains the connection::create permission. Go to menu: Manage -> Connections -> Create Connection. Also can be created from the Connection View, using the "Create" button.
'
View Connection Details
Go to menu -> Admin : Manage-> Connections -> List Connections.
...
...
Connections are stored in the database in the "oa_connection" table. A typical entry will look as below.
id: 5
org_id: 0
name: Marks Home Connection
provider: Telstra 23
service_type: Cable
product_name: Bigpond Cable Ultimate
service_identifier:
speed: 100.000
location_id_a: 2
location_id_b: 2
system_id_a: 0
system_id_b: 0
line_number_a:
line_number_b:
ip_address_external_a:
ip_address_external_b:
ip_address_internal_a:
ip_address_internal_b:
API / Web Access?
...
Database Schema
The database schema can be found in the application is the user has database::read permission by going to menu: Admin -> Database -> List Tables, then clicking on the details button for the table.
API / Web Access
You can access the collection using the normal Open-AudIT JSON based API. Just like any other collection. Please
...
see The Open-AudIT API documentation for further details
...
API Routes
...
...
...
...
...
...
...
.
...
Web Application Routes
Request Method | ID | Action | Resulting Function | URL Example | Notes |
---|---|---|---|---|---|
GET | n | create | create_form | /connections/create | Displays a standard web form for submission to POST /connections. |
GET | y | update | update_form | /connections/{id}/update | Show the connection's details with the option to update attributes using PATCH to /connections/{id} |
...