Data model for the Clearance API

Clearance Developer Guide

Content type
Guides > Developer guides
Product line
Clearance
Language
English
Applies to
Genetec Clearance

Genetec Clearance™ is a platform that helps users manage digital evidence in security or criminal investigations. The user interface is built on a REST API, accessible to authenticated users or back-end services.

Normally, when an investigation starts, the investigator creates a case in Clearance and adds files (Evidences and Resources) to the case as the investigation progresses.

An investigator owns the Case and can grant permissions (Access Policies) to various users for managing, viewing, editing, and downloading the information contained in the Case.


Entity model

Since Clearance is a multi-tenant cloud system, one customer account is called a Tenant. Every entity in Clearance is attached to a Tenant. In the REST API, every request requires a TenantId in the URL to specify which customer is issuing the call.

curl -X GET --header 'Accept: application/json' '{DocumentStoreBaseAddresses}/case/{tenantID}/{CaseId}'

Cases

The Case is the common entity used to collaborate. It contains metadata (location, description, category, tags) and a list of Evidence entities that are linked to that Case. The Access Policies on a Case contain a list of users or groups and their associated privileges (manage, edit, view and download, view only).

If an authenticated user is trying to read the content of a case and is not part of the Access Policies, the Case Service API returns 403 Forbidden.

Evidence

The Evidence entity represents one item of digital evidence, but sometimes more than one file is required. This could be because different representations of the same data are possible or metadata is required to complete a media file.

For example, when a video file is uploaded to Clearance, the system detects its format and attempts to generate a browser-compatible MP4 file for easier visualization. The MP4 version is then appended to the Evidence as a new resource.

The Evidence Service API must be used to manipulate evidence in the system.

Cases and Evidence relation

The relationship between Evidences and Cases is many to many. Evidence can be linked to zero or more Cases and a Case can be linked to zero or more Evidences.

The Evidence has its own Access Policies, but because it is linked to Cases, any change in the linked Cases is automatically reflected in the Evidences for simplicity.

Unique ID

Cases and Evidence can be referenced in the system by using their unique ID. The ID is a string that is required in the API. To find a Case or an Evidence item's unique ID, the Search Service API enables full text searching with predefined filters across all tenant entities.

https://clearance-a-cs.geneteccloud.com/api/v1/case/{TenantId}/{CaseId}