Child pages
  • Discoveries
Skip to end of metadata
Go to start of metadata

Introduction

Discoveries are preprepared data items that enable you to run a discovery upon a network in a single click, without entering the details of that network each and every time.

How Does it Work?

 

Creating a Discovery

A discovery can be created using the web interface if a user has a role that contains the discoveries::create permission. Go to menu: Discover -> Discoveries -> Create Discoveries. There is also a create button on the collection page.

 

 

View Discovery Details

Go to menu: Discover -> Discoveries -> List Discoveries.

You will see a list of attributes. You can view an attribute by clicking on the blue view button. You can also edit or delete Discovery.

 

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: Manage -> Database -> List Database, then clicking on the "discoveries" table.

Example Database Entry

Discoveries are stored in the database in the "discoveries" table. A typical entry will look as below. 

API / Web Access

You can access the /discoveries 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 creatediscoveries::create/discoveriesInsert a new discoveries entry.discoveries_create.json
GETy readdiscoveries::read/discoveries/{id}Returns a discovery's details.discoveries_create.json
PATCHy updatediscoveries::update/discoveries/{id}Update an attribute of a discoveries entry.discoveries_update.json
DELETEy deletediscoveries::delete/discoveries/{id}Delete a discoveries entry.discoveries_delete.json
GETn collectiondiscoveries::read/discoveriesReturns a list of discoveries.discoveries_collection.json
GETy executediscoveries::read/discoveries/{id}/executeExecute (run) a discovery.discoveries_execute.json

Web Application Routes

Request Method
ID
Action
Resulting Function
Permission Required
URL Example
Notes
GETncreatecreate_formdiscoveries::create/discoveries/createDisplays a standard web form for submission to POST /discoveries.
GETyupdateupdate_formdiscoveries::update/discoveries/{id}/updateShow the discovery's details with the option to update attributes using PATCH to /discoveries/{id}
GETnimportimport_formdiscoveries::create/discoveries/importDisplays a standard web form for submission to POST /discoveries/import.
POSTnimportimportdiscoveries::create/discoveries/importImport multiple discoveries using a CSV.

 

 

 

 

 

 

  • No labels