System Objects
The description of the objects you can find in Oz Forensics system.
Last updated
The description of the objects you can find in Oz Forensics system.
Last updated
System objects on Oz Forensics products are hierarchically structured as shown in the picture below.
On the top level, there is a Company. You can use one copy of Oz API to work with several companies.
The next level is a User. A company can contain any amount of users. There are several roles of users with different permissions. For more information, refer to User Roles.
When a user requests an analysis (or analyses), a new folder is created. This folder contains media. One user can create any number of folders. Each folder can contain any amount of media. A user applies analyses to one or more media within a folder. The rules of assigning analyses are described here. The media quality requirements are listed on this page.
Parameter | Type | Description |
time_created | Timestamp | Object (except user and company) creation time |
time_updated | Timestamp | Object (except user and company) update time |
meta_data | Json | Any user parameters |
technical_meta_data | Json | Module-required parameters; reserved for internal needs |
Besides these parameters, each object type has specific ones.
Parameter | Type | Description |
company_id | UUID | Company ID within the system |
name | String | Company name within the system |
Parameter | Type | Description |
user_id | UUID | User ID within the system |
user_type | String | |
first_name | String | Name |
last_name | String | Surname |
middle_name | String | Middle name |
String | User email = login | |
password | String | User password (only required for new users or to change) |
can_start_analyze_* | String | Depends on user roles |
company_id | UUID | Current user company’s ID within the system |
is_admin | Boolean | Whether this user is an admin or not |
is_service | Boolean | Whether this user account is service or not |
Parameter | Type | Description |
folder_id | UUID | Folder ID within the system |
resolution_status | ResolutionStatus | The latter analysis status |
Parameter | Type | Description |
media_id | UUID | Media ID |
original_name | String | Original filename (how the file was called on the client machine) |
original_url | Url | HTTP link to this file on the API server |
tags | Array(String) | List of tags for this file |
Parameter | Type | Description |
analyse_id | UUID | ID of the analysis |
folder_id | UUID | ID of the folder |
type | String | Analysis type (BIOMETRY\QUALITY\DOCUMENTS) |
results_data | JSON | Results of the analysis |
