RESTEntities

Publish entity

Publish an entity for ingest into the Entities API. Entities created with this method are “owned” by the originator: other sources, such as the UI, may not edit or delete these entities. The server validates entities at API call time and returns an error if the entity is invalid.

An entity ID must be provided when calling this endpoint. If the entity referenced by the entity ID does not exist then it will be created. Otherwise the entity will be updated. An entity will only be updated if its provenance.sourceUpdateTime is greater than the provenance.sourceUpdateTime of the existing entity.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
entityIdstringOptional

A Globally Unique Identifier (GUID) for your entity. If this field is empty, the Entity Manager API automatically generates an ID when it creates the entity.

descriptionstringOptional

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.

isLivebooleanOptional
Indicates the entity is active and should have a lifecycle state of CREATE or UPDATE. Set this field to true when publishing an entity.
createdTimestringOptionalformat: "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.
expiryTimestringOptionalformat: "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.

statusobjectOptional

Human-readable descriptions of what the entity is currently doing.

locationobjectOptional
Geospatial data related to the entity, including its position, kinematics, and orientation.
locationUncertaintyobjectOptional
Indicates uncertainty of the entity's position and kinematics.
geoShapeobjectOptional
Geospatial representation of the entity, including entities that cover an area rather than a fixed point.
geoDetailsobjectOptional
Additional details on what the geospatial area or point represents, along with visual display details.
aliasesobjectOptional
Entity name displayed in the Lattice UI side panel. Also includes identifiers that other systems can use to reference the same entity.
trackedobjectOptional
If this entity is tracked by another entity, this component contains data related to how it's being tracked.
correlationobjectOptional
If this entity has been correlated or decorrelated to another one, this component contains information on the correlation or decorrelation.
milViewobjectOptional
View of the entity.
ontologyobjectOptional
Ontology defines an entity's categorization in Lattice, and improves data retrieval and integration. Builds a standardized representation of the entity.
sensorsobjectOptional
Details an entity's available sensors.
payloadsobjectOptional
Details an entity's available payloads.
powerStateobjectOptional
Details the entity's power source.
provenanceobjectOptional
The primary data source provenance for this entity.
overridesobjectOptional
Provenance of override data.
indicatorsobjectOptional

Describes an entity’s specific characteristics and the operations that can be performed on the entity. For example, “simulated” informs the operator that the entity is from a simulation, and “deletable” informs the operator (and system) that the delete operation is valid against the entity.

targetPriorityobjectOptional

The prioritization associated with an entity, such as if it’s a threat or a high-value target.

signalobjectOptional
Describes an entity's signal characteristics, primarily used when an entity is a signal of interest.
transponderCodesobjectOptional

A message describing any transponder codes associated with Mode 1, 2, 3, 4, 5, S interrogations. These are related to ADS-B modes.

dataClassificationobjectOptional
Describes an entity's security classification levels at an overall classification level and on a per field level.
taskCatalogobjectOptional
A catalog of tasks that can be performed by an entity.
mediaobjectOptional
Media associated with an entity, such as videos, images, or thumbnails.
relationshipsobjectOptional

The relationships between this entity and other entities in the common operational picture (COP).

visualDetailsobjectOptional
Visual details associated with the display of an entity in the client.
dimensionsobjectOptional
Physical dimensions of the entity.
routeDetailsobjectOptional
Additional information about an entity's route.
schedulesobjectOptional
Schedules associated with this entity.
healthobjectOptional
Health metrics or connection status reported by the entity.
groupDetailsobjectOptional
Details for the group associated with this entity.
suppliesobjectOptional
Contains relevant supply information for the entity, such as fuel.
orbitobjectOptional
Orbit information for space objects.

Response

The request was valid and accepted.
entityIdstring or null

A Globally Unique Identifier (GUID) for your entity. If this field is empty, the Entity Manager API automatically generates an ID when it creates the entity.

descriptionstring or null

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 or null
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 or nullformat: "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 or nullformat: "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.

statusobject or null

Human-readable descriptions of what the entity is currently doing.

locationobject or null
Geospatial data related to the entity, including its position, kinematics, and orientation.
locationUncertaintyobject or null
Indicates uncertainty of the entity's position and kinematics.
geoShapeobject or null
Geospatial representation of the entity, including entities that cover an area rather than a fixed point.
geoDetailsobject or null
Additional details on what the geospatial area or point represents, along with visual display details.
aliasesobject or null
Entity name displayed in the Lattice UI side panel. Also includes identifiers that other systems can use to reference the same entity.
trackedobject or null
If this entity is tracked by another entity, this component contains data related to how it's being tracked.
correlationobject or null
If this entity has been correlated or decorrelated to another one, this component contains information on the correlation or decorrelation.
milViewobject or null
View of the entity.
ontologyobject or null
Ontology defines an entity's categorization in Lattice, and improves data retrieval and integration. Builds a standardized representation of the entity.
sensorsobject or null
Details an entity's available sensors.
payloadsobject or null
Details an entity's available payloads.
powerStateobject or null
Details the entity's power source.
provenanceobject or null
The primary data source provenance for this entity.
overridesobject or null
Provenance of override data.
indicatorsobject or null

Describes an entity’s specific characteristics and the operations that can be performed on the entity. For example, “simulated” informs the operator that the entity is from a simulation, and “deletable” informs the operator (and system) that the delete operation is valid against the entity.

targetPriorityobject or null

The prioritization associated with an entity, such as if it’s a threat or a high-value target.

signalobject or null
Describes an entity's signal characteristics, primarily used when an entity is a signal of interest.
transponderCodesobject or null

A message describing any transponder codes associated with Mode 1, 2, 3, 4, 5, S interrogations. These are related to ADS-B modes.

dataClassificationobject or null
Describes an entity's security classification levels at an overall classification level and on a per field level.
taskCatalogobject or null
A catalog of tasks that can be performed by an entity.
mediaobject or null
Media associated with an entity, such as videos, images, or thumbnails.
relationshipsobject or null

The relationships between this entity and other entities in the common operational picture (COP).

visualDetailsobject or null
Visual details associated with the display of an entity in the client.
dimensionsobject or null
Physical dimensions of the entity.
routeDetailsobject or null
Additional information about an entity's route.
schedulesobject or null
Schedules associated with this entity.
healthobject or null
Health metrics or connection status reported by the entity.
groupDetailsobject or null
Details for the group associated with this entity.
suppliesobject or null
Contains relevant supply information for the entity, such as fuel.
orbitobject or null
Orbit information for space objects.

Errors