Digital Evidence Management API (1.0.0-SNAPSHOT)

Creates a new record. There are four required fields: "type", "metadata", "coreData", "TTL" and two optional fields: "relations" and "auditLevel".

Record Type

You are required to supply a record type in the 'type' parameter when posting a new record.These are the available types:

Type name	Description (suggested use)
GDPR	Can be used for documentation of GDPR compliance.
TRANSACTION	Can be used for documenting financial transactions.
LOG_IN	Can be used for documenting users logging in to a system.
SIGNATURE	Can be used for documenting digital signatures.
SENSITIVE	Can be used for documenting sensitive information.
OTHER	Can be used for everything else.

Metadata

Can contain any amount of data which will then be searchable in future queries.

Core Data

Can contain any amount of data which will then be timestamped.

TTL

Time to Live as denoted in amount of days (Int).

Relations

Optional field. List of the IDs (String) of the related records. Default: Empty list

Audit Level

Optional field. Decides which level of timestamping and verification will be applied to the record.

SIMPLE	Uses hashing to verify data.
ADVANCED	Uses TSA to timestamp and verify.
QUALIFIED	USES QTSA to timestamp and verify. Default if value is not set explicitly

Updates the Time to Live (TTL) of selected records by a defined query.
The query is built on the MongoDB Query Language (MQL), but it is database-agnostic.

Queries the database to return a pageable list of records without coreData.
If no body is included, the endpoint will return pages of all records.
The size and page number as well as sorting and ordering of the returned page is decided by the parameters page, size and sort.

Request Body

The query is built from the request body. The request body is an object containing up to two lists of QueryCondition objects.
If no lists are provided, the query will return every record in the collection.

List name	Description
and	Combines the QueryConditions with the logical AND operator. All of the QueryConditions need to return true.
or	Combines the QueryConditions with the logical OR operator. Only one of the QueryConditions needs to return true.

Query Condition

A query condition consists of three parts: field, operator and value.

Field

The field parameter denotes which field in the database to apply the query condition to.
Replace '*' with the sub-field you wish to query. For example "metadata.firstName" or "systemMetadata.createdDateTime"
These are the allowed fields:

Field	Description
metadata	Metadata added by the user.
systemMetadata	Metadata added by DEM.
relations	Any other record relations added by the user.

Operator

The operator specifies how the condition uses the value to search for records.
These are the available query operators:

Query Operation	Description
eq	Checks if the field's value matches the input value exactly.
ne	Checks if the field's value does not match the input value.
gt	Checks if the field's value is greater than the input value. Works best with numeric values.
gte	Checks if the field's value is greater than or equal to the input value. Works best with numeric values.
lt	Checks if the field's value is less than the input value. Works best with numeric values.
lte	Checks if the field's value is less than or equal to the input value. Works best with numeric values.
regex	Checks if the field's value contains the input value using regex. Works best with String values.
in	Checks if the field's value matches any of the values in the inputted array.
nin	Checks if the field's value does not match any of the values in the inputted array.

Value

The value parameter denotes what value the query condition should use. For example: with the EQUAL operator, the value is what the field should be equal to.

Retrieves a specific record by its ID. The given ID must conform to the UUID/GUID standard.
For example: 123e4567-e89b-12d3-a456-556642440000
Returns everything included in the record entity.

Specifies when the record will automatically be deleted from the database. Takes an amount of days as a positive integer of 2 or higher and updates the expiry date with the new value.

Takes a Record ID as a parameter. It retrieves the record and generates a PDF report for the record.

Retrieves statistics on records stored in DEM.

Aggregates all of the customer's records to return a list of all unique keys from the customerMeta field.

Aggregates all of the customer's records to return a list of all unique keys from the customerMeta field.