GetEntity

Example request

1 {
2   "entity_id": "example"
3 }

Example response

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

Get an entity using its entityId.

GetEntityRequest

Request

This endpoint expects an object.

entity_idstring

The GUID of this entity to query.

GetEntityResponse

Response

This endpoint returns an object.

entityobject

An Entity object that corresponds with the requested entityId.