# System Objects

### Objects Hierarchy <a href="#h.ggouwc3sh8vi" id="h.ggouwc3sh8vi"></a>

System objects on Oz Forensics products are hierarchically structured as shown in the picture below.

<figure><img src="https://2532558063-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F5g6dgsxRbyrCvB0uAf8f%2Fuploads%2FhG2RBicGbU9rS5S17wCx%2Fsystem%20objects.drawio%20(1).png?alt=media&#x26;token=7ef3bbea-df7d-4b63-869b-0e2e4448ed6b" alt=""><figcaption></figcaption></figure>

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](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/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](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/rules-of-assigning-analyses). The media quality requirements are listed on [this page](https://doc.ozforensics.com/oz-knowledge/other/media-quality-requirements).

### Object parameters <a href="#h.8qbhvc9qlj0s" id="h.8qbhvc9qlj0s"></a>

#### Common parameters <a href="#h.t7l2z4e3z113" id="h.t7l2z4e3z113"></a>

| 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.

#### Company <a href="#h.n8d1ba6kh8gn" id="h.n8d1ba6kh8gn"></a>

| Parameter   | Type   | Description                    |
| ----------- | ------ | ------------------------------ |
| company\_id | UUID   | Company ID within the system   |
| name        | String | Company name within the system |

#### User <a href="#h.s4vjermbphm2" id="h.s4vjermbphm2"></a>

| Parameter               | Type    | Description                                                                                                                            |
| ----------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| user\_id                | UUID    | User ID within the system                                                                                                              |
| user\_type              | String  | [User roles](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/user-roles)                                    |
| ​​first\_name           | String  | Name                                                                                                                                   |
| last\_name              | String  | Surname                                                                                                                                |
| middle\_name            | String  | Middle name                                                                                                                            |
| email                   | String  | User email = login                                                                                                                     |
| password                | String  | User password (only required for new users or to change)                                                                               |
| can\_start\_analyze\_\* | String  | Depends on [user roles](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/user-roles)                         |
| company\_id             | UUID    | Current user company’s ID within the system                                                                                            |
| is\_admin               | Boolean | ​​Whether this user is an [admin](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/user-roles) or not        |
| is\_service             | Boolean | ​​Whether this user account is [service](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/user-roles) or not |

#### Folder <a href="#h.cs9qx3iyult" id="h.cs9qx3iyult"></a>

| Parameter          | Type             | Description                 |
| ------------------ | ---------------- | --------------------------- |
| folder\_id         | UUID             | Folder ID within the system |
| resolution\_status | ResolutionStatus | The latter analysis status  |

#### Media <a href="#h.85wv26msdlji" id="h.85wv26msdlji"></a>

| 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](https://doc.ozforensics.com/oz-knowledge/guides/developer-guide/api/oz-api/media-tags) for this file |

#### Analysis <a href="#h.pbaoihdesmt6" id="h.pbaoihdesmt6"></a>

| 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                    |