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

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.