Repository navigation
Expand file tree
/
Copy pathswagger.v2.yaml
More file actions
1022 lines (1012 loc) · 29.3 KB
/
Copy pathswagger.v2.yaml
File metadata and controls
1022 lines (1012 loc) · 29.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
swagger: '2.0'
################################################################################
# API Information
################################################################################
info:
title: GRiD API v2
description: |
This is the API v2 specification for the Geospatial Repository and
Data Management System (aka GRiD).
All calls require basic authentication. They also require an API key
(passed as the parameter `source`). API keys can be generated by visiting
https://rsgis.erdc.dren.mil/te_ba/api/source/list/.
Unless otherwise noted, successful calls will return an HTTP status code
`200` with the appropriate response body. Server-side errors will return an
HTTP status code `5xx` with a JSON encoded error message, while client-side
errors will return an HTTP status code `4xx` with a JSON encoded error
message.
# Changes from v1
Changes to the API endpoints from v1 to v2 are relatively minor. We have
added the ability to edit and delete both AOIs and Exports. You can also
query point cloud and raster products (previously called collects) for
additional file details.
Point cloud and raster generation endpoints have changed the most, now
providing more control over the export generation process with additional,
optional parameters. Some of the parameters have also had name changes.
Finally, the generation response now includes both a `task_id` to monitor
status as well as the `export_id` for the resulting export.
The bulk of the API changes will be found in the JSON-encoded responses,
where we strove for more consistent naming of common fields and a flatter
structure to the overall content, while increasing the amount of information
provided to the user.
Finally, beginning with v2, we have begun to manage the API specification
using Swagger v2.0 (http://swagger.io/). The Swagger file can be used by a
number of tools to explore the API. We like to use Postman
(https://www.getpostman.com/), which can directly import Swagger files.
version: "2.0.0"
contact:
name: GRiD Support
email: GRiD.Core.Team@erdc.dren.mil
################################################################################
# Other root-level fixed fields
################################################################################
host: rsgis.erdc.dren.mil
schemes:
- https
securityDefinitions:
grid_auth:
type: basic
security:
- grid_auth: []
basePath: /te_ba/api/v2
produces:
- application/json
tags:
- name: AOI
description: AOI resources.
- name: Export
description: Export resources.
- name: Product
description: Product resources.
- name: Geoname
description: Lookup geoname.
- name: Task
description: Task resources.
################################################################################
# Paths
################################################################################
paths:
/aoi:
get:
tags:
- AOI
summary: Get a User's AOI List
description: |
Get a list of the AOIs created by or shared with the current GRiD user.
parameters:
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
- name: geom
in: query
description: A WKT geometry used to filter AOI results.
required: false
type: string
responses:
200:
description: An array of AOIs.
schema:
$ref: '#/definitions/AOIArray'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/aoi/add:
get:
tags:
- AOI
summary: Add AOI
description: |
Create a new AOI for the given geometry.
parameters:
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
- name: name
in: query
description: The name for the AOI.
required: true
type: string
- name: geom
in: query
description: A WKT geometry describing the AOI.
required: true
type: string
- name: subscribe
in: query
description: |
True, False, T, F, 1, or 0. Default value is false.
default: false
required: false
type: boolean
responses:
200:
description: An AOI object.
schema:
$ref: '#/definitions/AOIDetail'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/aoi/{pk}:
get:
tags:
- AOI
summary: AOI Detail
description: |
Get information for a single AOI.
parameters:
- name: pk
in: path
description: The primary key for the AOI.
required: true
type: integer
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
responses:
200:
description: An AOI object.
schema:
$ref: '#/definitions/AOIDetail'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/aoi/edit/{pk}:
get:
tags:
- AOI
summary: Edit AOI
description: |
Update an AOIs name, notes, or geometry. In order to change an AOI's
geometry, it must contain 0 generated exports.
parameters:
- name: pk
in: path
description: The primary key of the AOI.
required: true
type: integer
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
- name: name
in: query
description: The name for the AOI.
required: false
type: string
- name: geom
in: query
description: A WKT geometry describing the AOI.
required: false
type: string
- name: notes
in: query
description: The notes for the AOI.
required: false
type: string
responses:
200:
description: An AOI object.
schema:
$ref: '#/definitions/AOIDetail'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/aoi/delete/{pk}:
get:
tags:
- AOI
summary: Delete AOI
description: Delete an existing AOI.
parameters:
- name: pk
in: path
description: The primary key of the AOI.
required: true
type: integer
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
responses:
200:
description: Succesful AOI deletion responds with an empty body.
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/aoi/{pk}/generate/pointcloud:
get:
tags:
- AOI
summary: Generate Pointcloud Export
description: |
Generate pointcloud export for the given AOI and collect primary keys.
parameters:
- name: pk
in: path
description: The primary key for the AOI.
required: true
type: integer
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
- name: products
in: query
description: |
A list of product primary keys to include in the export, separated
by + or ,.
required: true
type: string
- name: name
in: query
description: An optional name for the export.
required: false
type: string
- name: intensity
in: query
description: Whether or not to export intensity. Default is true.
default: true
required: false
type: boolean
- name: dim_classification
in: query
description: Whether or not to export classification. Default is true.
default: true
required: false
type: boolean
- name: hsrs
in: query
description: Accepts an EPSG code. Defaults to AOI SRS.
required: false
type: string
- name: file_export_options
in: query
description: |
Determine file merging strategy. Accepts individual and collect.
Default is individual.
required: false
type: string
- name: file_export_format
in: query
description: |
Determine the format of the output file. Valid values are las12,
las14, nitf, pdf, and bpf3. Default is las12.
required: false
type: string
- name: compressed
in: query
description: |
Whether or not to export compressed data. Default is true.
default: true
required: false
type: boolean
- name: send_email
in: query
description: |
Whether or not to notify user via email upon completion. Default is
false.
default: false
required: false
type: boolean
- name: generate_dem
in: query
description: |
Whether or not to generate a DEM from the pointcloud. Default is
false.
default: false
required: false
type: boolean
- name: cell_spacing
in: query
description: |
Used together with generate_dem. Default is 1.0. Ignored for
raster types.
required: false
type: number
format: float
- name: pcl_terrain
in: query
description: |
Used to trigger a PMF Bare Earth export. Accepts ubran, suburban,
mountainous, and foliated. Default is none. Cannot be used with
sri_hres option.
required: false
type: string
- name: sri_hres
in: query
description: |
Used to trigger a Sarnoff Bare Earth export. Accepts the horizontal
resolution. Default is none. Cannot be used with pcl_terrain option.
required: false
type: number
format: float
- name: decimation_radius
in: query
description: |
The minimum distance between points. If a neighboring point is
found within this radius, it will be discarded. Uses PDAL
decimation filter. Default is none.
required: false
type: number
format: float
- name: retile_size
in: query
description: |
How many points to fit into each tile. The number of points in each
tile will not exceed this value, and will sometimes be less than
it. Uses PDAL chipper filter. Cannot be used with retile_area
option. Default is none.
required: false
type: integer
- name: retile_area
in: query
description: |
The target length of generated tiles. Units determined by source
data. Uses PDAL splitter filter. Cannot be used with retile_size
option. Default is none.
required: false
type: number
format: float
responses:
200:
description: A generate export object.
schema:
$ref: '#/definitions/GenerateExport'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/aoi/{pk}/generate/raster:
get:
tags:
- AOI
summary: Generate Raster Export
description: |
Generate raster export for the given AOI and collect primary keys.
parameters:
- name: pk
in: path
description: The primary key for the AOI.
required: true
type: integer
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
- name: products
in: query
description: |
A list of product primary keys to include in the export, separated
by + or ,.
required: true
type: string
- name: name
in: query
description: An optional name for the export.
required: false
type: string
- name: intensity
in: query
description: Whether or not to export intensity. Default is true.
default: true
required: false
type: boolean
- name: dim_classification
in: query
description: Whether or not to export classification. Default is true.
default: true
required: false
type: boolean
- name: hsrs
in: query
description: Accepts an EPSG code. Defaults to AOI SRS.
required: false
type: string
- name: file_export_options
in: query
description: |
Determine file merging strategy. Accepts individual and collect.
Default is individual.
required: false
type: string
- name: file_export_format
in: query
description: |
Determine the format of the output file. Valid values are GTiff and
NITF. Default is GTiff.
required: false
type: string
- name: compressed
in: query
description: |
Whether or not to export compressed data. Default is true.
default: true
required: false
type: boolean
- name: send_email
in: query
description: |
Whether or not to notify user via email upon completion. Default is
false.
default: false
required: false
type: boolean
responses:
200:
description: A generate export object.
schema:
$ref: '#/definitions/GenerateExport'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/export/{pk}:
get:
tags:
- Export
summary: Get export details.
description: Get information for a single export.
parameters:
- name: pk
in: path
description: The primary key of the AOI.
required: true
type: integer
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
responses:
200:
description: An export object.
schema:
$ref: '#/definitions/ExportDetail'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/export/edit/{pk}:
get:
tags:
- Export
summary: Edit export
description: Updates an exports name or notes.
parameters:
- name: pk
in: path
description: The primary key of the export.
required: true
type: integer
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
- name: name
in: query
description: The name for the export.
required: false
type: string
- name: notes
in: query
description: The notes for the export.
required: false
type: string
responses:
200:
description: An export object.
schema:
$ref: '#/definitions/ExportDetail'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/export/delete/{pk}:
get:
tags:
- Export
summary: Delete export
description: Deletes an existing export.
parameters:
- name: pk
in: path
description: The primary key of the export.
required: true
type: integer
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
responses:
200:
description: Succesful export deletion responds with an empty body.
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/product/{pk}:
get:
tags:
- Product
summary: Get product details
description: Get information for a single product (pointcloud or raster).
parameters:
- name: pk
in: path
description: The primary key of the product.
required: true
type: integer
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
responses:
200:
description: A product (pointcloud or raster) object.
schema:
$ref: '#/definitions/ProductJSON'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/geoname:
get:
tags:
- Geoname
summary: Lookup Geoname
description: |
Get suggested AOI name based on geographic coordinates of the geometry.
parameters:
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
- name: geom
in: query
description: A WKT geometry describing the AOI.
required: true
type: string
responses:
200:
description: A geoname object.
schema:
type: object
properties:
geom:
type: string
description: The WKT geometry describing the AOI.
name:
type: string
description: The suggested name for the given geometry.
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
/task/{task_id}:
get:
tags:
- Task
summary: Get task details
description: Get task status/details for the provided task_id.
parameters:
- name: task_id
in: path
description: The ID of the task.
required: true
type: string
- name: source
in: query
description: Your GRiD generated API key.
required: true
type: string
responses:
200:
description: A task object.
schema:
$ref: '#/definitions/Task'
default:
description: Unexpected error
schema:
$ref: '#/definitions/Error'
definitions:
AOIArray:
type: object
properties:
aoi_list:
type: array
items:
$ref: '#/definitions/AOIList'
description: A list of AOIs.
AOIDetail:
type: object
properties:
name:
$ref: '#/definitions/Name'
created_at:
$ref: '#/definitions/CreatedAt'
is_active:
type: boolean
description: Whether or not the AOI is active.
source:
type: string
description: Source of the AOI (e.g., map, api).
user:
$ref: '#/definitions/User'
geometry:
type: string
description: The WKT geometry of the AOI.
notes:
$ref: '#/definitions/Notes'
pk:
$ref: '#/definitions/Pk'
export_set:
type: array
items:
$ref: '#/definitions/Export'
description: The exports of the AOI.
pointcloud_intersects:
type: array
items:
$ref: '#/definitions/PointcloudDatasetSimple'
description: The pointcloud products for the AOI.
raster_intersects:
type: array
items:
$ref: '#/definitions/RasterDatasetSimple'
description: The raster products for the AOI.
AOIList:
type: object
properties:
name:
$ref: '#/definitions/Name'
created_at:
$ref: '#/definitions/CreatedAt'
is_active:
type: boolean
description: Whether or not the AOI is active.
source:
type: string
description: Source of the AOI (e.g., map, api).
user:
$ref: '#/definitions/User'
geometry:
type: string
description: The WKT geometry of the AOI.
notes:
$ref: '#/definitions/Notes'
pk:
$ref: '#/definitions/Pk'
Area:
type: number
format: float
description: The area of the geometry in sq_km.
CellSpacing:
type: number
format: float
description: The cell spacing used in DEM generation, if applicable.
Classification:
type: string
description: The classifications selected for the export.
CollectedAt:
type: string
format: date-time
description: The date of collection. ISO 8601 format as UTC.
PercentCoverage:
type: number
format: float
description: |
The percent of the product area covered by the AOI. Only available in AOI
detail.
CreatedAt:
type: string
format: date-time
description: The date of AOI creation. ISO 8601 format as UTC.
Datatype:
type: string
description: The datatype (e.g., LAS 1.2, DTM).
DimClassification:
type: boolean
description: |
Whether or not Classification dimension is included in exported data.
Error:
type: object
properties:
error:
type: string
description: Description of the error from the given API request.
Export:
type: object
properties:
datatype:
$ref: '#/definitions/Datatype'
user:
$ref: '#/definitions/User'
hsrs:
$ref: '#/definitions/HSRS'
name:
$ref: '#/definitions/Name'
pk:
$ref: '#/definitions/Pk'
started_at:
$ref: '#/definitions/StartedAt'
status:
$ref: '#/definitions/Status'
url:
$ref: '#/definitions/URL'
ExportDetail:
type: object
properties:
datatype:
$ref: '#/definitions/Datatype'
user:
$ref: '#/definitions/User'
hsrs:
$ref: '#/definitions/HSRS'
name:
$ref: '#/definitions/Name'
pk:
$ref: '#/definitions/Pk'
started_at:
$ref: '#/definitions/StartedAt'
status:
$ref: '#/definitions/Status'
url:
$ref: '#/definitions/URL'
rgb:
$ref: '#/definitions/RGB'
intensity:
$ref: '#/definitions/Intensity'
dim_classification:
$ref: '#/definitions/DimClassification'
file_export_options:
$ref: '#/definitions/FileExportOptions'
generate_dem:
$ref: '#/definitions/GenerateDEM'
cell_spacing:
$ref: '#/definitions/CellSpacing'
notes:
$ref: '#/definitions/Notes'
classification:
$ref: '#/definitions/Classification'
pcl_terrain:
$ref: '#/definitions/PCLTerrain'
sri_hres:
$ref: '#/definitions/SRIHRES'
exportfiles:
$ref: '#/definitions/Exportfiles'
tda_set:
$ref: '#/definitions/TDASet'
task_id:
$ref: '#/definitions/TaskID'
Exportfile:
type: object
properties:
datatype:
$ref: '#/definitions/Datatype'
name:
$ref: '#/definitions/Name'
pk:
$ref: '#/definitions/Pk'
url:
$ref: '#/definitions/URL'
Exportfiles:
type: array
items:
$ref: '#/definitions/Exportfile'
description: The export files of the export.
FileExportOptions:
type: string
description: |
The file export options used (e.g., individual, collect, super).
Filesize:
type: integer
description: The size of the product on the filesystem in bytes.
GenerateDEM:
type: boolean
description: Whether or not this was a generated DEM from pointcloud.
GenerateExport:
type: object
properties:
export_id:
type: integer
description: The ID of the resulting export.
task_id:
type: string
description: The ID of the task.
Geometry:
type: string
description: |
The WKT geometry of the product. Only available in product detail.
HSRS:
type: string
description: The horizontal spatial reference system EPSG code.
Intensity:
type: boolean
description: |
Whether or not Intensity dimension is included in exported data.
Name:
type: string
description: The name of the export.
Notes:
type: string
description: User notes.
PCLTerrain:
type: string
description: The PCL terrain option of the export.
Pk:
type: integer
description: The primary key of the product.
ProductJSON:
type: object
properties:
datatype:
$ref: '#/definitions/Datatype'
name:
$ref: '#/definitions/Name'
pk:
$ref: '#/definitions/Pk'
sensor:
$ref: '#/definitions/Sensor'
collected_at:
$ref: '#/definitions/CollectedAt'
classification:
$ref: '#/definitions/SecurityClassification'
area:
$ref: '#/definitions/Area'
filesize:
$ref: '#/definitions/Filesize'
point_count:
type: integer
description: The total number of points in the product (pointcloud products only).
density:
type: number
format: float
description: The average point density of the product (pointcloud products only).
percent_coverage:
$ref: '#/definitions/PercentCoverage'
geometry:
$ref: '#/definitions/Geometry'
PointcloudDatasetSimple:
type: object
description: |
The simplified point cloud product object lacks the geometry. This is only
calculated when point cloud products are queried via the
`/pointcloud/{pk}` endpoint.
properties:
datatype:
$ref: '#/definitions/Datatype'
name:
$ref: '#/definitions/Name'
pk:
$ref: '#/definitions/Pk'
sensor:
$ref: '#/definitions/Sensor'
collected_at:
$ref: '#/definitions/CollectedAt'
classification:
$ref: '#/definitions/SecurityClassification'
area:
$ref: '#/definitions/Area'
filesize:
$ref: '#/definitions/Filesize'
point_count:
type: integer
description: The total number of points in the product.
density:
type: number
format: float
description: The average point density of the product.
percent_coverage:
$ref: '#/definitions/PercentCoverage'
RasterDatasetSimple:
type: object
properties:
datatype:
$ref: '#/definitions/Datatype'
name:
$ref: '#/definitions/Name'
pk:
$ref: '#/definitions/Pk'
sensor:
$ref: '#/definitions/Sensor'
collected_at:
$ref: '#/definitions/CollectedAt'
classification:
$ref: '#/definitions/SecurityClassification'
area:
$ref: '#/definitions/Area'
filesize:
$ref: '#/definitions/Filesize'
percent_coverage:
$ref: '#/definitions/PercentCoverage'
RGB:
type: boolean
description: Whether or not RGB dimension is included in exported data.
SecurityClassification:
type: string
description: The security classification.
Sensor:
type: string
description: The sensor used to make the collection.
SRIHRES:
type: number
format: float
description: The sri_hres value of the export.
StartedAt:
type: string
format: date-time
description: Time of creation for the AOI. ISO 8601 format as UTC.
Status:
type: string
description: The status of the export (e.g., SUCCESS, FAILED, QUEUED).
Task:
type: object
properties:
task_traceback:
type: string
description: The description of any failures if they occurred.
task_state:
type: string
description: The state of the task (e.g., SUCCESS, FAILED, QUEUED).
task_tstamp:
type: string
format: date-time
description: ISO 8601 format as UTC.
task_name:
type: string
description: The name of the task (e.g., export.tasks.generate_export).
task_id:
type: string
description: The ID of the task.
TaskID:
type: string
description: The ID of the associated task used for generation.
TDA:
type: object
properties:
created_at:
$ref: '#/definitions/CreatedAt'
name:
$ref: '#/definitions/Name'