Last updated Aug 13, 2024

Entity identifiers dos and donts

WIP

The role of entity identifiers in DROID

Providers send data to DROID as entities. Each entity is uniquely identified by a pair of entity type and entity identifier (entityId). The former is agreed upon by DROID team and the provider while the latter is generally controlled by the provider. Entity identifiers often form part of resulting TCS keys that are queried by DROID consumers. There are some requirements and best practices to ensure a seamless integration and flow of data between providers, DROID and consumers.

Dos and Don'ts

DoDon't
Use a URL friendly string as entity identifier eg. an UUIDInclude special characters in entity identifier e.g. ? | #
Use an ARI as entity identifier

Rate this page: