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

QueryTasks

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

UpdateStatus

Next

Searches for Tasks that match specified filtering criteria and returns matching tasks in paginated form.

This method allows filtering tasks based on multiple criteria including:

  • Parent task relationships
  • Task status (with inclusive or exclusive filtering)
  • Update time ranges
  • Task view (manager or agent perspective)
  • Task assignee
  • Task type (via exact URL matches or prefix matching)

Results are returned in pages. When more results are available than can be returned in a single response, a page_token is provided that can be used in subsequent requests to retrieve the next set of results.

By default, this returns the latest task version for each matching task from the manager’s perspective.

QueryTasksRequest

Request
This endpoint expects an object.
task_typeobject or string
parent_task_idstring
If present matches Tasks with this parent Task ID. This is mutually exclusive with all other query parameters, i.e., either provide parent Task ID, or any of the remaining parameters, but not both.
page_tokenstring
If set, returns results starting from the given page token.
status_filterobject
Filters on provided status types in the filter.
update_time_rangeobject
If provided, only provides Tasks updated within the time range.
viewenum

The filter for view of a Task. If not set, defaults to TASK_VIEW_MANAGER.

Allowed values:
assigneeobject
If provided, returns Tasks that match this assignee.

QueryTasksResponse

Response
This endpoint returns an object.
taskslist of objects
Tasks matching the Query Task request.
page_tokenstring
Page token to the next page of Tasks.