pub struct Entity {Show 37 fields
pub entity_id: Option<String>,
pub description: Option<String>,
pub is_live: Option<bool>,
pub created_time: Option<DateTime<Utc>>,
pub expiry_time: Option<DateTime<Utc>>,
pub no_expiry: Option<bool>,
pub status: Option<Status>,
pub location: Option<Location>,
pub location_uncertainty: Option<LocationUncertainty>,
pub geo_shape: Option<GeoShape>,
pub geo_details: Option<GeoDetails>,
pub aliases: Option<Aliases>,
pub tracked: Option<Tracked>,
pub correlation: Option<Correlation>,
pub mil_view: Option<MilView>,
pub ontology: Option<Ontology>,
pub sensors: Option<Sensors>,
pub payloads: Option<Payloads>,
pub power_state: Option<PowerState>,
pub provenance: Option<Provenance>,
pub overrides: Option<Box<Overrides>>,
pub indicators: Option<Indicators>,
pub target_priority: Option<TargetPriority>,
pub signal: Option<Signal>,
pub transponder_codes: Option<TransponderCodes>,
pub data_classification: Option<Classification>,
pub task_catalog: Option<TaskCatalog>,
pub media: Option<Media>,
pub relationships: Option<Relationships>,
pub visual_details: Option<VisualDetails>,
pub dimensions: Option<Dimensions>,
pub route_details: Option<RouteDetails>,
pub schedules: Option<Schedules>,
pub health: Option<Health>,
pub group_details: Option<GroupDetails>,
pub supplies: Option<Supplies>,
pub orbit: Option<Orbit>,
}Expand description
The entity object represents a single known object within the Lattice operational environment. It contains all data associated with the entity, such as its name, ID, and other relevant components.
Fields§
§entity_id: Option<String>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.
description: Option<String>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.
is_live: Option<bool>Indicates the entity is active and should have a lifecycle state of CREATE or UPDATE. Set this field to true when publishing an entity.
created_time: Option<DateTime<Utc>>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.
expiry_time: Option<DateTime<Utc>>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.
no_expiry: Option<bool>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.
status: Option<Status>Human-readable descriptions of what the entity is currently doing.
location: Option<Location>Geospatial data related to the entity, including its position, kinematics, and orientation.
location_uncertainty: Option<LocationUncertainty>Indicates uncertainty of the entity’s position and kinematics.
geo_shape: Option<GeoShape>Geospatial representation of the entity, including entities that cover an area rather than a fixed point.
geo_details: Option<GeoDetails>Additional details on what the geospatial area or point represents, along with visual display details.
aliases: Option<Aliases>Entity name displayed in the Lattice UI side panel. Also includes identifiers that other systems can use to reference the same entity.
tracked: Option<Tracked>If this entity is tracked by another entity, this component contains data related to how it’s being tracked.
correlation: Option<Correlation>If this entity has been correlated or decorrelated to another one, this component contains information on the correlation or decorrelation.
mil_view: Option<MilView>View of the entity.
ontology: Option<Ontology>Ontology defines an entity’s categorization in Lattice, and improves data retrieval and integration. Builds a standardized representation of the entity.
sensors: Option<Sensors>Details an entity’s available sensors.
payloads: Option<Payloads>Details an entity’s available payloads.
power_state: Option<PowerState>Details the entity’s power source.
provenance: Option<Provenance>The primary data source provenance for this entity.
overrides: Option<Box<Overrides>>Provenance of override data.
indicators: Option<Indicators>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.
target_priority: Option<TargetPriority>The prioritization associated with an entity, such as if it’s a threat or a high-value target.
signal: Option<Signal>Describes an entity’s signal characteristics, primarily used when an entity is a signal of interest.
transponder_codes: Option<TransponderCodes>A message describing any transponder codes associated with Mode 1, 2, 3, 4, 5, S interrogations. These are related to ADS-B modes.
data_classification: Option<Classification>Describes an entity’s security classification levels at an overall classification level and on a per field level.
task_catalog: Option<TaskCatalog>A catalog of tasks that can be performed by an entity.
media: Option<Media>Media associated with an entity, such as videos, images, or thumbnails.
relationships: Option<Relationships>The relationships between this entity and other entities in the common operational picture (COP).
visual_details: Option<VisualDetails>Visual details associated with the display of an entity in the client.
dimensions: Option<Dimensions>Physical dimensions of the entity.
route_details: Option<RouteDetails>Additional information about an entity’s route.
schedules: Option<Schedules>Schedules associated with this entity.
health: Option<Health>Health metrics or connection status reported by the entity.
group_details: Option<GroupDetails>Details for the group associated with this entity.
supplies: Option<Supplies>Contains relevant supply information for the entity, such as fuel.
orbit: Option<Orbit>Orbit information for space objects.