--- title: "Get task" method: GET path: "/api/v1/tasks/{taskId}" tags: ["tasks"] --- # Get task `GET /api/v1/tasks/{taskId}` Retrieves a specific Task by its ID, with options to select a particular task version or view. This method returns detailed information about a task including its current status, specification, relations, and other metadata. The response includes the complete Task object with all associated fields. By default, the method returns the latest definition version of the task from the manager's perspective. ## Path parameters - `taskId` string, required ## Headers - `Authorization` string, required ## Response `200` Task retrieval was successful. - Task — A task represents a structured unit of work that can be assigned to an agent for execution. Tasks are the fundamental building blocks of work assignment in the Lattice. Each task has a unique identifier, a specification defining what needs to be done, status information tracking its progress, and various metadata facilitating its lifecycle management. Tasks can be related to each other, through parent-child relationships, assigned to specific agents, and tracked through a well-defined state machine from creation to completion. They support rich status reporting, including progress updates, error handling, and results. - `version` TaskVersion — Versioning information for a task. TaskVersion provides a unique identifier for each task, along with separate version counters for tracking changes to the task's definition and its status. This versioning system enables optimistic concurrency control, ensuring that updates from multiple sources don't conflict. - `taskId` string — The unique identifier for this task, used to distinguish it from all other tasks in the system. - `definitionVersion` integer — Counter that increments on changes to the task definition. Unset (0) initially, starts at 1 on creation, and increments with each update to task fields. - `statusVersion` integer — Counter that increments on changes to TaskStatus. Unset (0) initially, starts at 1 on creation, and increments with each status update. - `displayName` string — DEPRECATED: Human readable display name for this task, should be short (<100 chars). - `specification` GoogleProtobufAny — Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. - `@type` string — The type of the serialized message. - `createdBy` Principal — A Principal is an entity that has authority over this task. - `system` System — System Principal representing some autonomous system. - `serviceName` string — Name of the service associated with this System. - `entityId` string — The Entity ID of the System. - `managesOwnScheduling` boolean — Whether the System Principal (for example, an Asset) can own scheduling. This means we bypass manager-owned scheduling and defer to the system Principal to handle scheduling and give us status updates for the task. Regardless of the value defined by the client, the Task Manager will determine and set this value appropriately. - `user` User — A User Principal representing a human. - `userId` string — The User ID associated with this User. - `team` Team — Represents a team of agents - `entityId` string — Entity ID of the team - `members` Agent[] - `entityId` string — Entity ID of the agent. - `onBehalfOf` Principal — recursive - `lastUpdatedBy` Principal — A Principal is an entity that has authority over this task. - `system` System — System Principal representing some autonomous system. - `serviceName` string — Name of the service associated with this System. - `entityId` string — The Entity ID of the System. - `managesOwnScheduling` boolean — Whether the System Principal (for example, an Asset) can own scheduling. This means we bypass manager-owned scheduling and defer to the system Principal to handle scheduling and give us status updates for the task. Regardless of the value defined by the client, the Task Manager will determine and set this value appropriately. - `user` User — A User Principal representing a human. - `userId` string — The User ID associated with this User. - `team` Team — Represents a team of agents - `entityId` string — Entity ID of the team - `members` Agent[] - `entityId` string — Entity ID of the agent. - `onBehalfOf` Principal — recursive - `lastUpdateTime` string, date-time — Records the time of last update. - `status` TaskStatus — Comprehensive status information for a task at a given point in time. TaskStatus contains all status-related information for a task, including its current state, any error conditions, progress details, results, timing information, and resource allocations. This object evolves throughout a task's lifecycle, providing increasing detail as the task progresses from creation through execution to completion. - `status` 'STATUS_INVALID' | 'STATUS_CREATED' | 'STATUS_SCHEDULED_IN_MANAGER' | 'STATUS_SENT' | 'STATUS_MACHINE_RECEIPT' | 'STATUS_ACK' | 'STATUS_WILCO' | 'STATUS_EXECUTING' | 'STATUS_WAITING_FOR_UPDATE' | 'STATUS_DONE_OK' | 'STATUS_DONE_NOT_OK' | 'STATUS_REPLACED' | 'STATUS_CANCEL_REQUESTED' | 'STATUS_COMPLETE_REQUESTED' | 'STATUS_VERSION_REJECTED' — Status of the task. - `taskError` TaskError — Error information associated with a task. TaskError contains structured error details, including an error code, a human-readable message, and optional extended error information. This structure is used when a task encounters problems during its lifecycle. - `code` 'ERROR_CODE_INVALID' | 'ERROR_CODE_CANCELLED' | 'ERROR_CODE_REJECTED' | 'ERROR_CODE_TIMEOUT' | 'ERROR_CODE_FAILED' — Error code for task error. - `message` string — Descriptive human-readable string regarding this error. - `errorDetails` GoogleProtobufAny — Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. - `@type` string — The type of the serialized message. - `progress` GoogleProtobufAny — Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. - `@type` string — The type of the serialized message. - `result` GoogleProtobufAny — Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. - `@type` string — The type of the serialized message. - `startTime` string, date-time — Time the task began execution, may not be known even for executing Tasks. - `estimate` GoogleProtobufAny — Contains an arbitrary serialized message along with a @type that describes the type of the serialized message. - `@type` string — The type of the serialized message. - `allocation` Allocation — Allocation contains a list of agents allocated to a task. - `activeAgents` Agent[] — Agents actively being utilized in a task. - `entityId` string — Entity ID of the agent. - `scheduledTime` string, date-time — If the task has been scheduled to execute, what time it should execute at. - `relations` Relations — Describes the relationships associated with this task: the system assigned to execute the task, and the parent task, if one exists. - `assignee` Principal — A Principal is an entity that has authority over this task. - `system` System — System Principal representing some autonomous system. - `serviceName` string — Name of the service associated with this System. - `entityId` string — The Entity ID of the System. - `managesOwnScheduling` boolean — Whether the System Principal (for example, an Asset) can own scheduling. This means we bypass manager-owned scheduling and defer to the system Principal to handle scheduling and give us status updates for the task. Regardless of the value defined by the client, the Task Manager will determine and set this value appropriately. - `user` User — A User Principal representing a human. - `userId` string — The User ID associated with this User. - `team` Team — Represents a team of agents - `entityId` string — Entity ID of the team - `members` Agent[] - `entityId` string — Entity ID of the agent. - `onBehalfOf` Principal — recursive - `parentTaskId` string — Identifies the parent task if the task is a sub-task. - `description` string — Longer, free form human readable description of this task - `isExecutedElsewhere` boolean — If set, execution of this task is managed elsewhere, not by Task Manager. In other words, task manager will not attempt to update the assigned agent with execution instructions. - `createTime` string, date-time — Time of task creation. - `replication` Replication — Any metadata associated with the replication of a task. - `staleTime` string, date-time — The time by which this task should be assumed to be stale. - `initialEntities` TaskEntity[] — If populated, indicates an initial set of entities that can be used to execute an entity aware task For example, an entity Objective, an entity Keep In Zone, etc. These will not be updated during execution. If a taskable agent needs continuous updates on the entities from the COP, can call entity-manager, or use an AlternateId escape hatch. - `entity` Entity — 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. - `entityId` string — A Globally Unique Identifier (GUID) for your entity. This is a required field. - `description` 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. - `isLive` boolean — Indicates the entity is active and should have a lifecycle state of CREATE or UPDATE. Set this field to true when publishing an entity. - `createdTime` string, 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. - `expiryTime` string, 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. - `noExpiry` boolean — 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` Status — Contains status of entities. - `platformActivity` string — A string that describes the activity that the entity is performing. Examples include "RECONNAISSANCE", "INTERDICTION", "RETURN TO BASE (RTB)", "PREPARING FOR LAUNCH". - `role` string — A human-readable string that describes the role the entity is currently performing. E.g. "Team Member", "Commander". - `location` Location — Available for Entities that have a single or primary Location. - `position` Position — WGS84 position. Position includes four altitude references. The data model does not currently support Mean Sea Level (MSL) references, such as the Earth Gravitational Model 1996 (EGM-96) and the Earth Gravitational Model 2008 (EGM-08). If the only altitude reference available to your integration is MSL, convert it to Height Above Ellipsoid (HAE) and populate the altitude_hae_meters field. - `latitudeDegrees` number, double — WGS84 geodetic latitude in decimal degrees. - `longitudeDegrees` number, double — WGS84 longitude in decimal degrees. - `altitudeHaeMeters` number, double — altitude as height above ellipsoid (WGS84) in meters. DoubleValue wrapper is used to distinguish optional from default 0. - `altitudeAglMeters` number, double — Altitude as AGL (Above Ground Level) if the upstream data source has this value set. This value represents the entity's height above the terrain. This is typically measured with a radar altimeter or by using a terrain tile set lookup. If the value is not set from the upstream, this value is not set. - `altitudeAsfMeters` number, double — Altitude as ASF (Above Sea Floor) if the upstream data source has this value set. If the value is not set from the upstream, this value is not set. - `pressureDepthMeters` number, double — The depth of the entity from the surface of the water through sensor measurements based on differential pressure between the interior and exterior of the vessel. If the value is not set from the upstream, this value is not set. - `velocityEnu` ENU - `e` number, double - `n` number, double - `u` number, double - `speedMps` number, double — Speed is the magnitude of velocity_enu vector [sqrt(e^2 + n^2 + u^2)] when present, measured in m/s. - `acceleration` ENU - `e` number, double - `n` number, double - `u` number, double - `attitudeEnu` Quaternion - `x` number, double — x, y, z are vector portion, w is scalar - `y` number, double - `z` number, double - `w` number, double - `locationUncertainty` LocationUncertainty — Uncertainty of entity position and velocity, if available. - `positionEnuCov` EntityManagerTMat3 — Symmetric 3d matrix only representing the upper right triangle. - `mxx` string - `mxy` string - `mxz` string - `myy` string - `myz` string - `mzz` string - `velocityEnuCov` EntityManagerTMat3 — Symmetric 3d matrix only representing the upper right triangle. - `mxx` string - `mxy` string - `mxz` string - `myy` string - `myz` string - `mzz` string - `positionErrorEllipse` ErrorEllipse — Indicates ellipse characteristics and probability that an entity lies within the defined ellipse. - `probability` number, double — Defines the probability in percentage that an entity lies within the given ellipse: 0-1. - `semiMajorAxisM` number, double — Defines the distance from the center point of the ellipse to the furthest distance on the perimeter in meters. - `semiMinorAxisM` number, double — Defines the distance from the center point of the ellipse to the shortest distance on the perimeter in meters. - `orientationD` number, double — The orientation of the semi-major relative to true north in degrees from clockwise: 0-180 due to symmetry across the semi-minor axis. - `kinematics` Kinematics — Kinematics of the entity, including its location, location uncertainty, motion, attitude, and the time the kinematics were measured. Only one of the fields on this message is expected to be set when publishing an entity. - `kinematicsGeodetic` KinematicsGeodetic - `location` LocationGeodetic — Geodetic location measurement in reference to the WGS84 ellipsoid. This also optionally provides other altitude reference frames. - `latitudeDegrees` number, double — WGS84 latitude in decimal degrees. - `longitudeDegrees` number, double — WGS84 longitude in decimal degrees. - `universalAltitudeHae` AltitudeAboveWGS84Ellipsoid — Altitude above the WGS84 defined ellipsoid. Often measured with a GNSS sensor. - … - `additionalAltitudes` Altitude[] — This allows for multiple additional altitudes to be conveyed. e.g. Barometric Pressure and Radar Altimeter readings for an aircraft - … - `locationUncertaintyEnu` TMat3 — A symmetric 3D matrix only representing the upper right triangle, useful for covariance matrices. - `mxx` number, double - `mxy` number, double - `mxz` number, double - `myy` number, double - `myz` number, double - `mzz` number, double - `velocityEnuMPerS` Vec3 - `x` number, double - `y` number, double - `z` number, double - `velocityUncertaintyEnu` TMat3 — A symmetric 3D matrix only representing the upper right triangle, useful for covariance matrices. - `mxx` number, double - `mxy` number, double - `mxz` number, double - `myy` number, double - `myz` number, double - `mzz` number, double - `accelerationMPerS2` Vec3 - `x` number, double - `y` number, double - `z` number, double - `attitudeEnu` Quaternion - `x` number, double — x, y, z are vector portion, w is scalar - `y` number, double - `z` number, double - `w` number, double - `measurementTime` string, date-time — The time when these kinematics were measured by the sensor. For tracks, this represents when the sensor made the observation that produced these kinematics. For asset pose data, this represents the system time when the pose was captured. - `kinematicsGeocentric` KinematicsGeocentric - `location` LocationGeocentricECEF — Location measurement in reference to the center of the earth using the ECEF coordinate system. This is in the WGS84 coordinate frame. - `xMeters` number, double — The plane of the equator, passing through extending from 90°W longitude (negative) to 90°E longitude (positive). - `yMeters` number, double — The plane of the equator, passing through the origin and extending from 180° longitude (negative) to the prime meridian. - `zMeters` number, double — The line between the North and South Poles, with positive values increasing northward. - `locationUncertaintyEcef` TMat3 — A symmetric 3D matrix only representing the upper right triangle, useful for covariance matrices. - `mxx` number, double - `mxy` number, double - `mxz` number, double - `myy` number, double - `myz` number, double - `mzz` number, double - `velocityEcefMPerS` Vec3 - `x` number, double - `y` number, double - `z` number, double - `velocityUncertaintyEcef` TMat3 — A symmetric 3D matrix only representing the upper right triangle, useful for covariance matrices. - `mxx` number, double - `mxy` number, double - `mxz` number, double - `myy` number, double - `myz` number, double - `mzz` number, double - `accelerationMPerS2` Vec3 - `x` number, double - `y` number, double - `z` number, double - `attitudeEcef` Quaternion - `x` number, double — x, y, z are vector portion, w is scalar - `y` number, double - `z` number, double - `w` number, double - `measurementTime` string, date-time — The time when these kinematics were measured by the sensor. For tracks, this represents when the sensor made the observation that produced these kinematics. For asset pose data, this represents the system time when the pose was captured. - `geoShape` GeoShape — A component that describes the shape of a geo-entity. - `point` GeoPoint — A point shaped geo-entity. See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 - `position` Position — WGS84 position. Position includes four altitude references. The data model does not currently support Mean Sea Level (MSL) references, such as the Earth Gravitational Model 1996 (EGM-96) and the Earth Gravitational Model 2008 (EGM-08). If the only altitude reference available to your integration is MSL, convert it to Height Above Ellipsoid (HAE) and populate the altitude_hae_meters field. - `latitudeDegrees` number, double — WGS84 geodetic latitude in decimal degrees. - `longitudeDegrees` number, double — WGS84 longitude in decimal degrees. - `altitudeHaeMeters` number, double — altitude as height above ellipsoid (WGS84) in meters. DoubleValue wrapper is used to distinguish optional from default 0. - `altitudeAglMeters` number, double — Altitude as AGL (Above Ground Level) if the upstream data source has this value set. This value represents the entity's height above the terrain. This is typically measured with a radar altimeter or by using a terrain tile set lookup. If the value is not set from the upstream, this value is not set. - `altitudeAsfMeters` number, double — Altitude as ASF (Above Sea Floor) if the upstream data source has this value set. If the value is not set from the upstream, this value is not set. - `pressureDepthMeters` number, double — The depth of the entity from the surface of the water through sensor measurements based on differential pressure between the interior and exterior of the vessel. If the value is not set from the upstream, this value is not set. - `line` GeoLine — A line shaped geo-entity. See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4 - `positions` Position[] - `latitudeDegrees` number, double — WGS84 geodetic latitude in decimal degrees. - `longitudeDegrees` number, double — WGS84 longitude in decimal degrees. - `altitudeHaeMeters` number, double — altitude as height above ellipsoid (WGS84) in meters. DoubleValue wrapper is used to distinguish optional from default 0. - `altitudeAglMeters` number, double — Altitude as AGL (Above Ground Level) if the upstream data source has this value set. This value represents the entity's height above the terrain. This is typically measured with a radar altimeter or by using a terrain tile set lookup. If the value is not set from the upstream, this value is not set. - `altitudeAsfMeters` number, double — Altitude as ASF (Above Sea Floor) if the upstream data source has this value set. If the value is not set from the upstream, this value is not set. - `pressureDepthMeters` number, double — The depth of the entity from the surface of the water through sensor measurements based on differential pressure between the interior and exterior of the vessel. If the value is not set from the upstream, this value is not set. - `polygon` GeoPolygon — A polygon shaped geo-entity. See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6, only canonical representations accepted - `rings` LinearRing[] — An array of LinearRings where the first item is the exterior ring and subsequent items are interior rings. - `positions` GeoPolygonPosition[] - … - `isRectangle` boolean — An extension hint that this polygon is a rectangle. When true this implies several things: * exactly 1 linear ring with 5 points (starting corner, 3 other corners and start again) * each point has the same altitude corresponding with the plane of the rectangle * each point has the same height (either all present and equal, or all not present) - `ellipse` GeoEllipse — An ellipse shaped geo-entity. For a circle, the major and minor axis would be the same values. This shape is NOT Geo-JSON compatible. - `semiMajorAxisM` number, double — Defines the distance from the center point of the ellipse to the furthest distance on the perimeter in meters. - `semiMinorAxisM` number, double — Defines the distance from the center point of the ellipse to the shortest distance on the perimeter in meters. - `orientationD` number, double — The orientation of the semi-major relative to true north in degrees from clockwise: 0-180 due to symmetry across the semi-minor axis. - `heightM` number, double — Optional height above entity position to extrude in meters. A non-zero value creates an elliptic cylinder - `ellipsoid` GeoEllipsoid — An ellipsoid shaped geo-entity. Principal axis lengths are defined in entity body space This shape is NOT Geo-JSON compatible. - `forwardAxisM` number, double — Defines the distance from the center point to the surface along the forward axis - `sideAxisM` number, double — Defines the distance from the center point to the surface along the side axis - `upAxisM` number, double — Defines the distance from the center point to the surface along the up axis - `geoDetails` GeoDetails — A component that describes a geo-entity. - `type` 'GEO_TYPE_INVALID' | 'GEO_TYPE_GENERAL' | 'GEO_TYPE_HAZARD' | 'GEO_TYPE_EMERGENCY' | 'GEO_TYPE_ENGAGEMENT_ZONE' | 'GEO_TYPE_CONTROL_AREA' | 'GEO_TYPE_BULLSEYE' | 'GEO_TYPE_ACM' - `controlArea` ControlAreaDetails — Determines the type of control area being represented by the geo-entity, in which an asset can, or cannot, operate. - `type` 'CONTROL_AREA_TYPE_INVALID' | 'CONTROL_AREA_TYPE_KEEP_IN_ZONE' | 'CONTROL_AREA_TYPE_KEEP_OUT_ZONE' | 'CONTROL_AREA_TYPE_DITCH_ZONE' | 'CONTROL_AREA_TYPE_LOITER_ZONE' - `acm` ACMDetails - `acmType` 'ACM_DETAIL_TYPE_INVALID' | 'ACM_DETAIL_TYPE_LANDING_ZONE' - `acmDescription` string — Used for loosely typed associations, such as assignment to a specific fires unit. Limit to 150 characters. - `visualDetails` GeoVisualDetails — Details specific to displaying a geo-entity - `fillColor` Color - `red` string — The amount of red in the color as a value in the interval [0, 255]. - `green` string — The amount of green in the color as a value in the interval [0, 255]. - `blue` string — The amount of blue in the color as a value in the interval [0, 255]. - `alpha` string — The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). - `lineColor` Color - `red` string — The amount of red in the color as a value in the interval [0, 255]. - `green` string — The amount of green in the color as a value in the interval [0, 255]. - `blue` string — The amount of blue in the color as a value in the interval [0, 255]. - `alpha` string — The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). - `aliases` Aliases — Available for any Entities with alternate ids in other systems. - `alternateIds` AlternateId[] - `id` string - `type` 'ALT_ID_TYPE_INVALID' | 'ALT_ID_TYPE_TRACK_ID_2' | 'ALT_ID_TYPE_TRACK_ID_1' | 'ALT_ID_TYPE_SPI_ID' | 'ALT_ID_TYPE_NITF_FILE_TITLE' | 'ALT_ID_TYPE_TRACK_REPO_ALERT_ID' | 'ALT_ID_TYPE_ASSET_ID' | 'ALT_ID_TYPE_LINK16_TRACK_NUMBER' | 'ALT_ID_TYPE_LINK16_JU' | 'ALT_ID_TYPE_NCCT_MESSAGE_ID' | 'ALT_ID_TYPE_CALLSIGN' | 'ALT_ID_TYPE_MMSI_ID' | 'ALT_ID_TYPE_VMF_URN' | 'ALT_ID_TYPE_IMO_ID' | 'ALT_ID_TYPE_VMF_TARGET_NUMBER' | 'ALT_ID_TYPE_SERIAL_NUMBER' | 'ALT_ID_TYPE_REGISTRATION_ID' | 'ALT_ID_TYPE_IBS_GID' | 'ALT_ID_TYPE_DODAAC' | 'ALT_ID_TYPE_UIC' | 'ALT_ID_TYPE_NORAD_CAT_ID' | 'ALT_ID_TYPE_UNOOSA_NAME' | 'ALT_ID_TYPE_UNOOSA_ID' - `name` string — The best available version of the entity's display name. - `tracked` Tracked — Available for Entities that are tracked. - `trackQualityWrapper` integer — Quality score, 0-15, nil if none - `sensorHits` integer — Sensor hits aggregation on the tracked entity. - `numberOfObjects` UInt32Range - `lowerBound` integer - `upperBound` integer - `radarCrossSection` number, double — The radar cross section (RCS) is a measure of how detectable an object is by radar. A large RCS indicates an object is more easily detected. The unit is “decibels per square meter,” or dBsm - `lastMeasurementTime` string, date-time — Timestamp of the latest tracking measurement for this entity. - `lineOfBearing` LineOfBearing — A line of bearing of a signal. - `angleOfArrival` AngleOfArrival — The direction from which the signal is received - `relativePose` Pose - … - `bearingElevationCovarianceRad2` TMat2 — symmetric 2d matrix only representing the upper right triangle, useful for covariance matrices - … - `rangeEstimateM` Measurement — A component that describes some measured value with error. - `value` number, double — The value of the measurement. - `sigma` number, double — Estimated one standard deviation in same unit as the value. - `maxRangeM` Measurement — A component that describes some measured value with error. - `value` number, double — The value of the measurement. - `sigma` number, double — Estimated one standard deviation in same unit as the value. - `correlation` Correlation — Available for Entities that are a correlated (N to 1) set of entities. This will be present on each entity in the set. - `primary` PrimaryCorrelation - `secondaryEntityIds` string[] — The secondary entity IDs part of this correlation. - `secondary` SecondaryCorrelation - `primaryEntityId` string — The primary of this correlation. - `metadata` CorrelationMetadata - `provenance` Provenance — Data provenance. - … - `replicationMode` 'CORRELATION_REPLICATION_MODE_INVALID' | 'CORRELATION_REPLICATION_MODE_LOCAL' | 'CORRELATION_REPLICATION_MODE_GLOBAL' — Indicates how the correlation will be distributed. Because a correlation is composed of multiple secondaries, each of which may have been correlated with different replication modes, the distribution of the correlation is composed of distributions of the individual entities within the correlation set. For example, if there are two secondary entities A and B correlated against a primary C, with A having been correlated globally and B having been correlated locally, then the correlation set that is distributed globally than what is known locally in the node. - `type` 'CORRELATION_TYPE_INVALID' | 'CORRELATION_TYPE_MANUAL' | 'CORRELATION_TYPE_AUTOMATED' — What type of (de)correlation was this entity added with. - `membership` CorrelationMembership - `correlationSetId` string — The ID of the correlation set this entity belongs to. - `primary` PrimaryMembership - `nonPrimary` NonPrimaryMembership - `metadata` CorrelationMetadata - `provenance` Provenance — Data provenance. - … - `replicationMode` 'CORRELATION_REPLICATION_MODE_INVALID' | 'CORRELATION_REPLICATION_MODE_LOCAL' | 'CORRELATION_REPLICATION_MODE_GLOBAL' — Indicates how the correlation will be distributed. Because a correlation is composed of multiple secondaries, each of which may have been correlated with different replication modes, the distribution of the correlation is composed of distributions of the individual entities within the correlation set. For example, if there are two secondary entities A and B correlated against a primary C, with A having been correlated globally and B having been correlated locally, then the correlation set that is distributed globally than what is known locally in the node. - `type` 'CORRELATION_TYPE_INVALID' | 'CORRELATION_TYPE_MANUAL' | 'CORRELATION_TYPE_AUTOMATED' — What type of (de)correlation was this entity added with. - `decorrelation` Decorrelation - `all` DecorrelatedAll - `metadata` CorrelationMetadata - … - `decorrelatedEntities` DecorrelatedSingle[] — A list of decorrelated entities that have been explicitly decorrelated against this entity which prevents lower precedence correlations from overriding it in the future. For example, if an operator in the UI decorrelated tracks A and B, any automated correlators would be unable to correlate them since manual decorrelations have higher precedence than automatic ones. Precedence is determined by both correlation type and replication mode. - `entityId` string — The entity that was decorrelated against. - `metadata` CorrelationMetadata - … - `milView` MilView — Provides the disposition, environment, and nationality of an Entity. - `disposition` 'DISPOSITION_UNKNOWN' | 'DISPOSITION_FRIENDLY' | 'DISPOSITION_HOSTILE' | 'DISPOSITION_SUSPICIOUS' | 'DISPOSITION_ASSUMED_FRIENDLY' | 'DISPOSITION_NEUTRAL' | 'DISPOSITION_PENDING' - `environment` 'ENVIRONMENT_UNKNOWN' | 'ENVIRONMENT_AIR' | 'ENVIRONMENT_SURFACE' | 'ENVIRONMENT_SUB_SURFACE' | 'ENVIRONMENT_LAND' | 'ENVIRONMENT_SPACE' - `nationality` 'NATIONALITY_INVALID' | 'NATIONALITY_ALBANIA' | 'NATIONALITY_ALGERIA' | 'NATIONALITY_ARGENTINA' | 'NATIONALITY_ARMENIA' | 'NATIONALITY_AUSTRALIA' | 'NATIONALITY_AUSTRIA' | 'NATIONALITY_AZERBAIJAN' | 'NATIONALITY_BELARUS' | 'NATIONALITY_BELGIUM' | 'NATIONALITY_BOLIVIA' | 'NATIONALITY_BOSNIA_AND_HERZEGOVINA' | 'NATIONALITY_BRAZIL' | 'NATIONALITY_BULGARIA' | 'NATIONALITY_CAMBODIA' | 'NATIONALITY_CANADA' | 'NATIONALITY_CHILE' | 'NATIONALITY_CHINA' | 'NATIONALITY_COLOMBIA' | 'NATIONALITY_CROATIA' | 'NATIONALITY_CUBA' | 'NATIONALITY_CYPRUS' | 'NATIONALITY_CZECH_REPUBLIC' | 'NATIONALITY_DEMOCRATIC_PEOPLES_REPUBLIC_OF_KOREA' | 'NATIONALITY_DENMARK' | 'NATIONALITY_DOMINICAN_REPUBLIC' | 'NATIONALITY_ECUADOR' | 'NATIONALITY_EGYPT' | 'NATIONALITY_ESTONIA' | 'NATIONALITY_ETHIOPIA' | 'NATIONALITY_FINLAND' | 'NATIONALITY_FRANCE' | 'NATIONALITY_GEORGIA' | 'NATIONALITY_GERMANY' | 'NATIONALITY_GREECE' | 'NATIONALITY_GUATEMALA' | 'NATIONALITY_GUINEA' | 'NATIONALITY_HUNGARY' | 'NATIONALITY_ICELAND' | 'NATIONALITY_INDIA' | 'NATIONALITY_INDONESIA' | 'NATIONALITY_INTERNATIONAL_RED_CROSS' | 'NATIONALITY_IRAQ' | 'NATIONALITY_IRELAND' | 'NATIONALITY_ISLAMIC_REPUBLIC_OF_IRAN' | 'NATIONALITY_ISRAEL' | 'NATIONALITY_ITALY' | 'NATIONALITY_JAMAICA' | 'NATIONALITY_JAPAN' | 'NATIONALITY_JORDAN' | 'NATIONALITY_KAZAKHSTAN' | 'NATIONALITY_KUWAIT' | 'NATIONALITY_KYRGHYZ_REPUBLIC' | 'NATIONALITY_LAO_PEOPLES_DEMOCRATIC_REPUBLIC' | 'NATIONALITY_LATVIA' | 'NATIONALITY_LEBANON' | 'NATIONALITY_LIBERIA' | 'NATIONALITY_LITHUANIA' | 'NATIONALITY_LUXEMBOURG' | 'NATIONALITY_MADAGASCAR' | 'NATIONALITY_MALAYSIA' | 'NATIONALITY_MALTA' | 'NATIONALITY_MEXICO' | 'NATIONALITY_MOLDOVA' | 'NATIONALITY_MONTENEGRO' | 'NATIONALITY_MOROCCO' | 'NATIONALITY_MYANMAR' | 'NATIONALITY_NATO' | 'NATIONALITY_NETHERLANDS' | 'NATIONALITY_NEW_ZEALAND' | 'NATIONALITY_NICARAGUA' | 'NATIONALITY_NIGERIA' | 'NATIONALITY_NORWAY' | 'NATIONALITY_PAKISTAN' | 'NATIONALITY_PANAMA' | 'NATIONALITY_PARAGUAY' | 'NATIONALITY_PERU' | 'NATIONALITY_PHILIPPINES' | 'NATIONALITY_POLAND' | 'NATIONALITY_PORTUGAL' | 'NATIONALITY_REPUBLIC_OF_KOREA' | 'NATIONALITY_ROMANIA' | 'NATIONALITY_RUSSIA' | 'NATIONALITY_SAUDI_ARABIA' | 'NATIONALITY_SENEGAL' | 'NATIONALITY_SERBIA' | 'NATIONALITY_SINGAPORE' | 'NATIONALITY_SLOVAKIA' | 'NATIONALITY_SLOVENIA' | 'NATIONALITY_SOUTH_AFRICA' | 'NATIONALITY_SPAIN' | 'NATIONALITY_SUDAN' | 'NATIONALITY_SWEDEN' | 'NATIONALITY_SWITZERLAND' | 'NATIONALITY_SYRIAN_ARAB_REPUBLIC' | 'NATIONALITY_TAIWAN' | 'NATIONALITY_TAJIKISTAN' | 'NATIONALITY_THAILAND' | 'NATIONALITY_THE_FORMER_YUGOSLAV_REPUBLIC_OF_MACEDONIA' | 'NATIONALITY_TUNISIA' | 'NATIONALITY_TURKEY' | 'NATIONALITY_TURKMENISTAN' | 'NATIONALITY_UGANDA' | 'NATIONALITY_UKRAINE' | 'NATIONALITY_UNITED_KINGDOM' | 'NATIONALITY_UNITED_NATIONS' | 'NATIONALITY_UNITED_REPUBLIC_OF_TANZANIA' | 'NATIONALITY_UNITED_STATES_OF_AMERICA' | 'NATIONALITY_URUGUAY' | 'NATIONALITY_UZBEKISTAN' | 'NATIONALITY_VENEZUELA' | 'NATIONALITY_VIETNAM' | 'NATIONALITY_YEMEN' | 'NATIONALITY_ZIMBABWE' - `ontology` Ontology — Ontology of the entity. - `platformType` string — A string that describes the entity's high-level type with natural language. - `specificType` string — A string that describes the entity's exact model or type. - `template` 'TEMPLATE_INVALID' | 'TEMPLATE_TRACK' | 'TEMPLATE_SENSOR_POINT_OF_INTEREST' | 'TEMPLATE_ASSET' | 'TEMPLATE_GEO' | 'TEMPLATE_SIGNAL_OF_INTEREST' — The template used when creating this entity. Specifies minimum required components. - `sensors` Sensors — List of sensors available for an entity. - `sensors` Sensor[] - `sensorId` string — This generally is used to indicate a specific type at a more detailed granularity. E.g. COMInt or LWIR - `operationalState` 'OPERATIONAL_STATE_INVALID' | 'OPERATIONAL_STATE_OFF' | 'OPERATIONAL_STATE_NON_OPERATIONAL' | 'OPERATIONAL_STATE_DEGRADED' | 'OPERATIONAL_STATE_OPERATIONAL' | 'OPERATIONAL_STATE_DENIED' - `sensorType` 'SENSOR_TYPE_INVALID' | 'SENSOR_TYPE_RADAR' | 'SENSOR_TYPE_CAMERA' | 'SENSOR_TYPE_TRANSPONDER' | 'SENSOR_TYPE_RF' | 'SENSOR_TYPE_GPS' | 'SENSOR_TYPE_PTU_POS' | 'SENSOR_TYPE_PERIMETER' | 'SENSOR_TYPE_SONAR' — The type of sensor - `sensorDescription` string — A human readable description of the sensor - `rfConfiguraton` RFConfiguration — Represents RF configurations supported on this sensor. - `frequencyRangeHz` FrequencyRange[] — Frequency ranges that are available for this sensor. - … - `bandwidthRangeHz` BandwidthRange[] — Bandwidth ranges that are available for this sensor. - … - `lastDetectionTimestamp` string, date-time — Time of the latest detection from the sensor - `fieldsOfView` FieldOfView[] — Multiple fields of view for a single sensor component - `fovId` integer — The Id for one instance of a FieldOfView, persisted across multiple updates to provide continuity during smoothing. This is relevant for sensors where the dwell schedule is on the order of milliseconds, making multiple FOVs a requirement for proper display of search beams. - `mountId` string — The Id of the mount the sensor is on. - `projectedFrustum` ProjectedFrustum — Represents a frustum in which which all four corner points project onto the ground. All points in this message are optional, if the projection to the ground fails then they will not be populated. - … - `projectedCenterRay` Position — WGS84 position. Position includes four altitude references. The data model does not currently support Mean Sea Level (MSL) references, such as the Earth Gravitational Model 1996 (EGM-96) and the Earth Gravitational Model 2008 (EGM-08). If the only altitude reference available to your integration is MSL, convert it to Height Above Ellipsoid (HAE) and populate the altitude_hae_meters field. - … - `centerRayPose` EntityManagerPose - … - `horizontalFov` string — Horizontal field of view in radians. - `verticalFov` string — Vertical field of view in radians. - `range` string — Sensor range in meters. - `mode` 'SENSOR_MODE_INVALID' | 'SENSOR_MODE_SEARCH' | 'SENSOR_MODE_TRACK' | 'SENSOR_MODE_WEAPON_SUPPORT' | 'SENSOR_MODE_AUTO' | 'SENSOR_MODE_MUTE' — The mode that this sensor is currently in, used to display for context in the UI. Some sensors can emit multiple sensor field of views with different modes, for example a radar can simultaneously search broadly and perform tighter bounded tracking. - `payloads` Payloads — List of payloads available for an entity. - `payloadConfigurations` Payload[] - `config` PayloadConfiguration - `capabilityId` string — Identifying ID for the capability. This ID may be used multiple times to represent payloads that are the same capability but have different operational states - `quantity` integer — The number of payloads currently available in the configuration. - `effectiveEnvironment` PayloadConfigurationEffectiveEnvironmentItems[] — The target environments the configuration is effective against. - `payloadOperationalState` 'PAYLOAD_OPERATIONAL_STATE_INVALID' | 'PAYLOAD_OPERATIONAL_STATE_OFF' | 'PAYLOAD_OPERATIONAL_STATE_NON_OPERATIONAL' | 'PAYLOAD_OPERATIONAL_STATE_DEGRADED' | 'PAYLOAD_OPERATIONAL_STATE_OPERATIONAL' | 'PAYLOAD_OPERATIONAL_STATE_OUT_OF_SERVICE' | 'PAYLOAD_OPERATIONAL_STATE_UNKNOWN' — The operational state of this payload. - `payloadDescription` string — A human readable description of the payload - `powerState` PowerState — Represents the state of power sources connected to this entity. - `sourceIdToState` object — This is a map where the key is a unique id of the power source and the value is additional information about the power source. - `provenance` Provenance — Data provenance. - `integrationName` string — Name of the integration that produced this entity - `dataType` string — Source data type of this entity. Examples: ADSB, Link16, etc. - `sourceId` string — An ID that allows an element from a source to be uniquely identified - `sourceUpdateTime` string, date-time — The time, according to the source system, that the data in the entity was last modified. Generally, this should be the time that the source-reported time of validity of the data in the entity. This field must be updated with every change to the entity or else Entity Manager will discard the update. - `sourceDescription` string — Description of the modification source. In the case of a user this is the email address. - `overrides` Overrides — Metadata about entity overrides present. - `override` Override[] - `requestId` string — override request id for an override request - `fieldPath` string — proto field path which is the string representation of a field. example: correlated.primary_entity_id would be primary_entity_id in correlated component - `maskedFieldValue` Entity — recursive - `status` 'OVERRIDE_STATUS_INVALID' | 'OVERRIDE_STATUS_APPLIED' | 'OVERRIDE_STATUS_PENDING' | 'OVERRIDE_STATUS_TIMEOUT' | 'OVERRIDE_STATUS_REJECTED' | 'OVERRIDE_STATUS_DELETION_PENDING' — status of the override - `provenance` Provenance — Data provenance. - `integrationName` string — Name of the integration that produced this entity - `dataType` string — Source data type of this entity. Examples: ADSB, Link16, etc. - `sourceId` string — An ID that allows an element from a source to be uniquely identified - `sourceUpdateTime` string, date-time — The time, according to the source system, that the data in the entity was last modified. Generally, this should be the time that the source-reported time of validity of the data in the entity. This field must be updated with every change to the entity or else Entity Manager will discard the update. - `sourceDescription` string — Description of the modification source. In the case of a user this is the email address. - `type` 'OVERRIDE_TYPE_INVALID' | 'OVERRIDE_TYPE_LIVE' | 'OVERRIDE_TYPE_POST_EXPIRY' — The type of the override, defined by the stage of the entity lifecycle that the entity was in when the override was requested. - `requestTimestamp` string, date-time — Timestamp of the override request. The timestamp is generated by the Entity Manager instance that receives the request. - `indicators` Indicators — Indicators to describe entity to consumers. - `simulated` boolean - `exercise` boolean - `emergency` boolean - `c2` boolean - `egressable` boolean — Indicates the Entity should be egressed to external sources. Integrations choose how the egressing happens (e.g. if an Entity needs fuzzing). - `starred` boolean — A signal of arbitrary importance such that the entity should be globally marked for all users - `targetPriority` TargetPriority — The target prioritization associated with an entity. - `highValueTarget` HighValueTarget — Describes whether something is a high value target or not. - `isHighValueTarget` boolean — Indicates whether the target matches any description from a high value target list. - `targetPriority` integer — The priority associated with the target. If the target's description appears on multiple high value target lists, the priority will be a reflection of the highest priority of all of those list's target description. A lower value indicates the target is of a higher priority, with 1 being the highest possible priority. A value of 0 indicates there is no priority associated with this target. - `targetMatches` HighValueTargetMatch[] — All of the high value target descriptions that the target matches against. - `highValueTargetListId` string — The ID of the high value target list that matches the target description. - `highValueTargetDescriptionId` string — The ID of the specific high value target description within a high value target list that was matched against. The ID is considered to be a globally unique identifier across all high value target IDs. - `isHighPayoffTarget` boolean — Indicates whether the target is a 'High Payoff Target'. Targets can be one or both of high value and high payoff. - `threat` Threat — Describes whether an entity is a threat or not. - `isThreat` boolean — Indicates that the entity has been determined to be a threat. - `signal` Signal — A component that describes an entity's signal characteristics. - `frequencyCenter` Frequency — A component for describing frequency. - `frequencyHz` Measurement — A component that describes some measured value with error. - `value` number, double — The value of the measurement. - `sigma` number, double — Estimated one standard deviation in same unit as the value. - `frequencyRange` FrequencyRange — A component to represent a frequency range. - `minimumFrequencyHz` Frequency — A component for describing frequency. - `frequencyHz` Measurement — A component that describes some measured value with error. - … - `maximumFrequencyHz` Frequency — A component for describing frequency. - `frequencyHz` Measurement — A component that describes some measured value with error. - … - `bandwidthHz` number, double — Indicates the bandwidth of a signal (Hz). - `signalToNoiseRatio` number, double — Indicates the signal to noise (SNR) of this signal. - `lineOfBearing` LineOfBearing — A line of bearing of a signal. - `angleOfArrival` AngleOfArrival — The direction from which the signal is received - `relativePose` Pose - … - `bearingElevationCovarianceRad2` TMat2 — symmetric 2d matrix only representing the upper right triangle, useful for covariance matrices - … - `rangeEstimateM` Measurement — A component that describes some measured value with error. - `value` number, double — The value of the measurement. - `sigma` number, double — Estimated one standard deviation in same unit as the value. - `maxRangeM` Measurement — A component that describes some measured value with error. - `value` number, double — The value of the measurement. - `sigma` number, double — Estimated one standard deviation in same unit as the value. - `fixed` Fixed — A fix of a signal. No extra fields but it is expected that location should be populated when using this report. - `emitterNotations` EmitterNotation[] — Emitter notations associated with this entity. - `emitterNotation` string - `confidence` number, double — confidence as a percentage that the emitter notation in this component is accurate - `pulseWidthS` number, double — length in time of a single pulse - `pulseRepetitionInterval` PulseRepetitionInterval — A component that describe the length in time between two pulses - `pulseRepetitionIntervalS` Measurement — A component that describes some measured value with error. - `value` number, double — The value of the measurement. - `sigma` number, double — Estimated one standard deviation in same unit as the value. - `scanCharacteristics` ScanCharacteristics — A component that describes the scanning characteristics of a signal - `scanType` 'SCAN_TYPE_INVALID' | 'SCAN_TYPE_CIRCULAR' | 'SCAN_TYPE_BIDIRECTIONAL_HORIZONTAL_SECTOR' | 'SCAN_TYPE_BIDIRECTIONAL_VERTICAL_SECTOR' | 'SCAN_TYPE_NON_SCANNING' | 'SCAN_TYPE_IRREGULAR' | 'SCAN_TYPE_CONICAL' | 'SCAN_TYPE_LOBE_SWITCHING' | 'SCAN_TYPE_RASTER' | 'SCAN_TYPE_CIRCULAR_VERTICAL_SECTOR' | 'SCAN_TYPE_CIRCULAR_CONICAL' | 'SCAN_TYPE_SECTOR_CONICAL' | 'SCAN_TYPE_AGILE_BEAM' | 'SCAN_TYPE_UNIDIRECTIONAL_VERTICAL_SECTOR' | 'SCAN_TYPE_UNIDIRECTIONAL_HORIZONTAL_SECTOR' | 'SCAN_TYPE_UNIDIRECTIONAL_SECTOR' | 'SCAN_TYPE_BIDIRECTIONAL_SECTOR' - `scanPeriodS` number, double - `transponderCodes` TransponderCodes — A message describing any transponder codes associated with Mode 1, 2, 3, 4, 5, S, C interrogations. - `mode1` integer — The mode 1 code assigned to military assets. - `mode2` integer — The Mode 2 code assigned to military assets. - `mode3` integer — The Mode 3 code assigned by ATC to the asset. - `mode4InterrogationResponse` 'INTERROGATION_RESPONSE_INVALID' | 'INTERROGATION_RESPONSE_CORRECT' | 'INTERROGATION_RESPONSE_INCORRECT' | 'INTERROGATION_RESPONSE_NO_RESPONSE' — The validity of the response from the Mode 4 interrogation. - `mode5` Mode5 — Describes the Mode 5 transponder interrogation status and codes. - `mode5InterrogationResponse` 'INTERROGATION_RESPONSE_INVALID' | 'INTERROGATION_RESPONSE_CORRECT' | 'INTERROGATION_RESPONSE_INCORRECT' | 'INTERROGATION_RESPONSE_NO_RESPONSE' — The validity of the response from the Mode 5 interrogation. - `mode5` integer — The Mode 5 code assigned to military assets. - `mode5PlatformId` integer — The Mode 5 platform identification code. - `modeS` ModeS — Describes the Mode S codes. - `id` string — Mode S identifier which comprises of 8 alphanumeric characters. - `address` integer — The Mode S ICAO aircraft address. Expected values are between 1 and 16777214 decimal. The Mode S address is considered unique. - `modeCAltitudeFt` integer — The Mode C altitude reported by the transponder in feet. Mode C provides pressure altitude in 100-foot increments up to 10,000 feet MSL. Valid altitudes include 0 ft (sea level). An unset field indicates no Mode C response was received. - `dataClassification` Classification — A component that describes an entity's security classification levels. - `default` ClassificationInformation — Represents all of the necessary information required to generate a summarized classification marking. > example: A summarized classification marking of "TOPSECRET//NOFORN//FISA" would be defined as: { "level": 5, "caveats": [ "NOFORN, "FISA" ] } - `level` 'CLASSIFICATION_LEVELS_INVALID' | 'CLASSIFICATION_LEVELS_UNCLASSIFIED' | 'CLASSIFICATION_LEVELS_CONTROLLED_UNCLASSIFIED' | 'CLASSIFICATION_LEVELS_CONFIDENTIAL' | 'CLASSIFICATION_LEVELS_SECRET' | 'CLASSIFICATION_LEVELS_TOP_SECRET' — Classification level to be applied to the information in question. - `caveats` string[] — Caveats that may further restrict how the information can be disseminated. - `fields` FieldClassificationInformation[] — The set of individual field classification information which should always precedence over the default classification information. - `fieldPath` string — Proto field path which is the string representation of a field. > example: signal.bandwidth_hz would be bandwidth_hz in the signal component - `classificationInformation` ClassificationInformation — Represents all of the necessary information required to generate a summarized classification marking. > example: A summarized classification marking of "TOPSECRET//NOFORN//FISA" would be defined as: { "level": 5, "caveats": [ "NOFORN, "FISA" ] } - `level` 'CLASSIFICATION_LEVELS_INVALID' | 'CLASSIFICATION_LEVELS_UNCLASSIFIED' | 'CLASSIFICATION_LEVELS_CONTROLLED_UNCLASSIFIED' | 'CLASSIFICATION_LEVELS_CONFIDENTIAL' | 'CLASSIFICATION_LEVELS_SECRET' | 'CLASSIFICATION_LEVELS_TOP_SECRET' — Classification level to be applied to the information in question. - `caveats` string[] — Caveats that may further restrict how the information can be disseminated. - `taskCatalog` TaskCatalog — Catalog of supported tasks. - `taskDefinitions` TaskDefinition[] - `taskSpecificationUrl` string — Url path must be prefixed with `type.googleapis.com/`. - `media` Media — Media associated with an entity. - `media` MediaItem[] - `itemIdentifier` string — A unique identifier for this mediaItem. - `type` 'MEDIA_TYPE_INVALID' | 'MEDIA_TYPE_IMAGE' | 'MEDIA_TYPE_VIDEO' — The type of media for this item. - `relativePath` string — The path, relative to the environment base URL, where media related to an entity can be accessed - `relationships` Relationships — The relationships between this entity and other entities in the common operational picture. - `relationships` Relationship[] - `relatedEntityId` string — The entity ID to which this entity is related. - `relationshipId` string — A unique identifier for this relationship. Allows removing or updating relationships. - `relationshipType` RelationshipType — Determines the type of relationship between this entity and another. - `trackedBy` TrackedBy — Describes the relationship between the entity being tracked ("tracked entity") and the entity that is performing the tracking ("tracking entity"). - … - `groupChild` GroupChild — A GroupChild relationship is a uni-directional relationship indicating that (1) this entity represents an Entity Group and (2) the related entity is a child member of this group. The presence of this relationship alone determines that the type of group is an Entity Group. - `groupParent` GroupParent — A GroupParent relationship is a uni-directional relationship indicating that this entity is a member of the Entity Group represented by the related entity. The presence of this relationship alone determines that the type of group that this entity is a member of is an Entity Group. - `mergedFrom` MergedFrom — A MergedFrom relationship is a uni-directional relationship indicating that this entity is a merged entity whose data has at least partially been merged from the related entity. - `activeTarget` ActiveTarget — A target relationship is the inverse of TrackedBy; a one-way relation from sensor to target, indicating track(s) currently prioritized by a robot. - `visualDetails` VisualDetails — Visual details associated with the display of an entity in the client. - `rangeRings` RangeRings — Range rings allow visual assessment of map distance at varying zoom levels. - `minDistanceM` number, double — The minimum range ring distance, specified in meters. - `maxDistanceM` number, double — The maximum range ring distance, specified in meters. - `ringCount` integer — The count of range rings. - `ringLineColor` Color - `red` string — The amount of red in the color as a value in the interval [0, 255]. - `green` string — The amount of green in the color as a value in the interval [0, 255]. - `blue` string — The amount of blue in the color as a value in the interval [0, 255]. - `alpha` string — The fraction of this color that should be applied to the pixel. That is, the final pixel color is defined by the equation: `pixel color = alpha * (this color) + (1.0 - alpha) * (background color)` This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. This uses a wrapper message rather than a simple float scalar so that it is possible to distinguish between a default value and the value being unset. If omitted, this color object is rendered as a solid color (as if the alpha value had been explicitly given a value of 1.0). - `dimensions` Dimensions - `lengthM` string — Length of the entity in meters - `routeDetails` RouteDetails - `destinationName` string — Free form text giving the name of the entity's destination - `estimatedArrivalTime` string, date-time — Estimated time of arrival at destination - `schedules` Schedules — Schedules associated with this entity - `schedules` Schedule[] - `windows` CronWindow[] — expression that represents this schedule's "ON" state - `cronExpression` string — in UTC, describes when and at what cadence this window starts, in the quartz flavor of cron examples: This schedule is begins at 7:00:00am UTC everyday between Monday and Friday 0 0 7 ? * MON-FRI * This schedule begins every 5 minutes starting at 12:00:00pm UTC until 8:00:00pm UTC everyday 0 0/5 12-20 * * ? * This schedule begins at 12:00:00pm UTC on March 2nd 2023 0 0 12 2 3 ? 2023 - `durationMillis` string — describes the duration - `scheduleId` string — A unique identifier for this schedule. - `scheduleType` 'SCHEDULE_TYPE_INVALID' | 'SCHEDULE_TYPE_ZONE_ENABLED' | 'SCHEDULE_TYPE_ZONE_TEMP_ENABLED' — The schedule type - `health` Health — General health of the entity as reported by the entity. - `connectionStatus` 'CONNECTION_STATUS_INVALID' | 'CONNECTION_STATUS_ONLINE' | 'CONNECTION_STATUS_OFFLINE' — Status indicating whether the entity is able to communicate with Entity Manager. - `healthStatus` 'HEALTH_STATUS_INVALID' | 'HEALTH_STATUS_HEALTHY' | 'HEALTH_STATUS_WARN' | 'HEALTH_STATUS_FAIL' | 'HEALTH_STATUS_OFFLINE' | 'HEALTH_STATUS_NOT_READY' — Top-level health status; typically a roll-up of individual component healths. - `components` ComponentHealth[] — Health of individual components running on this Entity. - `id` string — Consistent internal ID for this component. - `name` string — Display name for this component. - `health` 'HEALTH_STATUS_INVALID' | 'HEALTH_STATUS_HEALTHY' | 'HEALTH_STATUS_WARN' | 'HEALTH_STATUS_FAIL' | 'HEALTH_STATUS_OFFLINE' | 'HEALTH_STATUS_NOT_READY' — Health for this component. - `messages` ComponentMessage[] — Human-readable describing the component state. These messages should be understandable by end users. - `status` 'HEALTH_STATUS_INVALID' | 'HEALTH_STATUS_HEALTHY' | 'HEALTH_STATUS_WARN' | 'HEALTH_STATUS_FAIL' | 'HEALTH_STATUS_OFFLINE' | 'HEALTH_STATUS_NOT_READY' — The status associated with this message. - `message` string — The human-readable content of the message. - `updateTime` string, date-time — The last update time for this specific component. If this timestamp is unset, the data is assumed to be most recent - `updateTime` string, date-time — The update time for the top-level health information. If this timestamp is unset, the data is assumed to be most recent - `activeAlerts` Alert[] — Active alerts indicate a critical change in system state sent by the asset that must be made known to an operator or consumer of the common operating picture. Alerts are different from ComponentHealth messages--an active alert does not necessarily indicate a component is in an unhealthy state. For example, an asset may trigger an active alert based on fuel levels running low. Alerts should be removed from this list when their conditions are cleared. In other words, only active alerts should be reported here. - `alertCode` string — Short, machine-readable code that describes this alert. This code is intended to provide systems off-asset with a lookup key to retrieve more detailed information about the alert. - `description` string — Human-readable description of this alert. The description is intended for display in the UI for human understanding and should not be used for machine processing. If the description is fixed and the vehicle controller provides no dynamic substitutions, then prefer lookup based on alert_code. - `level` 'ALERT_LEVEL_INVALID' | 'ALERT_LEVEL_ADVISORY' | 'ALERT_LEVEL_CAUTION' | 'ALERT_LEVEL_WARNING' — Alert level (Warning, Caution, or Advisory). - `activatedTime` string, date-time — Time at which this alert was activated. - `activeConditions` AlertCondition[] — Set of conditions which have activated this alert. - `conditionCode` string — Short, machine-readable code that describes this condition. This code is intended to provide systems off-asset with a lookup key to retrieve more detailed information about the condition. - `description` string — Human-readable description of this condition. The description is intended for display in the UI for human understanding and should not be used for machine processing. If the description is fixed and the vehicle controller provides no dynamic substitutions, then prefer lookup based on condition_code. - `groupDetails` GroupDetails — Details related to grouping for this entity - `team` Team — Represents a team of agents - `entityId` string — Entity ID of the team - `members` Agent[] - `entityId` string — Entity ID of the agent. - `echelon` Echelon — Describes a Echelon group type. Comprised of entities which are members of the same unit or echelon. Ex: A group of tanks within a armored company or that same company as a member of a battalion. - `armyEchelon` 'ARMY_ECHELON_INVALID' | 'ARMY_ECHELON_FIRE_TEAM' | 'ARMY_ECHELON_SQUAD' | 'ARMY_ECHELON_PLATOON' | 'ARMY_ECHELON_COMPANY' | 'ARMY_ECHELON_BATTALION' | 'ARMY_ECHELON_REGIMENT' | 'ARMY_ECHELON_BRIGADE' | 'ARMY_ECHELON_DIVISION' | 'ARMY_ECHELON_CORPS' | 'ARMY_ECHELON_ARMY' - `supplies` Supplies — Represents the state of supplies associated with an entity (available but not in condition to use immediately) - `munitions` Munition[] - `munitionId` string — Unique munition identifier - `name` string — Long form name of the munition - `quantityUnits` integer — Number of units - `fuel` Fuel[] - `fuelId` string — Unique fuel identifier - `name` string — Long form name of the fuel source. - `reportedDate` string, date-time — Timestamp the information was reported - `amountGallons` integer — Amount of gallons on hand - `maxAuthorizedCapacityGallons` integer — How much the asset is allowed to have available (in gallons) - `operationalRequirementGallons` integer — Minimum required for operations (in gallons) - `dataClassification` Classification — A component that describes an entity's security classification levels. - `default` ClassificationInformation — Represents all of the necessary information required to generate a summarized classification marking. > example: A summarized classification marking of "TOPSECRET//NOFORN//FISA" would be defined as: { "level": 5, "caveats": [ "NOFORN, "FISA" ] } - … - `fields` FieldClassificationInformation[] — The set of individual field classification information which should always precedence over the default classification information. - … - `dataSource` string — Source of information - `orbit` Orbit - `orbitMeanElements` OrbitMeanElements — Orbit Mean Elements data, analogous to the Orbit Mean Elements Message in CCSDS 502.0-B-3 - `metadata` OrbitMeanElementsMetadata - `creationDate` string, date-time — Creation date/time in UTC - `originator` string — Creating agency or operator - `messageId` string — ID that uniquely identifies a message from a given originator. - `refFrame` 'ECI_REFERENCE_FRAME_INVALID' | 'ECI_REFERENCE_FRAME_TEME' — Reference frame, assumed to be Earth-centered - `refFrameEpoch` string, date-time — Reference frame epoch in UTC - mandatory only if not intrinsic to frame definition - `meanElementTheory` 'MEAN_ELEMENT_THEORY_INVALID' | 'MEAN_ELEMENT_THEORY_SGP4' - `meanKeplerianElements` MeanKeplerianElements - `epoch` string, date-time — UTC time of validity - `semiMajorAxisKm` number, double — Preferred: semi major axis in kilometers - `meanMotion` number, double — If using SGP/SGP4, provide the Keplerian Mean Motion in revolutions per day - `eccentricity` number, double - `inclinationDeg` number, double — Angle of inclination in deg - `raOfAscNodeDeg` number, double — Right ascension of the ascending node in deg - `argOfPericenterDeg` number, double — Argument of pericenter in deg - `meanAnomalyDeg` number, double — Mean anomaly in deg - `gm` number, double — Optional: gravitational coefficient (Gravitational Constant x central mass) in kg^3 / s^2 - `tleParameters` TleParameters - `ephemerisType` integer — Integer specifying TLE ephemeris type - `classificationType` string — User-defined free-text message classification/caveats of this TLE - `noradCatId` integer — Norad catalog number: integer up to nine digits. - `elementSetNo` integer - `revAtEpoch` integer — Optional: revolution number - `bstar` number, double — Drag parameter for SGP-4 in units 1 / Earth radii - `bterm` number, double — Drag parameter for SGP4-XP in units m^2 / kg - `meanMotionDot` number, double — First time derivative of mean motion in rev / day^2 - `meanMotionDdot` number, double — Second time derivative of mean motion in rev / day^3. For use with SGP or PPT3. - `agom` number, double — Solar radiation pressure coefficient A_gamma / m in m^2 / kg. For use with SGP4-XP. - `symbology` Symbology — Symbology associated with an entity. - `milStd2525C` MilStd2525C - `sidc` string - `snapshot` boolean — Indicates that this entity was generated from a snapshot of a live entity. - `owner` Owner — Owner designates the entity responsible for writes of task data. - `entityId` string — Entity ID of the owner. - `retryStrategy` RetryStrategy — Sets an optional try strategy for tasks. Use this option to control how Lattice attempts to retry delivery of tasks to assets with intermittent access or network connectivity to your environment. - `fixedRetryStrategy` FixedRetry — Defaults to an interval of 5 seconds. If the DeliverBefore field in the task's DeliveryConstraints isn't populated, Lattice does not retry delivery and instead logs a warning. - `retryInterval` string — Specifies the interval between retries. A default interval of 5 seconds is used if this field is not set. - `deliveryState` DeliveryState — Defines the current state of a task's delivery. - `status` 'DELIVERY_STATUS_INVALID' | 'DELIVERY_STATUS_DELIVERED' | 'DELIVERY_STATUS_PENDING_EXECUTE' | 'DELIVERY_STATUS_PENDING_CANCEL' | 'DELIVERY_STATUS_PENDING_COMPLETE' — The current status of the delivery. - `error` DeliveryError — DeliveryError contains an error code and message associated with task delivery. - `code` 'DELIVERY_ERROR_CODE_INVALID' | 'DELIVERY_ERROR_CODE_UNAVAILABLE' | 'DELIVERY_ERROR_CODE_TIMEOUT' | 'DELIVERY_ERROR_CODE_REJECTED' — Error code for Delivery error. - `message` string — Descriptive human-readable string regarding this delivery error. - `deliveryConstraints` DeliveryConstraints — DeliveryConstraints defines when Lattice should deliver the task to the agent. - `deliverAfter` string, date-time — Optional earliest time the task can attempt to be delivered. - `deliverBefore` string, date-time — The latest time by which the task should be delivered. If this deadline passes without successful delivery of the task, then the task will time out with DELIVERY_ERROR_CODE_TIMEOUT. This field is only required for tasks with retry strategies. ## Other responses - `400` — Bad request - `401` — Unauthorized to access resource - `404` — The specified resource was not found --- [API](https://skmtc.net/anduril/apis/rest.md) · [All operations](https://skmtc.net/anduril/apis/rest/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/anduril/rest/versions/c2a841b48ac6/schema)