Child pages
  • Connections (pre v2)
Skip to end of metadata
Go to start of metadata

Introduction

As at 1.12.8 we have introduced the Connections endpoint.

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 -> Resources -> Connections -> Create. There is also a create button on the collection page.

View Connection Details

Go to menu -> Admin -> Connections -> List Connections.

You will see a list of connections. You can view a connection by clicking on the it's ID (in green). You can also edit or delete the connection.

Database Schema

The schema for the database is below. It can also be found in the application is the user has database::read permission by going to menu -> Admin -> Database -> List, then clicking on the groups table.

Example Database Entry

Connections are stored in the database in the "connections" table. A typical entry will look as below. 


API / Web Access

You can access the /connections 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
Permission Required
URL Example
Notes
Example Response
POSTn createconnections::create/connectionsInsert a new connections entry.connections_create.json
GETy readconnections::read/connections/{id}Returns a connection's details.connections_read.json
PATCHy updateconnections::update/connections/{id}Update an attribute of a connections entry.connections_patch.json
DELETEy deleteconnections::delete/connections/{id}Delete a connections entry.connections_delete.json
GETn collectionconnections::read/connectionsReturns a list of connections.connections_collection.json

Web Application Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
GETncreatecreate_formconnections::create/connections/createDisplays a standard web form for submission to POST /connections.
GETyupdateupdate_formconnections::update/connections/{id}/updateShow the connection's details with the option to update attributes using PATCH to /connections/{id}
GETnimportimport_formconnections::create/connections/importDisplays a standard web form for submission to POST /connections/import.
POSTnimportimportconnections::create/connections/importImport multiple connections using a CSV.

 

 

 

 

 

 

  • No labels