Versions Compared

Key

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

...

Details for creating custom queries can be found HERE: Creating a Query, If you need to create a Query that includes a custom Field you should look HERE: Create a Query containing Custom Fields  

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

...

Code Block
languagetext
themeEclipse
CREATE TABLE `queries` (
  `id` int(10) unsigned NOT NULL AUTO_INCREMENT,
  `org_id` int(10) unsigned NOT NULL DEFAULT '1',
  `name` varchar(200) NOT NULL DEFAULT '',
  `category` enum('Change','Device','Hardware','Network','Other','Server','Software','User','') NOT NULL DEFAULT '',
  `description` text NOT NULL,
  `sql` text NOT NULL,
  `link` text NOT NULL,
  `expose` enum('y','n') NOT NULL DEFAULT 'y',
  `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=40 DEFAULT CHARSET=utf8;

A typical entry looks as below.

Code Block
languagetext
themeEclipse
         id: 39
     org_id: 1
       name: AD Controllers
   category: Server
description: Active Directory Domain Controllers
        sql: SELECT system.id AS `system.id`, system.icon AS `system.icon`, system.type AS `system.type`, system.name AS `system.name`, system.domain AS `system.domain`, system.ip AS `system.ip`, system.description AS `system.description`, system.os_family AS `system.os_family`, system.status AS `system.status` FROM system LEFT JOIN windows ON (system.id = windows.system_id AND windows.current = 'y') WHERE @filter AND windows.domain_role LIKE '%Domain Controller' AND system.status = 'production'
       link: 
     expose: y
  edited_by: system
edited_date: 2000-01-01 00:00:00 

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.

Access is provided as part of a roles permissions. Queries is a standard resource and can have create, read, update and delete permissions.

The API routes below are usable from both a JSON Restful API and the web interface. The Web application routes are specifically designed to be called from the web interface (a browser).

API Routes

...

Request Method

...

ID

...

Action

...

Resulting Function

...

Permission Required

...

URL Example

...

Notes

...

Example Response

...

Web Application Routes

...

Request Method

...

ID

...

Action

...

Resulting Function

...

Permission Required

...

URL Example

...

Notes

...

This is possible but rather inelegant at the moment.

...



Default Items

Shipped are a set of default items. These can be found by going to menu: Help → Defaults → Queries.