For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
ContactLearn More
GuidesReferenceSamplesLicenseChangelog
GuidesReferenceSamplesLicenseChangelog
  • SDKs
    • Overview
  • REST
  • gRPC
        • UNARYCreateTask
        • UNARYGetTask
        • UNARYQueryTasks
        • UNARYUpdateStatus
        • UNARYCancelTask
        • STREAMListenAsAgent
        • STREAMListenForManualControlFrames
        • STREAMStreamTasks
ContactLearn More
gRPCanduril.taskmanager.v1TaskManagerAPI

UpdateStatus

Example request
1{
2  "status_update": {
3    "version": {
4      "task_id": "example",
5      "definition_version": 42,
6      "status_version": 42
7    },
8    "status": {
9      "status": 0,
10      "task_error": {
11        "code": 0,
12        "message": "example",
13        "error_details": {
14          "type_url": "example",
15          "value": "bytes"
16        }
17      },
18      "progress": {
19        "type_url": "example",
20        "value": "bytes"
21      },
22      "result": {
23        "type_url": "example",
24        "value": "bytes"
25      },
26      "start_time": {
27        "seconds": 42,
28        "nanos": 42
29      },
30      "estimate": {
31        "type_url": "example",
32        "value": "bytes"
33      },
34      "allocation": {
35        "active_agents": [
36          {
37            "entity_id": "example"
38          }
39        ]
40      }
41    },
42    "author": {
43      "agent": {
44        "system": {
45          "service_name": "example",
46          "entity_id": "example",
47          "manages_own_scheduling": true
48        }
49      },
50      "on_behalf_of": {}
51    },
52    "scheduled_time": {
53      "seconds": 42,
54      "nanos": 42
55    }
56  }
57}
Example response
1{
2  "task": {
3    "version": {
4      "task_id": "example",
5      "definition_version": 42,
6      "status_version": 42
7    },
8    "specification": {
9      "type_url": "example",
10      "value": "bytes"
11    },
12    "created_by": {
13      "agent": {
14        "system": {
15          "service_name": "example",
16          "entity_id": "example",
17          "manages_own_scheduling": true
18        }
19      },
20      "on_behalf_of": {}
21    },
22    "last_updated_by": {
23      "agent": {
24        "system": {
25          "service_name": "example",
26          "entity_id": "example",
27          "manages_own_scheduling": true
28        }
29      },
30      "on_behalf_of": {}
31    },
32    "last_update_time": {
33      "seconds": 42,
34      "nanos": 42
35    },
36    "status": {
37      "status": 0,
38      "task_error": {
39        "code": 0,
40        "message": "example",
41        "error_details": {
42          "type_url": "example",
43          "value": "bytes"
44        }
45      },
46      "progress": {
47        "type_url": "example",
48        "value": "bytes"
49      },
50      "result": {
51        "type_url": "example",
52        "value": "bytes"
53      },
54      "start_time": {
55        "seconds": 42,
56        "nanos": 42
57      },
58      "estimate": {
59        "type_url": "example",
60        "value": "bytes"
61      },
62      "allocation": {
63        "active_agents": [
64          {
65            "entity_id": "example"
66          }
67        ]
68      }
69    },
70    "scheduled_time": {
71      "seconds": 42,
72      "nanos": 42
73    },
74    "relations": {
75      "assignee": {
76        "agent": {
77          "system": {
78            "service_name": "example",
79            "entity_id": "example",
80            "manages_own_scheduling": true
81          }
82        },
83        "on_behalf_of": {}
84      },
85      "parent_task_id": "example"
86    },
87    "description": "example",
88    "is_executed_elsewhere": true,
89    "create_time": {
90      "seconds": 42,
91      "nanos": 42
92    },
93    "replication": {
94      "stale_time": {
95        "seconds": 42,
96        "nanos": 42
97      }
98    },
99    "initial_entities": [
100      {
101        "entity": {
102          "entity_id": "example",
103          "description": "example",
104          "is_live": true,
105          "created_time": {
106            "seconds": 42,
107            "nanos": 42
108          },
109          "expiry_time": {
110            "seconds": 42,
111            "nanos": 42
112          },
113          "no_expiry": true,
114          "status": {
115            "platform_activity": "example",
116            "role": "example"
117          },
118          "location": {
119            "position": {
120              "latitude_degrees": 42,
121              "longitude_degrees": 42,
122              "altitude_hae_meters": {
123                "value": 42
124              },
125              "altitude_agl_meters": {
126                "value": 42
127              },
128              "altitude_asf_meters": {
129                "value": 42
130              },
131              "pressure_depth_meters": {
132                "value": 42
133              }
134            },
135            "velocity_enu": {
136              "e": 42,
137              "n": 42,
138              "u": 42
139            },
140            "speed_mps": {
141              "value": 42
142            },
143            "acceleration": {
144              "e": 42,
145              "n": 42,
146              "u": 42
147            },
148            "attitude_enu": {
149              "x": 42,
150              "y": 42,
151              "z": 42,
152              "w": 42
153            }
154          },
155          "location_uncertainty": {
156            "position_enu_cov": {
157              "mxx": 42,
158              "mxy": 42,
159              "mxz": 42,
160              "myy": 42,
161              "myz": 42,
162              "mzz": 42
163            },
164            "velocity_enu_cov": {
165              "mxx": 42,
166              "mxy": 42,
167              "mxz": 42,
168              "myy": 42,
169              "myz": 42,
170              "mzz": 42
171            },
172            "position_error_ellipse": {
173              "probability": {
174                "value": 42
175              },
176              "semi_major_axis_m": {
177                "value": 42
178              },
179              "semi_minor_axis_m": {
180                "value": 42
181              },
182              "orientation_d": {
183                "value": 42
184              }
185            }
186          },
187          "geo_shape": {
188            "shape": {
189              "point": {
190                "position": {
191                  "latitude_degrees": 42,
192                  "longitude_degrees": 42,
193                  "altitude_hae_meters": {
194                    "value": 42
195                  },
196                  "altitude_agl_meters": {
197                    "value": 42
198                  },
199                  "altitude_asf_meters": {
200                    "value": 42
201                  },
202                  "pressure_depth_meters": {
203                    "value": 42
204                  }
205                }
206              }
207            }
208          },
209          "geo_details": {
210            "type_details": {
211              "control_area": {
212                "type": 0
213              }
214            },
215            "type": 0
216          },
217          "aliases": {
218            "alternate_ids": [
219              {
220                "id": "example",
221                "type": 0
222              }
223            ],
224            "name": "example"
225          },
226          "tracked": {
227            "track_quality_wrapper": {
228              "value": 42
229            },
230            "sensor_hits": {
231              "value": 42
232            },
233            "number_of_objects": {
234              "lower_bound": 42,
235              "upper_bound": 42
236            },
237            "radar_cross_section": {
238              "value": 42
239            },
240            "last_measurement_time": {
241              "seconds": 42,
242              "nanos": 42
243            },
244            "line_of_bearing": {
245              "detection_range": {
246                "range_estimate_m": {
247                  "value": {
248                    "value": 42
249                  },
250                  "sigma": {
251                    "value": 42
252                  }
253                }
254              },
255              "angle_of_arrival": {
256                "relative_pose": {
257                  "pos": {
258                    "lon": 42,
259                    "lat": 42,
260                    "alt": 42,
261                    "is2d": true,
262                    "altitude_reference": 0
263                  },
264                  "att_enu": {
265                    "x": 42,
266                    "y": 42,
267                    "z": 42,
268                    "w": 42
269                  }
270                },
271                "bearing_elevation_covariance_rad2": {
272                  "mxx": 42,
273                  "mxy": 42,
274                  "myy": 42
275                }
276              }
277            }
278          },
279          "correlation": {
280            "correlation": {
281              "primary": {
282                "secondary_entity_ids": [
283                  "example"
284                ]
285              }
286            },
287            "membership": {
288              "membership": {
289                "primary": {}
290              },
291              "correlation_set_id": "example",
292              "metadata": {
293                "provenance": {
294                  "integration_name": "example",
295                  "data_type": "example",
296                  "source_id": "example",
297                  "source_update_time": {
298                    "seconds": 42,
299                    "nanos": 42
300                  },
301                  "source_description": "example"
302                },
303                "replication_mode": 0,
304                "type": 0
305              }
306            },
307            "decorrelation": {
308              "all": {
309                "metadata": {
310                  "provenance": {
311                    "integration_name": "example",
312                    "data_type": "example",
313                    "source_id": "example",
314                    "source_update_time": {
315                      "seconds": 42,
316                      "nanos": 42
317                    },
318                    "source_description": "example"
319                  },
320                  "replication_mode": 0,
321                  "type": 0
322                }
323              },
324              "decorrelated_entities": [
325                {
326                  "entity_id": "example",
327                  "metadata": {
328                    "provenance": {
329                      "integration_name": "example",
330                      "data_type": "example",
331                      "source_id": "example",
332                      "source_update_time": {
333                        "seconds": 42,
334                        "nanos": 42
335                      },
336                      "source_description": "example"
337                    },
338                    "replication_mode": 0,
339                    "type": 0
340                  }
341                }
342              ]
343            }
344          },
345          "mil_view": {
346            "disposition": 0,
347            "environment": 0,
348            "nationality": 0
349          },
350          "ontology": {
351            "platform_type": "example",
352            "specific_type": "example",
353            "template": 0
354          },
355          "sensors": {
356            "sensors": [
357              {
358                "sensor_id": "example",
359                "operational_state": 0,
360                "sensor_type": 0,
361                "sensor_description": "example",
362                "rf_configuraton": {
363                  "frequency_range_hz": [
364                    {
365                      "minimum_frequency_hz": {
366                        "frequency_hz": {
367                          "value": {
368                            "value": 42
369                          },
370                          "sigma": {
371                            "value": 42
372                          }
373                        }
374                      },
375                      "maximum_frequency_hz": {
376                        "frequency_hz": {
377                          "value": {
378                            "value": 42
379                          },
380                          "sigma": {
381                            "value": 42
382                          }
383                        }
384                      }
385                    }
386                  ],
387                  "bandwidth_range_hz": [
388                    {
389                      "minimum_bandwidth": {
390                        "bandwidth_hz": {
391                          "value": 42
392                        }
393                      },
394                      "maximum_bandwidth": {
395                        "bandwidth_hz": {
396                          "value": 42
397                        }
398                      }
399                    }
400                  ]
401                },
402                "last_detection_timestamp": {
403                  "seconds": 42,
404                  "nanos": 42
405                },
406                "fields_of_view": [
407                  {
408                    "fov_id": 42,
409                    "mount_id": "example",
410                    "projected_frustum": {
411                      "upper_left": {
412                        "latitude_degrees": 42,
413                        "longitude_degrees": 42,
414                        "altitude_hae_meters": {
415                          "value": 42
416                        },
417                        "altitude_agl_meters": {
418                          "value": 42
419                        },
420                        "altitude_asf_meters": {
421                          "value": 42
422                        },
423                        "pressure_depth_meters": {
424                          "value": 42
425                        }
426                      },
427                      "upper_right": {
428                        "latitude_degrees": 42,
429                        "longitude_degrees": 42,
430                        "altitude_hae_meters": {
431                          "value": 42
432                        },
433                        "altitude_agl_meters": {
434                          "value": 42
435                        },
436                        "altitude_asf_meters": {
437                          "value": 42
438                        },
439                        "pressure_depth_meters": {
440                          "value": 42
441                        }
442                      },
443                      "bottom_right": {
444                        "latitude_degrees": 42,
445                        "longitude_degrees": 42,
446                        "altitude_hae_meters": {
447                          "value": 42
448                        },
449                        "altitude_agl_meters": {
450                          "value": 42
451                        },
452                        "altitude_asf_meters": {
453                          "value": 42
454                        },
455                        "pressure_depth_meters": {
456                          "value": 42
457                        }
458                      },
459                      "bottom_left": {
460                        "latitude_degrees": 42,
461                        "longitude_degrees": 42,
462                        "altitude_hae_meters": {
463                          "value": 42
464                        },
465                        "altitude_agl_meters": {
466                          "value": 42
467                        },
468                        "altitude_asf_meters": {
469                          "value": 42
470                        },
471                        "pressure_depth_meters": {
472                          "value": 42
473                        }
474                      }
475                    },
476                    "projected_center_ray": {
477                      "latitude_degrees": 42,
478                      "longitude_degrees": 42,
479                      "altitude_hae_meters": {
480                        "value": 42
481                      },
482                      "altitude_agl_meters": {
483                        "value": 42
484                      },
485                      "altitude_asf_meters": {
486                        "value": 42
487                      },
488                      "pressure_depth_meters": {
489                        "value": 42
490                      }
491                    },
492                    "center_ray_pose": {
493                      "pos": {
494                        "latitude_degrees": 42,
495                        "longitude_degrees": 42,
496                        "altitude_hae_meters": {
497                          "value": 42
498                        },
499                        "altitude_agl_meters": {
500                          "value": 42
501                        },
502                        "altitude_asf_meters": {
503                          "value": 42
504                        },
505                        "pressure_depth_meters": {
506                          "value": 42
507                        }
508                      },
509                      "orientation": {
510                        "x": 42,
511                        "y": 42,
512                        "z": 42,
513                        "w": 42
514                      }
515                    },
516                    "horizontal_fov": 42,
517                    "vertical_fov": 42,
518                    "range": {
519                      "value": 42
520                    },
521                    "mode": 0
522                  }
523                ]
524              }
525            ]
526          },
527          "payloads": {
528            "payload_configurations": [
529              {
530                "config": {
531                  "capability_id": "example",
532                  "quantity": 42,
533                  "effective_environment": [
534                    0
535                  ],
536                  "payload_operational_state": 0,
537                  "payload_description": "example"
538                }
539              }
540            ]
541          },
542          "power_state": {
543            "source_id_to_state": [
544              null
545            ]
546          },
547          "provenance": {
548            "integration_name": "example",
549            "data_type": "example",
550            "source_id": "example",
551            "source_update_time": {
552              "seconds": 42,
553              "nanos": 42
554            },
555            "source_description": "example"
556          },
557          "overrides": {
558            "override": [
559              {
560                "request_id": "example",
561                "field_path": "example",
562                "masked_field_value": {},
563                "status": 0,
564                "provenance": {
565                  "integration_name": "example",
566                  "data_type": "example",
567                  "source_id": "example",
568                  "source_update_time": {
569                    "seconds": 42,
570                    "nanos": 42
571                  },
572                  "source_description": "example"
573                },
574                "type": 0,
575                "request_timestamp": {
576                  "seconds": 42,
577                  "nanos": 42
578                }
579              }
580            ]
581          },
582          "indicators": {
583            "simulated": {
584              "value": true
585            },
586            "exercise": {
587              "value": true
588            },
589            "emergency": {
590              "value": true
591            },
592            "c2": {
593              "value": true
594            },
595            "egressable": {
596              "value": true
597            },
598            "starred": {
599              "value": true
600            }
601          },
602          "target_priority": {
603            "high_value_target": {
604              "is_high_value_target": true,
605              "target_priority": 42,
606              "target_matches": [
607                {
608                  "high_value_target_list_id": "example",
609                  "high_value_target_description_id": "example"
610                }
611              ],
612              "is_high_payoff_target": true
613            },
614            "threat": {
615              "is_threat": true
616            }
617          },
618          "signal": {
619            "frequency_measurement": {
620              "frequency_center": {
621                "frequency_hz": {
622                  "value": {
623                    "value": 42
624                  },
625                  "sigma": {
626                    "value": 42
627                  }
628                }
629              }
630            },
631            "report": {
632              "line_of_bearing": {
633                "angle_of_arrival": {
634                  "relative_pose": {
635                    "pos": {
636                      "lon": 42,
637                      "lat": 42,
638                      "alt": 42,
639                      "is2d": true,
640                      "altitude_reference": 0
641                    },
642                    "att_enu": {
643                      "x": 42,
644                      "y": 42,
645                      "z": 42,
646                      "w": 42
647                    }
648                  },
649                  "bearing_elevation_covariance_rad2": {
650                    "mxx": 42,
651                    "mxy": 42,
652                    "myy": 42
653                  }
654                },
655                "detection_range": {
656                  "range_estimate_m": {
657                    "value": {
658                      "value": 42
659                    },
660                    "sigma": {
661                      "value": 42
662                    }
663                  }
664                }
665              }
666            },
667            "bandwidth_hz": {
668              "value": 42
669            },
670            "signal_to_noise_ratio": {
671              "value": 42
672            },
673            "emitter_notations": [
674              {
675                "emitter_notation": "example",
676                "confidence": {
677                  "value": 42
678                }
679              }
680            ],
681            "pulse_width_s": {
682              "value": 42
683            },
684            "pulse_repetition_interval": {
685              "pulse_repetition_interval_s": {
686                "value": {
687                  "value": 42
688                },
689                "sigma": {
690                  "value": 42
691                }
692              }
693            },
694            "scan_characteristics": {
695              "scan_type": 0,
696              "scan_period_s": {
697                "value": 42
698              }
699            }
700          },
701          "transponder_codes": {
702            "_mode_c_altitude_ft": {
703              "mode_c_altitude_ft": 42
704            },
705            "mode1": 42,
706            "mode2": 42,
707            "mode3": 42,
708            "mode4_interrogation_response": 0,
709            "mode5": {
710              "mode5_interrogation_response": 0,
711              "mode5": 42,
712              "mode5_platform_id": 42
713            },
714            "mode_s": {
715              "id": "example",
716              "address": 42
717            }
718          },
719          "data_classification": {
720            "default": {
721              "level": 0,
722              "caveats": [
723                "example"
724              ]
725            },
726            "fields": [
727              {
728                "field_path": "example",
729                "classification_information": {
730                  "level": 0,
731                  "caveats": [
732                    "example"
733                  ]
734                }
735              }
736            ]
737          },
738          "task_catalog": {
739            "task_definitions": [
740              {
741                "task_specification_url": "example"
742              }
743            ]
744          },
745          "media": {
746            "media": [
747              {
748                "item_identifier": "example",
749                "type": 0,
750                "relative_path": "example"
751              }
752            ]
753          },
754          "relationships": {
755            "relationships": [
756              {
757                "related_entity_id": "example",
758                "relationship_id": "example",
759                "relationship_type": {
760                  "type": {
761                    "tracked_by": {
762                      "actively_tracking_sensors": {
763                        "sensors": [
764                          {
765                            "sensor_id": "example",
766                            "operational_state": 0,
767                            "sensor_type": 0,
768                            "sensor_description": "example",
769                            "rf_configuraton": {
770                              "frequency_range_hz": [
771                                {
772                                  "minimum_frequency_hz": {
773                                    "frequency_hz": {}
774                                  },
775                                  "maximum_frequency_hz": {
776                                    "frequency_hz": {}
777                                  }
778                                }
779                              ],
780                              "bandwidth_range_hz": [
781                                {
782                                  "minimum_bandwidth": {
783                                    "bandwidth_hz": {}
784                                  },
785                                  "maximum_bandwidth": {
786                                    "bandwidth_hz": {}
787                                  }
788                                }
789                              ]
790                            },
791                            "last_detection_timestamp": {
792                              "seconds": 42,
793                              "nanos": 42
794                            },
795                            "fields_of_view": [
796                              {
797                                "fov_id": 42,
798                                "mount_id": "example",
799                                "projected_frustum": {
800                                  "upper_left": {
801                                    "latitude_degrees": 42,
802                                    "longitude_degrees": 42,
803                                    "altitude_hae_meters": {},
804                                    "altitude_agl_meters": {},
805                                    "altitude_asf_meters": {},
806                                    "pressure_depth_meters": {}
807                                  },
808                                  "upper_right": {
809                                    "latitude_degrees": 42,
810                                    "longitude_degrees": 42,
811                                    "altitude_hae_meters": {},
812                                    "altitude_agl_meters": {},
813                                    "altitude_asf_meters": {},
814                                    "pressure_depth_meters": {}
815                                  },
816                                  "bottom_right": {
817                                    "latitude_degrees": 42,
818                                    "longitude_degrees": 42,
819                                    "altitude_hae_meters": {},
820                                    "altitude_agl_meters": {},
821                                    "altitude_asf_meters": {},
822                                    "pressure_depth_meters": {}
823                                  },
824                                  "bottom_left": {
825                                    "latitude_degrees": 42,
826                                    "longitude_degrees": 42,
827                                    "altitude_hae_meters": {},
828                                    "altitude_agl_meters": {},
829                                    "altitude_asf_meters": {},
830                                    "pressure_depth_meters": {}
831                                  }
832                                },
833                                "projected_center_ray": {
834                                  "latitude_degrees": 42,
835                                  "longitude_degrees": 42,
836                                  "altitude_hae_meters": {
837                                    "value": 42
838                                  },
839                                  "altitude_agl_meters": {
840                                    "value": 42
841                                  },
842                                  "altitude_asf_meters": {
843                                    "value": 42
844                                  },
845                                  "pressure_depth_meters": {
846                                    "value": 42
847                                  }
848                                },
849                                "center_ray_pose": {
850                                  "pos": {
851                                    "latitude_degrees": 42,
852                                    "longitude_degrees": 42,
853                                    "altitude_hae_meters": {},
854                                    "altitude_agl_meters": {},
855                                    "altitude_asf_meters": {},
856                                    "pressure_depth_meters": {}
857                                  },
858                                  "orientation": {
859                                    "x": 42,
860                                    "y": 42,
861                                    "z": 42,
862                                    "w": 42
863                                  }
864                                },
865                                "horizontal_fov": 42,
866                                "vertical_fov": 42,
867                                "range": {
868                                  "value": 42
869                                },
870                                "mode": 0
871                              }
872                            ]
873                          }
874                        ]
875                      },
876                      "last_measurement_timestamp": {
877                        "seconds": 42,
878                        "nanos": 42
879                      }
880                    }
881                  }
882                }
883              }
884            ]
885          },
886          "visual_details": {
887            "range_rings": {
888              "min_distance_m": {
889                "value": 42
890              },
891              "max_distance_m": {
892                "value": 42
893              },
894              "ring_count": 42,
895              "ring_line_color": {
896                "red": 42,
897                "green": 42,
898                "blue": 42,
899                "alpha": {
900                  "value": 42
901                }
902              }
903            }
904          },
905          "dimensions": {
906            "length_m": 42
907          },
908          "route_details": {
909            "destination_name": "example",
910            "estimated_arrival_time": {
911              "seconds": 42,
912              "nanos": 42
913            }
914          },
915          "schedules": {
916            "schedules": [
917              {
918                "windows": [
919                  {
920                    "cron_expression": "example",
921                    "duration_millis": 42
922                  }
923                ],
924                "schedule_id": "example",
925                "schedule_type": 0
926              }
927            ]
928          },
929          "health": {
930            "connection_status": 0,
931            "health_status": 0,
932            "components": [
933              {
934                "id": "example",
935                "name": "example",
936                "health": 0,
937                "messages": [
938                  {
939                    "status": 0,
940                    "message": "example"
941                  }
942                ],
943                "update_time": {
944                  "seconds": 42,
945                  "nanos": 42
946                }
947              }
948            ],
949            "update_time": {
950              "seconds": 42,
951              "nanos": 42
952            },
953            "active_alerts": [
954              {
955                "alert_code": "example",
956                "description": "example",
957                "level": 0,
958                "activated_time": {
959                  "seconds": 42,
960                  "nanos": 42
961                },
962                "active_conditions": [
963                  {
964                    "condition_code": "example",
965                    "description": "example"
966                  }
967                ]
968              }
969            ]
970          },
971          "group_details": {
972            "group_type": {
973              "team": {}
974            }
975          },
976          "supplies": {
977            "munitions": [
978              {
979                "munition_id": "example",
980                "name": "example",
981                "quantity_units": 42
982              }
983            ],
984            "fuel": [
985              {
986                "fuel_id": "example",
987                "name": "example",
988                "reported_date": {
989                  "seconds": 42,
990                  "nanos": 42
991                },
992                "amount_gallons": 42,
993                "max_authorized_capacity_gallons": 42,
994                "operational_requirement_gallons": 42,
995                "data_classification": {
996                  "default": {
997                    "level": 0,
998                    "caveats": [
999                      "example"
1000                    ]
1001                  },
1002                  "fields": [
1003                    {
1004                      "field_path": "example",
1005                      "classification_information": {
1006                        "level": 0,
1007                        "caveats": [
1008                          "example"
1009                        ]
1010                      }
1011                    }
1012                  ]
1013                },
1014                "data_source": "example"
1015              }
1016            ]
1017          },
1018          "orbit": {
1019            "orbit_mean_elements": {
1020              "metadata": {
1021                "creation_date": {
1022                  "seconds": 42,
1023                  "nanos": 42
1024                },
1025                "originator": {
1026                  "value": "example"
1027                },
1028                "message_id": {
1029                  "value": "example"
1030                },
1031                "ref_frame": 0,
1032                "ref_frame_epoch": {
1033                  "seconds": 42,
1034                  "nanos": 42
1035                },
1036                "mean_element_theory": 0
1037              },
1038              "mean_keplerian_elements": {
1039                "line2_field8": {
1040                  "semi_major_axis_km": 42
1041                },
1042                "epoch": {
1043                  "seconds": 42,
1044                  "nanos": 42
1045                },
1046                "eccentricity": 42,
1047                "inclination_deg": 42,
1048                "ra_of_asc_node_deg": 42,
1049                "arg_of_pericenter_deg": 42,
1050                "mean_anomaly_deg": 42,
1051                "gm": {
1052                  "value": 42
1053                }
1054              },
1055              "tle_parameters": {
1056                "line1_field11": {
1057                  "bstar": 42
1058                },
1059                "line1_field10": {
1060                  "mean_motion_ddot": 42
1061                },
1062                "ephemeris_type": {
1063                  "value": 42
1064                },
1065                "classification_type": {
1066                  "value": "example"
1067                },
1068                "norad_cat_id": {
1069                  "value": 42
1070                },
1071                "element_set_no": {
1072                  "value": 42
1073                },
1074                "rev_at_epoch": {
1075                  "value": 42
1076                },
1077                "mean_motion_dot": {
1078                  "value": 42
1079                }
1080              }
1081            }
1082          },
1083          "symbology": {
1084            "standard": {
1085              "mil_std_2525_c": {
1086                "sidc": "example"
1087              }
1088            }
1089          }
1090        },
1091        "snapshot": true
1092      }
1093    ],
1094    "owner": {
1095      "entity_id": "example"
1096    },
1097    "retry_strategy": {
1098      "strategy": {
1099        "fixed_retry_strategy": {
1100          "retry_interval": {
1101            "seconds": 42,
1102            "nanos": 42
1103          }
1104        }
1105      }
1106    },
1107    "delivery_state": {
1108      "status": 0,
1109      "error": {
1110        "code": 0,
1111        "message": "example"
1112      },
1113      "delivery_constraints": {
1114        "deliver_after": {
1115          "seconds": 42,
1116          "nanos": 42
1117        },
1118        "deliver_before": {
1119          "seconds": 42,
1120          "nanos": 42
1121        }
1122      }
1123    },
1124    "display_name": "example"
1125  }
1126}
Updates the status of a Task as it progresses through its lifecycle. This method allows agents or operators to report the current state of a task, which could include changes to task status and error information. Each status update increments the task's status_version. When updating status, clients must provide the current version to ensure consistency. The system rejects updates with mismatched versions to prevent race conditions. Terminal states (`STATUS_DONE_OK` and `STATUS_DONE_NOT_OK`) are permanent; once a task reaches these states, no further updates are allowed.
Was this page helpful?
Previous

CancelTask

Next

Updates the status of a Task as it progresses through its lifecycle.

This method allows agents or operators to report the current state of a task, which could include changes to task status and error information.

Each status update increments the task’s status_version. When updating status, clients must provide the current version to ensure consistency. The system rejects updates with mismatched versions to prevent race conditions.

Terminal states (STATUS_DONE_OK and STATUS_DONE_NOT_OK) are permanent; once a task reaches these states, no further updates are allowed.

UpdateStatusRequest

Request
This endpoint expects an object.
status_updateobject
The updated status.

UpdateStatusResponse

Response
This endpoint returns an object.
taskobject
The updated Task.