-
Notifications
You must be signed in to change notification settings - Fork 0
Getting Data from the Database
eamonnmag edited this page Sep 17, 2014
·
42 revisions
All data in the database can be retrieved from the API as JSON. In fact, all the visualizations are driven by the very same APIs (especially for aggregate information).
The pattern for retrieving data is very simple.
To get all records, the URL is formed as /data-sub/api/<data_type>/?format=json
To get a single record, the URL is formed as /data-sub/api/<data_type>/<id>/?format=json
The available data types are:
-
loginsession (Login sessions).
- Get all (
/data-sub/api/loginsession/?format=json). - Get a single record (
/data-sub/api/loginsession/1/?format=json) - You can also filter login sessions through a number of parameters:
-
name - add
&name=Simon Waltonfor example -
employee_id - add
&employee_id=SW001for example
-
name - add
- Get all (
-
employee (Employees).
- Get all (
/data-sub/api/employee/?format=json) - Get a single record (
/data-sub/api/employee/1/?format=json) - You can also filter login sessions through a number of parameters:
-
name - add
&name=Simon Waltonfor example -
employee_id - add
&employee_id=SW001for example
-
name - add
- Get all (
-
communications (Email/Web Communications).
- Get all (
/data-sub/api/communications/?format=json) | - Get a single record (
/data-sub/api/communications/1/?format=json) - You can also filter login sessions through a number of parameters:
-
communicationType - add
&communicationType=Efor email&communicationType=Wfor web records -
employee_id - e.g.
&employee_id=SW001 -
source - add
&source=insider@gmail.com -
destination - add
&destination=j.dory@yahoo.com
-
communicationType - add
- Get all (
-
devices (Device Insertions).
- Get all (
/data-sub/api/device/?format=json). - Get a single record (
/data-sub/api/device/1/?format=json)
- Get all (
-
contract (Employee Contracts).
- Get all (
/data-sub/api/contract/?format=json) - Get a single record (
/data-sub/api/contract/1/?format=json)
- Get all (
-
department (Departments).
- Get all (
/data-sub/api/department/?format=json) - Get a single record (
/data-sub/api/department/1/?format=json)
- Get all (
-
employeecontact (Departments).
- Get all (
/data-sub/api/employeecontact/?format=json) - Get a single record (
/data-sub/api/employeecontact/1/?format=json)
- Get all (