Orgs (pre v2)
Introduction
This new access method replaces the old admin_org controller and functions.
Creating an Organisation
To make another location go to menu -> Admin -> Organisations -> Create Organisation.
View Organisation Details
Go to menu -> Admin -> Organisations -> List Organisations.
You will see a list of available organisations. You can view an organisation by clicking on the it's ID (in green). You can also edit or delete the organisation (if delete is permitted). You cannot delete the Default Organisation.
You will also see a list of the devices assigned to that particular organisation.
Organisations are stored in the database in the "oa_org" table. A typical entry will look as below.
id: 0
name: Default Organisation
parent_id: 0
group_id: 3
comments:
API / Web Access?
You can access the /orgs 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 | Example Response |
---|---|---|---|---|---|---|
GET | n | collection | /orgs | Returns a list of organisations. | orgs_collection.json | |
GET | y | read | /orgs/{id} | Returns an organisation's details. | orgs_read.json | |
PATCH | y | update | /orgs/{id} | Update an attribute of an organisations entry. | orgs_patch.json | |
POST | n | create | /orgs | Insert a new organisations entry. | orgs_create.json | |
DELETE | y | delete | /orgs/{id} | Delete an organisations entry. | orgs_delete.json |
Web Application Routes
Request Method | ID | Action | Resulting Function | URL Example | Notes |
---|---|---|---|---|---|
GET | n | create | create_form | /orgs/create | Displays a standard web form for submission to POST /orgs. |
GET | y | update | update_form | /orgs/{id}/update | Show the networks details with the option to update attributes using PATCH to /orgs/{id} |