The Entities API
The Entities API provides a common understanding of entities within the common operational picture (COP). Every object in a COP is represented as an "Entity". Each Entity is essentially an ID, with a life cycle, and a collection of data components. Each data component is a separate top level field within the entity type definition.
The Entities API provides a way to query the currently live set of entities within a set of filter constraints, as well as a limited set of management APIs to change the grouping or relationships between entities.
Authentication
- HTTP: Bearer Auth
Bearer token using a JWT
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
Create or update an entity
Publish an entity for ingest into the Entities API. Entities created with this method are 'owned' by the originator: other sources,
Get entity
Get the content of an entity
Override an entity component
Only fields marked with overridable can be overridden. Please refer to our documentation to see the comprehensive
Remove an entity override
This operation clears the override value from the specified field path on the entity.
Watch entity events
This is a long polling API that will first return all preexisting data and then return all new data as