-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathactinia_swagger.json
More file actions
14709 lines (14709 loc) · 497 KB
/
actinia_swagger.json
File metadata and controls
14709 lines (14709 loc) · 497 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",
"info": {
"title": "Actinia",
"description": "\n================================\nActinia - The GRASS GIS REST API\n================================\n\n**Actinia** is an open source REST API for scalable, distributed, high\nperformance processing of geographical data that uses GRASS GIS for\ncomputational tasks.\n\nIt provides a REST API to process satellite images, time series of satellite\nimages, arbitrary raster data with geographical relations and vector data.\n\nThe REST interface allows to access, manage and manipulate the GRASS GIS\ndatabase via HTTP GET,PUT,POST and DELETE requests and to process raster,\nvector and time series data located in a persistent GRASS GIS database.\n**Actinia** allows the processing of cloud based data, for example all Landsat\n4-8 scenes as well as all Sentinel2A scenes in an ephemeral databases. The\ncomputational results of ephemeral processing are available via object storage\nas GeoTIFF files.\n\nThe full API documentation is available here:\nhttps://redocly.github.io/redoc/?url=https://actinia.mundialis.de/latest/\nswagger.json\n\n\nExamples:\n---------\n\nTo execute the examples, first setup login information, IP address and port:\n\n export ACTINIA_URL=https://actinia.mundialis.de/latest\n export AUTH='-u demouser:gu3st!pa55w0rd'\n\n**Data management**\n\n- List all locations that are available in the actinia persistent database:\n\n curl ${AUTH} -X GET \"${ACTINIA_URL}/locations\"\n\n- List all mapsets in the location latlong_wgs84:\n\n curl ${AUTH} -X GET \"${ACTINIA_URL}/locations/latlong_wgs84/mapsets\"\n\n- List all raster layers in location latlong_wgs84 and mapset Sentinel2A\n\n curl ${AUTH} -X GET \"${ACTINIA_URL}/locations/latlong_wgs84/mapsets/Sentinel2A/raster_layers\"\n\n- List all space-time raster datasets (STRDS) in location ECAD and mapset\n PERMANENT:\n\n curl ${AUTH} -X GET \"${ACTINIA_URL}/locations/ECAD/mapsets/PERMANENT/raster_layers\"\n\n- List all raster map layers of the STRDS precipitation_1950_2013_yearly_mm:\n\n curl ${AUTH} -X GET \"${ACTINIA_URL}/locations/ECAD/mapsets/PERMANENT/strds/precipitation_ 1950_2013_yearly_mm/raster_layers\"\n\n**Landsat and Sentinel2A NDVI computation**\n\nThis API call will compute the NDVI of the top of atmosphere (TOAR)\ncorrected Landsat4 scene LC80440342016259LGN00:\n\n curl ${AUTH} -X POST \"${ACTINIA_URL}/landsat_process/ LC80440342016259LGN00/TOAR/NDVI\"\n\nNDVI computation of Sentinel2A scene\nS2A_MSIL1C_20170212T104141_N0204_R008_T31TGJ_20170212T104138:\n\n curl ${AUTH} -X POST \"${ACTINIA_URL}/sentinel2_process/ndvi/ S2A_MSIL1C_20170212T104141_N0204_R008_T31TGJ_20170212T104138\"\n\nThe results of the asynchronous computations are available as GeoTIFF file in\na cloud storage for download.\n",
"termsOfService": "",
"version": "v3"
},
"schemes": [
"https"
],
"consumes": [
"application/gml+xml",
"application/json"
],
"paths": {
"/actinia_modules": {
"get": {
"tags": [
"Module Viewer"
],
"description": "Get a list of modules. Minimum required user role: user.",
"parameters": [
{
"in": "query",
"name": "tag",
"type": "string",
"description": "Filter for categories"
},
{
"in": "query",
"name": "category",
"type": "string",
"description": "Another filter for categories"
},
{
"in": "query",
"name": "family",
"type": "string",
"description": "Type of GRASS GIS module",
"enum": [
"d",
"db",
"g",
"i",
"m",
"ps",
"r",
"r3",
"t",
"test",
"v"
]
},
{
"in": "query",
"name": "record",
"type": "string",
"description": "If set to 'full', all information about the returned modules are given like in the single module description. Depending on active cache, this response might run into a timeout. A filter can prevent this."
}
],
"responses": {
"200": {
"description": "This response returns a list of module names and the status.",
"schema": {
"$ref": "#/definitions/ModuleList"
}
},
"400": {
"description": "The error message and a detailed log why listing of modules did not succeeded",
"schema": {
"$ref": "#/definitions/SimpleStatusCodeResponseModel"
}
}
},
"summary": "Get a list of all actinia modules (process chain templates)."
}
},
"/actinia_modules/{actiniamodule}": {
"get": {
"tags": [
"Module Viewer"
],
"parameters": [
{
"in": "path",
"name": "actiniamodule",
"type": "string",
"description": "The name of a module",
"required": true
}
],
"description": "Get the description of a module. Minimum required user role: user.Can be also used to reload cache for a certain modulefor the full module description in listModules.",
"responses": {
"200": {
"description": "This response returns a description of a module.",
"schema": {
"$ref": "#/definitions/Module"
}
},
"400": {
"description": "The error message and a detailed log why describing modules did not succeeded",
"schema": {
"$ref": "#/definitions/SimpleStatusCodeResponseModel"
}
}
},
"summary": "Describe an actinia module (process chain template)."
}
},
"/actinia_templates": {
"get": {
"tags": [
"Process Chain Template Management"
],
"description": "Get a list of process chain templates. Minimum required user role: user.",
"responses": {
"200": {
"description": "This response returns a list of module names"
}
},
"summary": "Get a list of all actinia templates (process chain templates)."
},
"post": {
"tags": [
"Process Chain Template Management"
],
"description": "Create a process chain template. Minimum required user role: user.",
"parameters": [
{
"in": "body",
"name": "template",
"schema": {
"$ref": "#/definitions/ProcessChainTemplate"
},
"description": "The process chain template",
"required": true
}
],
"responses": {
"201": {
"description": "This response returns True if creation was successfull."
},
"404": {
"description": "The error message and a detailed log why creation did not succeeded",
"schema": {
"$ref": "#/definitions/SimpleStatusCodeResponseModel"
}
}
},
"summary": "Create an actinia template (process chain template)."
}
},
"/actinia_templates/{template_id}": {
"put": {
"tags": [
"Process Chain Template Management"
],
"parameters": [
{
"in": "path",
"name": "template_id",
"type": "string",
"description": "The name of a process chain template",
"required": true
}
],
"description": "Update a process chain template. Minimum required user role: user.",
"responses": {
"201": {
"description": "This response returns True if update was successfull."
},
"404": {
"description": "The error message and a detailed log why update did not succeeded",
"schema": {
"$ref": "#/definitions/SimpleStatusCodeResponseModel"
}
}
},
"summary": "Update an actinia template (process chain template)."
},
"get": {
"tags": [
"Process Chain Template Management"
],
"parameters": [
{
"in": "path",
"name": "template_id",
"type": "string",
"description": "The name of a process chain template",
"required": true
}
],
"description": "Read a process chain template. Minimum required user role: user.",
"responses": {
"200": {
"description": "This response returns a process chain template.",
"schema": {
"$ref": "#/definitions/ProcessChainTemplate"
}
},
"404": {
"description": "The error message and a detailed log why describing did not succeeded",
"schema": {
"$ref": "#/definitions/SimpleStatusCodeResponseModel"
}
}
},
"summary": "Read an actinia template (process chain template)."
},
"delete": {
"tags": [
"Process Chain Template Management"
],
"parameters": [
{
"in": "path",
"name": "template_id",
"type": "string",
"description": "The name of a process chain template",
"required": true
}
],
"description": "Delete a process chain template. Minimum required user role: user.",
"responses": {
"200": {
"description": "This response returns True if deletion was successfull."
},
"404": {
"description": "The error message and a detailed log why deletion did not succeeded",
"schema": {
"$ref": "#/definitions/SimpleStatusCodeResponseModel"
}
}
},
"summary": "Delete an actinia template (process chain template)."
}
},
"/api_key": {
"get": {
"tags": [
"Authentication Management"
],
"description": "Create an API key for permanent authentication. API keys have no expiration time. Minimum required user role: admin.",
"responses": {
"200": {
"description": "The API key generation response",
"schema": {
"$ref": "#/definitions/TokenResponseModel"
}
},
"400": {
"description": "The error message in case of failure",
"schema": {
"$ref": "#/definitions/TokenResponseModel"
}
}
},
"summary": "Create an API key for permanent authentication."
}
},
"/api_log/{user_id}": {
"get": {
"tags": [
"API Log"
],
"description": "Get a list of all API calls that have been called by the provided user. Admin and superadmin roles can list API calls from any user. A user role can only list API calls from itself. Minimum required user role: user.",
"parameters": [
{
"name": "user_id",
"description": "The unique user name/id",
"required": true,
"in": "path",
"type": "string"
}
],
"responses": {
"200": {
"description": "Returned a list of all API calls that have been called by the provided user.",
"schema": {
"$ref": "#/definitions/ApiLogListModel"
}
},
"400": {
"description": "The error message why API log gathering did not succeeded",
"schema": {
"$ref": "#/definitions/SimpleResponseModel"
}
}
},
"summary": "Get a list of all API calls that have been called by the provided user."
}
},
"/download_cache": {
"get": {
"tags": [
"Cache Management"
],
"description": "Get the current size of the download cache. Minimum required user role: admin.",
"responses": {
"200": {
"description": "The current state of the download cache",
"schema": {
"$ref": "#/definitions/StorageResponseModel"
}
},
"400": {
"description": "The error message why cache information gathering did not succeeded",
"schema": {
"$ref": "#/definitions/ProcessingResponseModel"
}
}
},
"summary": "Get the current size of the download cache"
},
"delete": {
"tags": [
"Cache Management"
],
"description": "Clean the download cache and remove all cached data. Minimum required user role: admin.",
"responses": {
"200": {
"description": "Processing status of cache deletion",
"schema": {
"$ref": "#/definitions/StorageResponseModel"
}
},
"400": {
"description": "The error message why cache cleaning did not succeeded",
"schema": {
"$ref": "#/definitions/ProcessingResponseModel"
}
}
},
"summary": "Clean the download cache and remove all cached data"
}
},
"/files": {
"post": {
"summary": "Upload file.",
"description": "File can be uploaded, best used with https://bmvimetadaten.mundialis.de.",
"tags": [
"File Management"
],
"responses": {
"200": {
"description": "Success or failure of connection",
"schema": {
"$ref": "#/definitions/SimpleStatusCodeResponseModel"
}
}
}
}
},
"/grass_modules": {
"get": {
"tags": [
"Module Viewer"
],
"description": "Get a list of modules. Minimum required user role: user.",
"parameters": [
{
"in": "query",
"name": "tag",
"type": "string",
"description": "Filter for categories"
},
{
"in": "query",
"name": "category",
"type": "string",
"description": "Another filter for categories"
},
{
"in": "query",
"name": "family",
"type": "string",
"description": "Type of GRASS GIS module",
"enum": [
"d",
"db",
"g",
"i",
"m",
"ps",
"r",
"r3",
"t",
"test",
"v"
]
},
{
"in": "query",
"name": "record",
"type": "string",
"description": "If set to 'full', all information about the returned modules are given like in the single module description. Depending on active cache, this response might run into a timeout. A filter can prevent this."
}
],
"responses": {
"200": {
"description": "This response returns a list of module names and the status.",
"schema": {
"$ref": "#/definitions/ModuleList"
}
},
"400": {
"description": "The error message and a detailed log why listing of modules did not succeeded",
"schema": {
"$ref": "#/definitions/SimpleStatusCodeResponseModel"
}
}
},
"summary": "Get a list of all GRASS GIS modules."
}
},
"/grass_modules/{grassmodule}": {
"get": {
"tags": [
"Module Viewer"
],
"parameters": [
{
"in": "path",
"name": "grassmodule",
"type": "string",
"description": "The name of a module",
"required": true
}
],
"description": "Get the description of a module. Minimum required user role: user.Can be also used to reload cache for a certain modulefor the full module description in listModules.",
"responses": {
"200": {
"description": "This response returns a description of a module.",
"schema": {
"$ref": "#/definitions/Module"
}
},
"400": {
"description": "The error message and a detailed log why describing modules did not succeeded",
"schema": {
"$ref": "#/definitions/SimpleStatusCodeResponseModel"
}
}
},
"summary": "Describe a GRASS GIS module."
}
},
"/landsat_process/{landsat_id}/{atcor_method}/{processing_method}": {
"post": {
"tags": [
"Satellite Image Algorithms"
],
"description": "Vegetation index computation from an atmospherically corrected Landsat scene. The Landsat scene is located in the google cloud storage. The processing is as follows: A user specific Landsat scene (LT4, LT5, LE7 and LC8) will be download and imported into an ephemeral database. Then atmospheric correction will be performed, with either TOAR or DOS4, depending on the users choice. The user specific vegetation index will be computed based on the TOAR or DOS4 data. The result of the computation is available as gzipped Geotiff file. In addition, the univariate statistic will be computed as well as a preview image including a legend. Minimum required user role: user.",
"parameters": [
{
"name": "landsat_id",
"description": "The id of a Landsat scene only with sensors: LT04, LT05, LE07, LC08",
"required": true,
"in": "path",
"type": "string",
"default": "LT41970251990147XXX03"
},
{
"name": "atcor_method",
"description": "The method for atmospheric correction",
"required": true,
"in": "path",
"type": "string",
"enum": [
"TOAR",
"DOS1",
"DOS4"
],
"default": "DOS4"
},
{
"name": "processing_method",
"description": "The method that should be used to compute the vegetation index",
"required": true,
"in": "path",
"type": "string",
"enum": [
"NDVI",
"ARVI",
"DVI",
"EVI",
"EVI2",
"GVI",
"GARI",
"GEMI",
"IPVI",
"PVI",
"SR",
"VARI",
"WDVI"
],
"default": "NDVI"
}
],
"responses": {
"200": {
"description": "This response includes all created resources as URL as well as the processing log and other metadata.",
"schema": {
"$ref": "#/definitions/LandsatNDVIResponseModel"
}
},
"400": {
"description": "The error message and a detailed log why NDVI processing of a Landsat scene did not succeeded",
"schema": {
"$ref": "#/definitions/ProcessingErrorResponseModel"
}
}
},
"summary": "Vegetation index computation from an atmospherically corrected Landsat scene."
}
},
"/landsat_query": {
"get": {
"tags": [
"Satellite Image Algorithms"
],
"description": "Query the Google Landsat archives using time interval, lat/lon coordinates, scene id, spacecraft id and cloud cover. All scenes that are located within the time interval and that intersect the given latitude/longitude coordinates are returned as a list of scene names with associated time stamps. Minimum required user role: user.",
"parameters": [
{
"name": "scene_id",
"description": "The scene id of the landsat scenes that should be searched",
"required": false,
"in": "query",
"type": "string"
},
{
"name": "spacecraft_id",
"description": "The spacecraft id of the landsat scenes that should be searched",
"required": false,
"in": "query",
"type": "string",
"enum": [
"LANDSAT_4",
"LANDSAT_5",
"LANDSAT_7",
"LANDSAT_8"
]
},
{
"name": "start_time",
"description": "The start time of the search interval",
"required": false,
"in": "query",
"type": "string",
"format": "dateTime"
},
{
"name": "end_time",
"description": "The end time of the search interval",
"required": false,
"in": "query",
"type": "string",
"format": "dateTime"
},
{
"name": "lon",
"description": "The longitude coordinate with which the scenes should intersect",
"required": false,
"in": "query",
"type": "number",
"format": "double"
},
{
"name": "lat",
"description": "The latitude coordinate with which the scenes should intersect",
"required": false,
"in": "query",
"type": "number",
"format": "double"
},
{
"name": "cloud_covert",
"description": "Cloud cover between 0 - 100",
"required": false,
"in": "query",
"type": "number",
"format": "double"
}
],
"responses": {
"200": {
"description": "A list of satellite scenes that fit the search",
"schema": {
"$ref": "#/definitions/SatelliteSceneList"
}
},
"400": {
"description": "The error message if the search did not succeeded",
"schema": {
"$ref": "#/definitions/SimpleResponseModel"
}
}
},
"summary": "Query the Google Landsat archives using time interval, lat/lon coordinates, scene id, spacecraft id and cloud cover."
}
},
"/locations": {
"get": {
"tags": [
"Location Management"
],
"description": "Get a list of all available locations that are located in the GRASS database and the user has access to. Minimum required user role: user.",
"responses": {
"200": {
"description": "This response returns a list of location names",
"schema": {
"$ref": "#/definitions/LocationListResponseModel"
}
},
"400": {
"description": "The error message",
"schema": {
"$ref": "#/definitions/SimpleResponseModel"
}
}
},
"summary": "Get a list of all available locations"
}
},
"/locations/{location_name}": {
"post": {
"tags": [
"Location Management"
],
"description": "Create a new location based on EPSG code in the user database. Minimum required user role: user.",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "location_name",
"description": "The name of the location to be created",
"required": true,
"in": "path",
"type": "string"
},
{
"name": "epsg_code",
"description": "The EPSG code",
"required": true,
"in": "body",
"schema": {
"$ref": "#/definitions/ProjectionInfoModel"
}
}
],
"responses": {
"200": {
"description": "Create a new location based on EPSG code",
"schema": {
"$ref": "#/definitions/ProcessingResponseModel"
}
},
"400": {
"description": "The error message",
"schema": {
"$ref": "#/definitions/ProcessingResponseModel"
}
}
},
"summary": "Create a new location based on EPSG code in the user database."
},
"delete": {
"tags": [
"Location Management"
],
"description": "Delete an existing location and everything inside from the user database. Minimum required user role: user.",
"parameters": [
{
"name": "location_name",
"description": "The name of the location to be deleted",
"required": true,
"in": "path",
"type": "string"
}
],
"responses": {
"200": {
"description": "Success message for location deletion",
"schema": {
"$ref": "#/definitions/SimpleResponseModel"
}
},
"400": {
"description": "The error message",
"schema": {
"$ref": "#/definitions/SimpleResponseModel"
}
}
},
"summary": "Delete an existing location and everything inside from the user"
}
},
"/locations/{location_name}/info": {
"get": {
"tags": [
"Location Management"
],
"description": "Get the location projection and current computational region of the PERMANENT mapset. Minimum required user role: user.",
"parameters": [
{
"name": "location_name",
"description": "The name of the location",
"required": true,
"in": "path",
"type": "string",
"default": "nc_spm_08"
}
],
"responses": {
"200": {
"description": "The location projection and current computational region of the PERMANENT mapset",
"schema": {
"$ref": "#/definitions/MapsetInfoResponseModel"
}
},
"400": {
"description": "The error message",
"schema": {
"$ref": "#/definitions/ProcessingResponseModel"
}
}
},
"summary": "Get the location projection and current computational region of the"
}
},
"/locations/{location_name}/mapsets": {
"get": {
"tags": [
"Mapset Management"
],
"description": "Get a list of all mapsets that are located in a specific location. Minimum required user role: user.",
"parameters": [
{
"name": "location_name",
"description": "The name of the location",
"required": true,
"in": "path",
"type": "string",
"default": "nc_spm_08"
}
],
"responses": {
"200": {
"description": "This response returns a list of mapset names and the log of the process chain that was used to create the response.",
"schema": {
"$ref": "#/definitions/StringListProcessingResultResponseModel"
}
},
"400": {
"description": "The error message and a detailed log why listing of mapsets did not succeeded",
"schema": {
"$ref": "#/definitions/ProcessingErrorResponseModel"
}
}
},
"summary": "Get a list of all mapsets that are located in a specific location."
}
},
"/locations/{location_name}/mapsets/{mapset_name}": {
"post": {
"tags": [
"Mapset Management"
],
"description": "Create a new mapset in an existing location. Minimum required user role: user.",
"parameters": [
{
"name": "location_name",
"description": "The name of the location",
"required": true,
"in": "path",
"type": "string"
},
{
"name": "mapset_name",
"description": "The name of the mapset",
"required": true,
"in": "path",
"type": "string"
}
],
"responses": {
"200": {
"description": "Success message for mapset creation",
"schema": {
"$ref": "#/definitions/ProcessingResponseModel"
}
},
"400": {
"description": "The error message and a detailed error log",
"schema": {
"$ref": "#/definitions/ProcessingErrorResponseModel"
}
}
},
"summary": "Create a new mapset in an existing location."
},
"delete": {
"tags": [
"Mapset Management"
],
"description": "Delete an existing mapset. Minimum required user role: user.",
"parameters": [
{
"name": "location_name",
"description": "The name of the location",
"required": true,
"in": "path",
"type": "string"
},
{
"name": "mapset_name",
"description": "The name of the mapset",
"required": true,
"in": "path",
"type": "string"
}
],
"responses": {
"200": {
"description": "Success message for mapset deletion",
"schema": {
"$ref": "#/definitions/ProcessingResponseModel"
}
},
"400": {
"description": "The error message and a detailed error log",
"schema": {
"$ref": "#/definitions/ProcessingErrorResponseModel"
}
}
},
"summary": "Delete an existing mapset"
}
},
"/locations/{location_name}/mapsets/{mapset_name}/info": {
"get": {
"tags": [
"Mapset Management"
],
"description": "Get the current computational region of the mapset and the projection of the location as WKT string. Minimum required user role: user.",
"parameters": [
{
"name": "location_name",
"description": "The name of the location",
"required": true,
"in": "path",
"type": "string",
"default": "nc_spm_08"
},
{
"name": "mapset_name",
"description": "The name of the mapset",
"required": true,
"in": "path",
"type": "string",
"default": "PERMANENT"
}
],
"responses": {
"200": {
"description": "The current computational region of the mapset and the projection of the location",
"schema": {
"$ref": "#/definitions/MapsetInfoResponseModel"
}
},
"400": {
"description": "The error message and a detailed error log",
"schema": {
"$ref": "#/definitions/ProcessingErrorResponseModel"
}
}
},
"summary": "Get the current computational region of the mapset and the projection"
}
},
"/locations/{location_name}/mapsets/{mapset_name}/landsat_import": {
"post": {
"tags": [
"Satellite Image Algorithms"
],
"description": "Download and import Landsat scenes into a new mapset and create a space-time raster dataset for each imported band. The resulting data will be located in a persistent user database. The location name is part of the path and must exist. The mapset will be created while importing and should not already exist in the location. The names of theLandsat scenes that should be downloaded must be specified in the HTTP body as application/json content. In addition, the basename of the STRDS that should manage the Landsat scenes must be provided in the application/json content. For each band a separate strds will be cerated and the STRDS base name will be extended with the band number.This call is performed asynchronously. The provided resource URL must be pulled to receive the status of the import. The data is available in the provided location/mapset, after the download and import finished. Minimum required user role: user.",
"consumes": [
"application/json"
],
"parameters": [
{
"name": "location_name",
"description": "The location name to import the Landsat scenes in",
"required": true,
"in": "path",
"type": "string"
},
{
"name": "mapset_name",
"description": "The name of the mapset to import the Landsat scenes in",
"required": true,
"in": "path",
"type": "string"
},
{
"name": "tiles",
"description": "The list of Landsat scenes, the band names and the target STRDS names",
"required": true,
"in": "body",
"schema": {
"$ref": "#/definitions/LandsatSceneListModel"
}
}
],
"responses": {
"200": {
"description": "The result of the Landsat time series import",
"schema": {
"$ref": "#/definitions/ProcessingResponseModel"
}
},
"400": {
"description": "The error message and a detailed log why Landsat time series import did not succeeded",
"schema": {
"$ref": "#/definitions/ProcessingErrorResponseModel"
}
}
},
"summary": "Download and import Landsat scenes into a new mapset and create a space time dataset for each imported band."
}
},
"/locations/{location_name}/mapsets/{mapset_name}/lock": {
"get": {
"tags": [
"Mapset Management"
],
"description": "Get the location/mapset lock status. Minimum required user role: admin.",
"parameters": [
{
"name": "location_name",
"description": "The name of the location",
"required": true,
"in": "path",
"type": "string",
"default": "nc_spm_08"
},
{
"name": "mapset_name",
"description": "The name of the mapset",
"required": true,
"in": "path",
"type": "string",
"default": "PERMANENT"
}
],
"responses": {
"200": {
"description": "Get the location/mapset lock status, either \"True\" or \"None\"",
"schema": {
"$ref": "#/definitions/MapsetLockManagementResponseModel"
}
},
"400": {
"description": "The error message and a detailed error log",
"schema": {
"$ref": "#/definitions/ProcessingResponseModel"
}
}
},
"summary": "Get the location/mapset lock status."
},
"post": {
"tags": [
"Mapset Management"
],
"description": "Create a location/mapset lock. A location/mapset lock can be created so that no operation can be performed on it until it is unlocked. Minimum required user role: admin.",
"parameters": [
{
"name": "location_name",
"description": "The name of the location",
"required": true,
"in": "path",
"type": "string",
"default": "nc_spm_08"
},
{
"name": "mapset_name",
"description": "The name of the mapset",
"required": true,
"in": "path",
"type": "string",
"default": "PERMANENT"
}
],
"responses": {
"200": {
"description": "Success message if the location/mapset was locked successfully",