Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To make another organisation go to menu: Manage -> Orgs -> Create Orgs. 


Image Added

Image Removed


 Image Added

Image Removed

View Organisation Details

...

You will see a list of organisations. You can view an organisation by clicking on the blue view button. You can also edit or delete your organisations.

Image RemovedImage Added

 


Database Schema

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

Code Block
languagetext
themeEclipselanguagetext
CREATE TABLE `orgs` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(200) NOT NULL DEFAULT '',
  `parent_id` int(10) unsigned DEFAULT '1',
  `description` text NOT NULL,
  `ad_group` varchar(100) NOT NULL DEFAULT '',
  `edited_by` varchar(200) NOT NULL DEFAULT '',
  `edited_date` datetime NOT NULL DEFAULT '2000-01-01 00:00:00',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8;

...

Orgs are stored in the database in the "orgs" table. A typical entry will look as below.

Code Block
language
languagetext
themeEclipsetext
         id: 2
       name: Sea View Office
  parent_id: 1
description: Awesome view
   ad_group: 
  edited_by: Administrator
edited_date: 2017-05-17 16:31:44

...

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
GETn
 

collection/orgsReturns a list of organisations.orgs_collection.json
GETy
 

read/orgs/{id}Returns an organisation's details.orgs_read.json
PATCHy
 

update/orgs/{id}Update an attribute of an organisations entry.orgs_patch.json
POSTn
 

create/orgsInsert a new organisations entry.orgs_create.json
DELETEy
 

delete/orgs/{id}Delete an organisations entry.orgs_delete.json

Web Application Routes

Request Method
ID
Action
Resulting Function
URL Example
Notes
GETncreatecreate_form/orgs/createDisplays a standard web form for submission to POST /orgs.
GETyupdateupdate_form/orgs/{id}/updateShow the networks details with the option to update attributes using PATCH to /orgs/{id}