Introduction
The license endpoint allows you to track the number of licenses found on your devices..
How Does it Work?
Open-AudIT uses the data collected from your devices and matches the software installed with the value provided, it counts the matches calculates how many licenses have been used and how many are left. It allows the use of wildcards on the "match string" field which matches the software.name attribute.
Creating a Licenses Entry
A License entry can be created using the web interface if the current user logged in has a role that contains the licenses::create permission. Go to menu: Manage -> Licenses -> Create Licenses. Also can be created from the Licenses View, using the "+" button.
To create an entry to track your licenses you have to provide a name, an organization, the number of licenses acquired and the name of the software. On the field "Match String" you have to provide the name of the software that you want to track, you can use the percent sign (%) as a wildcard in the match_string.
View License Details
Go to menu: Manage -> Licenses -> List Licenses.
You will see a list of Licenses. You can view a License by clicking on the blue view icon.
You can also edit or delete the licenses.
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: Admin -> Database -> List Tables, then clicking on the "licenses" table.
CREATE TABLE `licenses` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(200) NOT NULL DEFAULT '',
`org_id` int(10) unsigned NOT NULL DEFAULT '1',
`org_descendants` enum('y','n') NOT NULL DEFAULT 'y',
`purchase_count` int(10) unsigned NOT NULL DEFAULT '0',
`used_count` int(10) unsigned NOT NULL DEFAULT '0',
`description` text NOT NULL,
`match_string` text NOT NULL,
`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=4 DEFAULT CHARSET=utf8;
A typical entry looks as below.
id: 3
name: Microsoft Office 2013 Professional Plus
org_id: 2
org_descendants: y
purchase_count: 45
used_count: 0
description: Microsoft Office 2013 Professional Plus for Mgmt Staff
match_string: %Microsoft Office 2013%
edited_by: Administrator
edited_date: 2017-05-31 09:57:30
API / Web Access
You can access the /licenses collection using the normal Open-AudIT JSON based API. Just like any other collection. Please see the API documentation for further details.
Access is provided as part of a roles permissions. Licenses 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 |
|---|---|---|---|---|---|---|---|
| POST | n | create | licenses::create | /licenses | Insert a new license entry. | licenses_create.json | |
| GET | y | read | licenses::read | /licenses/{id} | Returns a license details. | licenses_read.json | |
| PATCH | y | update | licenses::update | /licenses/{id} | Update an attribute of a license entry. | licenses_update.json | |
| DELETE | y | delete | licenses::delete | /licenses/{id} | Delete a license entry. | licenses_delete.json | |
| GET | n | collection | licenses::read | /licenses | Returns a list of licenses. | licenses_collection.json |
Web Application Routes
Request Method | ID | Action | Resulting Function | Permission Required | URL Example | Notes |
|---|---|---|---|---|---|---|
| GET | n | create | create_form | licenses::create | /licenses/create | Displays a standard web form for submission to POST /licenses. |
| GET | y | update | update_form | licenses::update | /licenses/{id}/update | Show the license details with the option to update attributes using PATCH to /licenses/{id} |