EN: Oz Knowledge Base
Search
K
Links

Metadata

Overview

For most of the system objects, you can store metadata – any fields and their values created by users. Here is a list of these objects:
  • users /api/users/{{user_id}}/meta_data
  • folders /api/folders/{{folder_id}}/meta_data
  • media /api/media/{{media_id}}/meta_data
  • analyses /api/analyses/{{analyse_id}}/meta_data
  • collections/api/collections/{{collection_id}}/meta_data

Methods

To process metadata, you can use the Rest API methods:
get
https://apidoc.ozforensics.com
/api/.../metadata
Getting all fields
post
https://apidoc.ozforensics.com
/api/.../metadata
Adding/replacing fields
patch
https://apidoc.ozforensics.com
/api/.../metadata
Modifying fields
delete
https://apidoc.ozforensics.com
/api/.../metadata
Metadata deletion

Example

Here is how to add the client ID client_iin to a folder object.
You can pass an ID of a person in this field, and use this ID to combine requests with the same person and count unique persons (same ID = same person, different IDs = different persons). This ID can be a phone number, an IIN, an SSN, or any other kind of unique ID. The ID will be displayed in the report as an additional column.
patch
https://apidoc.ozforensics.com
/api/folders/your_folder_id/meta_data
Adding client id
You can also add metadata via SDK to process the information later using API methods. Please refer to the corresponding SDK sections: