v1

latestOpenAPI 3.1.02026-08-0421263172.4 KB

entities

Override entity

Only fields marked with overridable can be overridden. Please refer to our documentation to see the comprehensive list of fields that can be overridden. The entity in the request body should only have a value set on the field specified in the field path parameter. Field paths are rooted in the base entity object and must be represented using lower_snake_case. Do not include "entity" in the field path.

Note that overrides are applied in an eventually consistent manner. If multiple overrides are created concurrently for the same field path, the last writer wins.

put/api/v1/entities/{entityId}/override/{fieldPath}

Path parameters

entityIdstring required

The unique ID of the entity to override

fieldPathstring required

fieldPath to override

Headers

Authorizationstring required

Bearer authentication

Request body

Response

The Entities API accepts the override.

entityIdstring

A Globally Unique Identifier (GUID) for your entity. This is a required field.

descriptionstring

A human-readable entity description that's helpful for debugging purposes and human traceability. If this field is empty, the Entity Manager API generates one for you.

isLiveboolean

Indicates the entity is active and should have a lifecycle state of CREATE or UPDATE. Set this field to true when publishing an entity.

createdTimestring date-time

The time when the entity was first known to the entity producer. If this field is empty, the Entity Manager API uses the current timestamp of when the entity is first received. For example, when a drone is first powered on, it might report its startup time as the created time. The timestamp doesn't change for the lifetime of an entity.

expiryTimestring date-time

Future time that expires an entity and updates the is_live flag. For entities that are constantly updating, the expiry time also updates. In some cases, this may differ from is_live. Example: Entities with tasks exported to an external system must remain active even after they expire. This field is required when publishing a prepopulated entity. The expiry time must be in the future, but less than 30 days from the current time.

noExpiryboolean

Use noExpiry only when the entity contains information that should be available to other tasks or integrations beyond its immediate operational context. For example, use noExpiry for long-living geographical entities that maintain persistent relevance across multiple operations or tasks.