> This is the Markdown version of the page. For the complete Lattice Developers documentation index, fetch https://developer.anduril.com/llms.txt. Append .md to any page URL for its clean Markdown. # Stream tasks POST https://example.developer.anduril.com/api/v1/tasks/stream Content-Type: application/json Establishes a server streaming connection that delivers task updates in real-time using Server-Sent Events (SSE). The stream delivers all existing non-terminal tasks when first connected, followed by real-time updates for task creation and status changes. Additionally, heartbeat messages are sent periodically to maintain the connection. Reference: https://developer.anduril.com/reference/rest/tasks/stream-tasks ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Body (application/json) This endpoint expects an object. - `heartbeatIntervalMs` (integer, optional) — The time interval, in milliseconds, that determines the frequency at which to send heartbeat events. Defaults to 30000 (30 seconds). - `rateLimit` (integer, optional, default: 0) — The time interval, in milliseconds, after an update for a given task before another one will be sent for the same task. If set, value must be >= 250. - `excludePreexistingTasks` (boolean, optional, default: false) — Optional flag to only include tasks created or updated after the stream is initiated, and not any previous preexisting tasks. If unset or false, the stream will include any new tasks and task updates, as well as all preexisting tasks. - `taskType` (object or object, optional) — Optional filter that only returns tasks with specific types. If not provided, all task types will be streamed. - object - `taskTypeUrls` (list of string, required) — List of exact task type URLs to match. - object - `taskTypePrefix` (string, required) — Prefix string to match task types. Any task with a type that starts with this prefix will be included. - `updateStartTime` (string, optional) — If provided, returns tasks which have been updated since the given time. - `parentTaskId` (string, optional) — A filter for tasks with a specific parent task ID. Note: This filter is mutually exclusive with all other filter fields (`updateStartTime`, `assignee`, `statusFilter`, `taskType`). Either provide `parentTaskId` or any combination of the other filters, but not both. - `assignee` (object, optional) — A filter for tasks assigned to a specific principal. - `system` (object, optional) — System Principal representing some autonomous system. - `serviceName` (string, optional) — Name of the service associated with this System. - `entityId` (string, optional) — The Entity ID of the System. - `managesOwnScheduling` (boolean, optional) — 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` (object, optional) — A User Principal representing a human. - `userId` (string, optional) — The User ID associated with this User. - `team` (object, optional) — Represents a team of agents - `entityId` (string, optional) — Entity ID of the team - `members` (list of object, optional) - `entityId` (string, optional) — Entity ID of the agent. - `onBehalfOf` (object, optional) — The Principal _this_ Principal is acting on behalf of. Likely only populated once in the nesting (i.e. the "on_behalf_of" Principal would not have another "on_behalf_of" in most cases). - `statusFilter` (object, optional) — A filter for task statuses (inclusive or exclusive). - `statuses` (list of enum, optional) — The statuses to filter by. - Allowed values: `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` - `filterType` (enum, optional) — The type of filter to apply. - Allowed values: `FILTER_TYPE_INVALID`, `FILTER_TYPE_INCLUSIVE`, `FILTER_TYPE_EXCLUSIVE` ## Response ### 200 Returns a stream of task updates as they occur. - Streaming response of `object`. - `event`: `heartbeat` (heartbeat) - `timestamp` (string, optional) — The timestamp at which the heartbeat message was sent. - `event`: `task_event` (task_event) - `taskEvent` (object, optional) — The task event that occurred. - `eventType` (enum, optional) — The type of event that occurred for this task. - Allowed values: `EVENT_TYPE_INVALID`, `EVENT_TYPE_CREATED`, `EVENT_TYPE_UPDATE`, `EVENT_TYPE_PREEXISTING` - `task` (object, optional) — The task associated with this event. - `version` (object, optional) — Version of this task. - `taskId` (string, optional) — The unique identifier for this task, used to distinguish it from all other tasks in the system. - `definitionVersion` (uint, optional) — 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` (uint, optional) — Counter that increments on changes to TaskStatus. Unset (0) initially, starts at 1 on creation, and increments with each status update. - `displayName` (string, optional) — DEPRECATED: Human readable display name for this task, should be short (\<100 chars). - `specification` (object, optional) — The path for the Protobuf task definition, and the complete task data. - `@type` (string, optional) — The type of the serialized message. - `createdBy` (object, optional) — Records who created this task. This field will not change after the task has been created. - `system` (object, optional) — System Principal representing some autonomous system. - `serviceName` (string, optional) — Name of the service associated with this System. - `entityId` (string, optional) — The Entity ID of the System. - `managesOwnScheduling` (boolean, optional) — 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` (object, optional) — A User Principal representing a human. - `userId` (string, optional) — The User ID associated with this User. - `team` (object, optional) — Represents a team of agents - `entityId` (string, optional) — Entity ID of the team - `members` (list of object, optional) - `entityId` (string, optional) — Entity ID of the agent. - `onBehalfOf` (object, optional) — The Principal _this_ Principal is acting on behalf of. Likely only populated once in the nesting (i.e. the "on_behalf_of" Principal would not have another "on_behalf_of" in most cases). - `lastUpdatedBy` (object, optional) — Records who updated this task last. - `system` (object, optional) — System Principal representing some autonomous system. - `serviceName` (string, optional) — Name of the service associated with this System. - `entityId` (string, optional) — The Entity ID of the System. - `managesOwnScheduling` (boolean, optional) — 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` (object, optional) — A User Principal representing a human. - `userId` (string, optional) — The User ID associated with this User. - `team` (object, optional) — Represents a team of agents - `entityId` (string, optional) — Entity ID of the team - `members` (list of object, optional) - `entityId` (string, optional) — Entity ID of the agent. - `onBehalfOf` (object, optional) — The Principal _this_ Principal is acting on behalf of. Likely only populated once in the nesting (i.e. the "on_behalf_of" Principal would not have another "on_behalf_of" in most cases). - `lastUpdateTime` (datetime, optional) — Records the time of last update. - `status` (object, optional) — The status of this task. - `status` (enum, optional) — Status of the task. - Allowed values: `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` - `taskError` (object, optional) — Any errors associated with the task. - `code` (enum, optional) — Error code for task error. - Allowed values: `ERROR_CODE_INVALID`, `ERROR_CODE_CANCELLED`, `ERROR_CODE_REJECTED`, `ERROR_CODE_TIMEOUT`, `ERROR_CODE_FAILED` - `message` (string, optional) — Descriptive human-readable string regarding this error. - `errorDetails` (object, optional) — Any additional details regarding this error. - `@type` (string, optional) — The type of the serialized message. - `progress` (object, optional) — Any incremental progress on the task, should be from the tasks/v*/progress folder. - `@type` (string, optional) — The type of the serialized message. - `result` (object, optional) — Any final result of the task, should be from tasks/v*/result folder. - `@type` (string, optional) — The type of the serialized message. - `startTime` (datetime, optional) — Time the task began execution, may not be known even for executing Tasks. - `estimate` (object, optional) — Any estimate for how the task will progress, should be from tasks/v*/estimates folder. - `@type` (string, optional) — The type of the serialized message. - `allocation` (object, optional) — Any allocated agents of the task. - `activeAgents` (list of object, optional) — Agents actively being utilized in a task. - `entityId` (string, optional) — Entity ID of the agent. - `scheduledTime` (datetime, optional) — If the task has been scheduled to execute, what time it should execute at. - `relations` (object, optional) — Any related Tasks associated with this, typically includes an assignee for this task and/or a parent. - `assignee` (object, optional) — The system, user, or team assigned to the task. - `system` (object, optional) — System Principal representing some autonomous system. - `serviceName` (string, optional) — Name of the service associated with this System. - `entityId` (string, optional) — The Entity ID of the System. - `managesOwnScheduling` (boolean, optional) — 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` (object, optional) — A User Principal representing a human. - `userId` (string, optional) — The User ID associated with this User. - `team` (object, optional) — Represents a team of agents - `entityId` (string, optional) — Entity ID of the team - `members` (list of object, optional) - `onBehalfOf` (object, optional) — The Principal _this_ Principal is acting on behalf of. Likely only populated once in the nesting (i.e. the "on_behalf_of" Principal would not have another "on_behalf_of" in most cases). - `parentTaskId` (string, optional) — Identifies the parent task if the task is a sub-task. - `description` (string, optional) — Longer, free form human readable description of this task - `isExecutedElsewhere` (boolean, optional) — 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` (datetime, optional) — Time of task creation. - `replication` (object, optional) — If populated, designates this to be a replicated task. - `staleTime` (datetime, optional) — The time by which this task should be assumed to be stale. - `initialEntities` (list of object, optional) — 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` (object, optional) — The wrapped entity. - `entityId` (string, optional) — A Globally Unique Identifier (GUID) for your entity. This is a required field. - `description` (string, optional) — 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, optional) — 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` (datetime, optional) — 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` (datetime, optional) — 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, optional) — 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` (object, optional) — Human-readable descriptions of what the entity is currently doing. - `platformActivity` (string, optional) — A string that describes the activity that the entity is performing. Examples include "RECONNAISSANCE", "INTERDICTION", "RETURN TO BASE (RTB)", "PREPARING FOR LAUNCH". - `role` (string, optional) — A human-readable string that describes the role the entity is currently performing. E.g. "Team Member", "Commander". - `location` (object, optional) — Geospatial data related to the entity, including its position, kinematics, and orientation. Populate either this field (and `location_uncertainty`) or `kinematics`, not both. Populating both can lead to conflicting or inconsistent kinematics data for the entity. - `position` (object, optional) — see Position definition for details. - `velocityEnu` (object, optional) — Velocity in an ENU reference frame centered on the corresponding position. All units are meters per second. - `speedMps` (double, optional) — Speed is the magnitude of velocity_enu vector [sqrt(e^2 + n^2 + u^2)] when present, measured in m/s. - `acceleration` (object, optional) — The entity's acceleration in meters/s^2. - `attitudeEnu` (object, optional) — quaternion to translate from entity body frame to it's ENU frame - `locationUncertainty` (object, optional) — Indicates uncertainty of the entity's position and kinematics. - `positionEnuCov` (object, optional) — Positional covariance represented by the upper triangle of the covariance matrix. It is valid to populate only the diagonal of the matrix if the full covariance matrix is unknown. - `velocityEnuCov` (object, optional) — Velocity covariance represented by the upper triangle of the covariance matrix. It is valid to populate only the diagonal of the matrix if the full covariance matrix is unknown. - `positionErrorEllipse` (object, optional) — An ellipse that describes the certainty probability and error boundary for a given geolocation. - `kinematics` (object, optional) — Kinematics data related to the entity to a higher degree of granularity than Location. This is preferred for Track Entities. Populate either `location`/`location_uncertainty` or this field, not both. Populating both can lead to conflicting or inconsistent kinematics data for the entity. - `kinematicsGeodetic` (object, optional) — Kinematics measured in a geodetic (WGS84 latitude/longitude/altitude and ENU) reference frame. - `kinematicsGeocentric` (object, optional) — Kinematics measured in a geocentric (ECEF) reference frame. - `geoShape` (object, optional) — Geospatial representation of the entity, including entities that cover an area rather than a fixed point. - `point` (object, optional) — A point shaped geo-entity. See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 - `line` (object, optional) — A line shaped geo-entity. See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4 - `polygon` (object, optional) — A polygon shaped geo-entity. See https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6, only canonical representations accepted - `ellipse` (object, optional) — 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. - `ellipsoid` (object, optional) — An ellipsoid shaped geo-entity. Principal axis lengths are defined in entity body space This shape is NOT Geo-JSON compatible. - `geoDetails` (object, optional) — Additional details on what the geospatial area or point represents, along with visual display details. - `type` (enum, optional) - `controlArea` (object, optional) — Determines the type of control area being represented by the geo-entity, in which an asset can, or cannot, operate. - `acm` (object, optional) - `visualDetails` (object, optional) — Details specific to displaying a geo-entity - `aliases` (object, optional) — Entity name displayed in the Lattice UI side panel. Also includes identifiers that other systems can use to reference the same entity. - `alternateIds` (list of object, optional) - `name` (string, optional) — The best available version of the entity's display name. - `tracked` (object, optional) — If this entity is tracked by another entity, this component contains data related to how it's being tracked. - `trackQualityWrapper` (integer, optional) — Quality score, 0-15, nil if none - `sensorHits` (integer, optional) — Sensor hits aggregation on the tracked entity. - `numberOfObjects` (object, optional) — Estimated number of objects or units that are represented by this entity. Known as Strength in certain contexts (Link16) if UpperBound == LowerBound; (strength = LowerBound) If both UpperBound and LowerBound are defined; strength is between LowerBound and UpperBound (represented as string "Strength: 4-5") If UpperBound is defined only (LowerBound unset), Strength ≤ UpperBound If LowerBound is defined only (UpperBound unset), LowerBound ≤ Strength 0 indicates unset. - `radarCrossSection` (double, optional) — 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` (datetime, optional) — Timestamp of the latest tracking measurement for this entity. - `lineOfBearing` (object, optional) — The relative position of a track with respect to the entity that is tracking it. Used for tracks that do not yet have a 3D position. For this entity (A), being tracked by some entity (B), this LineOfBearing would express a ray from B to A. - `correlation` (object, optional) — If this entity has been correlated or decorrelated to another one, this component contains information on the correlation or decorrelation. - `primary` (object, optional) — This entity is the primary of a correlation meaning that it serves as the representative entity of the correlation set. - `secondary` (object, optional) — This entity is a secondary of a correlation meaning that it will be represented by the primary of the correlation set. - `membership` (object, optional) — If present, this entity is a part of a correlation set. - `decorrelation` (object, optional) — If present, this entity was explicitly decorrelated from one or more entities. An entity can be both correlated and decorrelated as long as they are disjoint sets. An example would be if a user in the UI decides that two tracks are not actually the same despite an automatic correlator having correlated them. The user would then decorrelate the two tracks and this decorrelation would be preserved preventing the correlator from re-correlating them at a later time. - `milView` (object, optional) — View of the entity. - `disposition` (enum, optional) - `environment` (enum, optional) - `nationality` (enum, optional) - `ontology` (object, optional) — Ontology defines an entity's categorization in Lattice, and improves data retrieval and integration. Builds a standardized representation of the entity. - `platformType` (string, optional) — A string that describes the entity's high-level type with natural language. - `specificType` (string, optional) — A string that describes the entity's exact model or type. - `template` (enum, optional) — The template used when creating this entity. Specifies minimum required components. - `sensors` (object, optional) — Details an entity's available sensors. - `sensors` (list of object, optional) - `payloads` (object, optional) — Details an entity's available payloads. - `payloadConfigurations` (list of object, optional) - `powerState` (object, optional) — Details the entity's power source. - `sourceIdToState` (map from string to object, optional) — 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` (object, optional) — The primary data source provenance for this entity. - `integrationName` (string, optional) — Name of the integration that produced this entity - `dataType` (string, optional) — Source data type of this entity. Examples: ADSB, Link16, etc. - `sourceId` (string, optional) — An ID that allows an element from a source to be uniquely identified - `sourceUpdateTime` (datetime, optional) — 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, optional) — Description of the modification source. In the case of a user this is the email address. - `overrides` (object, optional) — Provenance of override data. - `override` (list of object, optional) - `indicators` (object, optional) — 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. - `simulated` (boolean, optional) - `exercise` (boolean, optional) - `emergency` (boolean, optional) - `c2` (boolean, optional) - `egressable` (boolean, optional) — Indicates the Entity should be egressed to external sources. Integrations choose how the egressing happens (e.g. if an Entity needs fuzzing). - `starred` (boolean, optional) — A signal of arbitrary importance such that the entity should be globally marked for all users - `targetPriority` (object, optional) — The prioritization associated with an entity, such as if it's a threat or a high-value target. - `highValueTarget` (object, optional) — Describes the target priority in relation to high value target lists. - `threat` (object, optional) — Describes whether the entity should be treated as a threat - `signal` (object, optional) — Describes an entity's signal characteristics, primarily used when an entity is a signal of interest. - `frequencyCenter` (object, optional) — A component for describing frequency. - `frequencyRange` (object, optional) — A component to represent a frequency range. - `bandwidthHz` (double, optional) — Indicates the bandwidth of a signal (Hz). - `signalToNoiseRatio` (double, optional) — Indicates the signal to noise (SNR) of this signal. - `lineOfBearing` (object, optional) — A line of bearing of a signal. - `fixed` (object, optional) — A fix of a signal. No extra fields but it is expected that location should be populated when using this report. - `emitterNotations` (list of object, optional) — Emitter notations associated with this entity. - `pulseWidthS` (double, optional) — length in time of a single pulse - `pulseRepetitionInterval` (object, optional) — length in time between the start of two pulses - `scanCharacteristics` (object, optional) — describes how a signal is observing the environment - `receivedSignalStrengthDbm` (object, optional) — Indicates the received signal strength (RSSI) of this signal in decibels relative to one milliwatt (dBm). - `transponderCodes` (object, optional) — A message describing any transponder codes associated with Mode 1, 2, 3, 4, 5, S, C interrogations. These are related to ADS-B modes. - `mode1` (uint, optional) — The mode 1 code assigned to military assets. - `mode2` (uint, optional) — The Mode 2 code assigned to military assets. - `mode3` (uint, optional) — The Mode 3 code assigned by ATC to the asset. - `mode4InterrogationResponse` (enum, optional) — The validity of the response from the Mode 4 interrogation. - `mode5` (object, optional) — The Mode 5 transponder codes. - `modeS` (object, optional) — The Mode S transponder codes. - `modeCAltitudeFt` (integer, optional) — 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` (object, optional) — Describes an entity's security classification levels at an overall classification level and on a per field level. - `default` (object, optional) — The default classification information which should be assumed to apply to everything in the entity unless a specific field level classification is present. - `fields` (list of object, optional) — The set of individual field classification information which should always precedence over the default classification information. - `taskCatalog` (object, optional) — A catalog of tasks that can be performed by an entity. - `taskDefinitions` (list of object, optional) - `media` (object, optional) — Media associated with an entity, such as videos, images, or thumbnails. - `media` (list of object, optional) - `relationships` (object, optional) — The relationships between this entity and other entities in the common operational picture (COP). - `relationships` (list of object, optional) - `visualDetails` (object, optional) — Visual details associated with the display of an entity in the client. - `rangeRings` (object, optional) — The range rings to display around an entity. - `dimensions` (object, optional) — Physical dimensions of the entity. - `lengthM` (float, optional) — Length of the entity in meters - `routeDetails` (object, optional) — Additional information about an entity's route. - `destinationName` (string, optional) — Free form text giving the name of the entity's destination - `estimatedArrivalTime` (datetime, optional) — Estimated time of arrival at destination - `schedules` (object, optional) — Schedules associated with this entity. - `schedules` (list of object, optional) - `health` (object, optional) — Health metrics or connection status reported by the entity. - `connectionStatus` (enum, optional) — Status indicating whether the entity is able to communicate with Entity Manager. - `healthStatus` (enum, optional) — Top-level health status; typically a roll-up of individual component healths. - `components` (list of object, optional) — Health of individual components running on this Entity. - `updateTime` (datetime, optional) — The update time for the top-level health information. If this timestamp is unset, the data is assumed to be most recent - `activeAlerts` (list of object, optional) — 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. - `groupDetails` (object, optional) — Details for the group associated with this entity. - `team` (object, optional) — Represents a team of agents - `platformSubcomponents` (object, optional) — Describes a PlatformSubcomponents group type. Comprised of entities which are subcomponents of the parent platform and the parent platform itself. Subcomponents are assumed to be positionally related to the parent group. relationship to a radar entity. - `echelon` (object, optional) — 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. - `supplies` (object, optional) — Contains relevant supply information for the entity, such as fuel. - `munitions` (list of object, optional) - `fuel` (list of object, optional) - `orbit` (object, optional) — Orbit information for space objects. - `orbitMeanElements` (object, optional) — Orbit Mean Elements data, analogous to the Orbit Mean Elements Message in CCSDS 502.0-B-3 - `symbology` (object, optional) — Symbology/iconography for the entity respecting an existing standard. - `milStd2525C` (object, optional) - `snapshot` (boolean, optional) — Indicates that this entity was generated from a snapshot of a live entity. - `owner` (object, optional) — The networked owner of this task. It is used to ensure that linear writes occur on the node responsible for replication of task data to other nodes running Task Manager. - `entityId` (string, optional) — Entity ID of the owner. - `retryStrategy` (object, optional) — 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` (object, optional) — 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, optional) — Specifies the interval between retries. A default interval of 5 seconds is used if this field is not set. - `deliveryState` (object, optional) — The current delivery state of a task. - `status` (enum, optional) — The current status of the delivery. - Allowed values: `DELIVERY_STATUS_INVALID`, `DELIVERY_STATUS_DELIVERED`, `DELIVERY_STATUS_PENDING_EXECUTE`, `DELIVERY_STATUS_PENDING_CANCEL`, `DELIVERY_STATUS_PENDING_COMPLETE` - `error` (object, optional) — Errors associated with the delivery, if any. - `code` (enum, optional) — Error code for Delivery error. - Allowed values: `DELIVERY_ERROR_CODE_INVALID`, `DELIVERY_ERROR_CODE_UNAVAILABLE`, `DELIVERY_ERROR_CODE_TIMEOUT`, `DELIVERY_ERROR_CODE_REJECTED`, `DELIVERY_ERROR_CODE_NOT_ACKNOWLEDGED` - `message` (string, optional) — Descriptive human-readable string regarding this delivery error. - `deliveryConstraints` (object, optional) — Optional scheduling constraints for Lattice delivery of the task. - `deliverAfter` (datetime, optional) — Optional earliest time the task can attempt to be delivered. - `deliverBefore` (datetime, optional) — 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. - `requireAcknowledgement` (boolean, optional) — Requires the agent to acknowledge the request before Lattice considers it delivered. Without this, a request sent over a streaming agent connection is marked delivered as soon as the send returns, which only proves it reached a local buffer and not that the agent received it. With this set, the task is not marked delivered until the agent reports a status confirming receipt; Lattice re-sends until it does, and eventually fails delivery with DELIVERY_ERROR_CODE_NOT_ACKNOWLEDGED. Requires deliver_before, which bounds that retrying. - `executionConstraints` (object, optional) — Any execution-related scheduling constraints for the agent after task delivery. - `startAfter` (datetime, optional) — The timestamp after which the agent can execute the task - `completeBefore` (datetime, optional) — The timestamp before which the agent can execute the task. ## Errors ### 400 Bad Request Error Bad request - `code` (string, required) - `message` (string, required) ### 401 Unauthorized Error Unauthorized to access resource - `code` (string, required) - `message` (string, required) ## Examples **Request** ```json {} ```