-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathprocessed-openapi.yaml
More file actions
8376 lines (8347 loc) · 310 KB
/
processed-openapi.yaml
File metadata and controls
8376 lines (8347 loc) · 310 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
components:
responses:
badRequestDuplicateParameter:
content:
text/plain:
schema:
description: Bad request for query parameters can occur when a parameter
is used twice for a parameter that can only occur once
example: Invalid request. Parameter was used more than once in the request.
title: Invalid request
type: string
description: ''
badRequestInvalidParameter:
content:
text/plain:
schema:
description: Bad request for query parameters can occur when an unexpected
parameter is used
example: Invalid request. An unexpected parameter was used in the request.
title: Invalid request
type: string
description: ''
forbiddenError:
content:
text/plain:
schema:
description: Forbidden to access the requested resource
example: Forbidden to access the requested method.
title: Forbidden error
type: string
description: ''
internalServerError:
content:
text/plain:
schema:
description: An internal server error is reported when an application
error occurs in the Delft-FEWS Web Services.
example: Internal server error.
title: Internal server error
type: string
description: ''
unAuthorizedError:
content:
text/plain:
schema:
description: JWT Id token is missing or invalid
example: No JWT token provided.
title: Authorization error
type: string
description: ''
securitySchemes:
Bearer:
bearerFormat: JWT
description: JWT Bearer ID token
scheme: bearer
type: http
info:
description: 'Delft-FEWS Web Services REST API v1. For more information see: https://publicwiki.deltares.nl/x/fwNdBw'
title: Delft-FEWS Web Services REST API v1
version: v1-2025-06-20T17:11:44Z
openapi: 3.0.3
paths:
/archive/areas:
get:
description: Returns the available areas for the open archive, netcdf-storage
and the archive database
operationId: archive/areas
parameters:
- description: 'Supported Document Format: PI_JSON, '
in: query
name: documentFormat
required: false
schema:
enum:
- PI_JSON
type: string
- description: 'Document Version. Latest version is: 1.34'
in: query
name: documentVersion
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: schemas/pirest/pi_rest_archive_areas.json
description: ''
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Returns the available areas for the open archive, netcdf-storage and
the archive database
tags:
- archive
/archive/attributes:
get:
description: Get attributes with their values that are available in the archive.
Optionally the attributes can be filtered by one or more attribute keys, a
parameter ids or a location id.
operationId: archive/attributes
parameters:
- description: Parameter ids
in: query
name: parameterIds
required: false
schema:
type: string
- description: Location ids
in: query
name: locationIds
required: false
schema:
type: string
- description: One or more module instance ids
in: query
name: moduleInstanceIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more area ids
in: query
name: areaIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more source ids
in: query
name: sourceIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more attributes
in: query
name: attributes
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: 'Supported Document Format: PI_XML, PI_JSON, '
in: query
name: documentFormat
required: false
schema:
enum:
- PI_XML
- PI_JSON
type: string
- description: 'Document Version. Latest version is: 1.34'
in: query
name: documentVersion
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: schemas/pirest/pi_rest_archive_attributes.json
# application/xml:
# schema:
# description: https://fewsdocs.deltares.nl/schemas/version1.0/pi-schemas/pi_archive_attributes.xsd
# example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<archiveAttributes\
# \ xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"\
# http://www.wldelft.nl/fews/PI\" xsi:schemaLocation=\"http://www.wldelft.nl/fews/PI\
# \ https://fewsdocs.deltares.nl/schemas/version1.0/pi-schemas/pi_archive_attributes.xsd\"\
# >\n <attribute>\n <name>storageId</name>\n <value>storageA</value>\n\
# \ </attribute>\n</archiveAttributes>"
# title: PI_XML
# type: object
# xml:
# name: archiveAttributes
description: ''
'400':
$ref: '#/components/responses/badRequestInvalidParameter'
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Get attributes with their values that are available in the archive
tags:
- archive
/archive/locations:
get:
description: 'Get locations that are available in the archive. Optionally the
locations can be filtered by one or more parameter ids or archive attributes.
Archive attributes can be added in the following format: attribute(key)=value.
Attributes are passed by passing the key as an argument to the attribute()
parameter and the value as parameter value. For example attribute(storageId)=storageA.'
operationId: archive/locations
parameters:
- description: One or more parameter ids
in: query
name: parameterIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more module instance ids
in: query
name: moduleInstanceIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more area ids
in: query
name: areaIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more source ids
in: query
name: sourceIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: 'Supported Document Format: PI_XML, PI_JSON, GEO_JSON, NAME_LIST,
DD_JSON, '
in: query
name: documentFormat
required: false
schema:
enum:
- PI_XML
- PI_JSON
- GEO_JSON
- NAME_LIST
- DD_JSON
type: string
- description: 'Document Version. Latest version is: 1.34'
in: query
name: documentVersion
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
oneOf:
- $ref: schemas/pirest/pi_rest_archive_locations.json
- description: 'GEO JSON: DocumentFormat=GEO_JSON'
example: "{\n \"type\" : \"FeatureCollection\",\n \"features\"\
\ : [ {\n \"type\" : \"Feature\",\n \"geometry\" : {\n \
\ \"type\" : \"Point\",\n \"coordinates\" : [ 3.816699981689453,\
\ 55.400001525878906 ]\n },\n \"properties\" : {\n \
\ \"locationId\" : \"A121\",\n \"locationName\" : \"A121\"\
\n }\n }\n ]\n}"
title: GEO_JSON
type: object
- description: 'Digital Delta JSON: DocumentFormat=DD_JSON'
example: "{\n \"results\" : [ {\n \"type\" : \"Feature\",\n\
\ \"geometry\" : {\n \"type\" : \"Point\",\n \"coordinates\"\
\ : [ 3.816699981689453, 55.400001525878906, 0.0 ]\n },\n \
\ \"properties\" : {\n \"locationId\" : \"A121\",\n \
\ \"locationName\" : \"A121\",\n \"node\" : {\n \
\ \"id\" : \"Deltares\",\n \"name\" : \"Deltares Digitale\
\ Delta\",\n \"description\" : \"Delft-FEWS Web Services\
\ (1.0) - version: 2017.01, build: 68155 Sep11, type: development-2017.01,\
\ jre: 11.0.10, os:Windows 10, mx: 8558m\"\n }\n }\n \
\ } ]\n}"
title: DD_JSON
type: object
application/xml:
schema:
description: https://fewsdocs.deltares.nl/schemas/version1.0/pi-schemas/pi_locations.xsd
example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Locations xmlns:xsi=\"\
http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"http://www.wldelft.nl/fews/PI\"\
\ xsi:schemaLocation=\"http://www.wldelft.nl/fews/PI https://fewsdocs.deltares.nl/schemas/version1.0/pi-schemas/pi_locations.xsd\"\
\ version=\"1.9\">\n <geoDatum>LOCAL</geoDatum>\n <location\
\ locationId=\"BCRA1\">\n <shortName>Bear Creek Dam</shortName>\n\
\ <lat>34.399166107177734</lat>\n <lon>-87.98777770996094</lon>\n\
\ </location>\n</Locations>"
title: PI_XML
type: object
xml:
name: Locations
text/plain:
schema:
description: List of location names. DocumentFormat=NAME_LIST
example: 'Location 1
Location 2'
title: NAME_LIST
type: object
description: ''
'400':
$ref: '#/components/responses/badRequestInvalidParameter'
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Get locations that are available in the archive
tags:
- archive
/archive/moduleinstances:
get:
description: Returns the available module instaces for the netcdf storage
operationId: archive/moduleinstances
parameters:
- description: One or more location ids
in: query
name: locationIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more parameter ids
in: query
name: parameterIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more area ids
in: query
name: areaIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more source ids
in: query
name: sourceIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: 'Supported Document Format: PI_JSON, '
in: query
name: documentFormat
required: false
schema:
enum:
- PI_JSON
type: string
- description: 'Document Version. Latest version is: 1.34'
in: query
name: documentVersion
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: schemas/pirest/pi_rest_moduleinstances.json
description: ''
'400':
$ref: '#/components/responses/badRequestInvalidParameter'
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Returns the available module instaces for the netcdf storage
tags:
- archive
/archive/netcdfstorageforecasts:
get:
description: Get forecasts with its attributes from the external netcdf storage
from the archive.
operationId: archive/netcdfstorageforecasts
parameters:
- description: Requested attributes
in: query
name: requestedAttributes
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: 'Start time. Format: yyyy-MM-ddTHH:mm:ssZ'
in: query
name: startTime
required: true
schema:
description: Date-time string that adheres to RFC 3339.
example: '2020-03-18T15:00:00Z'
format: date-time
type: string
- description: 'End time. Format: yyyy-MM-ddTHH:mm:ssZ'
in: query
name: endTime
required: true
schema:
description: Date-time string that adheres to RFC 3339.
example: '2020-03-18T15:00:00Z'
format: date-time
type: string
- description: Forecast count
in: query
name: forecastCount
required: false
schema:
format: number
type: string
- description: 'Supported Document Format: PI_XML, PI_JSON, '
in: query
name: documentFormat
required: false
schema:
enum:
- PI_XML
- PI_JSON
type: string
- description: 'Document Version. Latest version is: 1.34'
in: query
name: documentVersion
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: schemas/pirest/pi_rest_archive_externalnetcdfstorageforecasts.json
application/xml:
schema:
description: https://fewsdocs.deltares.nl/schemas/version1.0/pi-schemas/pi_archive_externalnetcdfstorageforecasts.xsd
example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<externalNetCDFStorageForecasts\
\ xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"\
http://www.wldelft.nl/fews/PI\" xsi:schemaLocation=\"http://www.wldelft.nl/fews/PI\
\ https://fewsdocs.deltares.nl/schemas/version1.0/pi-schemas/pi_archive_externalnetcdfstorageforecasts.xsd\"\
>\n <externalNetCDFStorageForecast>\n <forecastTime date=\"\
2019-09-27\" time=\"12:00:00\"/>\n <forecastAvailableTime\
\ date=\"2021-05-21\" time=\"08:40:43\"/>\n <attribute>\n\
\ <name>long_name</name>\n <value>sep</value>\n\
\ </attribute>\n </externalNetCDFStorageForecast>\n \
\ <externalNetCDFStorageForecast>\n <forecastTime date=\"\
2019-09-27\" time=\"06:00:00\"/>\n <forecastAvailableTime\
\ date=\"2021-05-21\" time=\"08:40:43\"/>\n <attribute>\n\
\ <name>long_name</name>\n <value>sep</value>\n\
\ </attribute>\n </externalNetCDFStorageForecast>\n</externalNetCDFStorageForecasts>"
title: PI_XML
type: object
xml:
name: externalNetCDFStorageForecasts
description: ''
'400':
$ref: '#/components/responses/badRequestInvalidParameter'
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Get forecasts with its attributes from the external netcdf storage
from the archive
tags:
- archive
/archive/parameters:
get:
description: 'Get parameters that are available in the archive. Optionally the
parameters can be filtered by one or more location ids or archive attributes.
Archive attributes can be added in the following format: attribute(key)=value.
Attributes are passed by passing the key as an argument to the attribute()
parameter and the value as parameter value. For example attribute(storageId)=storageA.'
operationId: archive/parameters
parameters:
- description: One or more location ids
in: query
name: locationIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more module instance ids
in: query
name: moduleInstanceIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more area ids
in: query
name: areaIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: One or more source ids
in: query
name: sourceIds
required: false
schema:
description: The parameter can be repeated
items:
type: string
type: array
- description: 'Supported Document Format: PI_XML, PI_JSON, NAME_LIST, DD_JSON, '
in: query
name: documentFormat
required: false
schema:
enum:
- PI_XML
- PI_JSON
- NAME_LIST
- DD_JSON
type: string
- description: 'Document Version. Latest version is: 1.34'
in: query
name: documentVersion
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
oneOf:
- $ref: schemas/pirest/pi_rest_archive_parameters.json
- description: 'Digital Delta JSON: DocumentFormat=DD_JSON'
example: "{\n \"results\" : [ {\n \"id\" : \"parameter1\",\n\
\ \"quantity\" : \"parameter1\",\n \"quantityName\" : \"\
Parameter 1\",\n \"unit\" : \"unit 1\",\n \"node\" : {\n\
\ \"id\" : \"locationId\",\n \"name\" : \"DD Name\"\
,\n \"description\" : \"DD Description\"\n }\n }, {\n\
\ \"id\" : \"parameter2\",\n \"quantity\" : \"parameter2\"\
,\n \"quantityName\" : \"Parameter 2\",\n \"unit\" : \"\
unit 2\",\n \"node\" : {\n \"id\" : \"locationId\",\n\
\ \"name\" : \"DD Name\",\n \"description\" : \"DD Description\"\
\n }\n } ]\n}"
title: DD_JSON
type: object
application/xml:
schema:
description: https://fewsdocs.deltares.nl/schemas/version1.0/pi-schemas/pi_timeseriesparameters.xsd
example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<timeseriesparameters\
\ xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns=\"\
http://www.wldelft.nl/fews/PI\" xsi:schemaLocation=\"http://www.wldelft.nl/fews/PI\
\ https://fewsdocs.deltares.nl/schemas/version1.0/pi-schemas/pi_timeseriesparameters.xsd\"\
\ version=\"1.9\">\n <parameter id=\"QR_Adj\">\n <name>QR_Adj</name>\n\
\ <parameterType>instantaneous</parameterType>\n <unit></unit>\n\
\ </parameter>\n</timeseriesparameters>"
title: PI_XML
type: object
xml:
name: timeseriesparameters
text/plain:
schema:
description: List of parameter names. DocumentFormat=NAME_LIST
example: 'air_pressure
air_temperature
'
title: TEXT/PLAIN
type: object
description: ''
'400':
$ref: '#/components/responses/badRequestInvalidParameter'
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Get parameters that are available in the archive
tags:
- archive
/archive/products:
get:
description: Returns a zip-file with the requested products or a binary file
if only one file is requested, that are available in the archive filtered
by the specified parameters.
operationId: archive/products
parameters:
- description: Source Id
in: query
name: sourceId
required: false
schema:
type: string
- description: Area Id
in: query
name: areaId
required: false
schema:
type: string
- description: Archived Product Count
in: query
name: productCount
required: false
schema:
format: number
type: string
- description: 'Start Time Archive Search Period. Format: yyyy-MM-ddTHH:mm:ssZ'
in: query
name: startTime
required: false
schema:
description: Date-time string that adheres to RFC 3339.
example: '2020-03-18T15:00:00Z'
format: date-time
type: string
- description: 'End Time Archive Search Period. Format: yyyy-MM-ddTHH:mm:ssZ'
in: query
name: endTime
required: false
schema:
description: Date-time string that adheres to RFC 3339.
example: '2020-03-18T15:00:00Z'
format: date-time
type: string
- description: 'Start Time Archive Forecast Search Period. Format: yyyy-MM-ddTHH:mm:ssZ'
in: query
name: startForecastTime
required: false
schema:
description: Date-time string that adheres to RFC 3339.
example: '2020-03-18T15:00:00Z'
format: date-time
type: string
- description: 'End Time Archive Forecast Search Period. Format: yyyy-MM-ddTHH:mm:ssZ'
in: query
name: endForecastTime
required: false
schema:
description: Date-time string that adheres to RFC 3339.
example: '2020-03-18T15:00:00Z'
format: date-time
type: string
- description: An optional product file name. If this is specified only this
item will be returned
in: query
name: productFileName
required: false
schema:
description: Date-time string that adheres to RFC 3339.
example: '2020-03-18T15:00:00Z'
format: date-time
type: string
- description: 'Supported Document Format: BINARY, BINARY_ZIP, '
in: query
name: documentFormat
required: false
schema:
enum:
- BINARY
- BINARY_ZIP
type: string
responses:
'200':
content:
application/octet-stream:
schema:
description: File attachment with zipped products
example: Content-Disposition", "attachment; filename=products.zip
title: BINARY_ZIP or BINARY
type: string
description: ''
'400':
$ref: '#/components/responses/badRequestInvalidParameter'
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Returns a zip-file with the requested products or a binary file if
only one file is requested, that are available in the archive filtered by
the specified parameters
tags:
- archive
post:
description: upload new products to the archive. The multipart/form-data encoding
has to be used. The metaData.xml will be automatically generated. It is only
possible to upload a single product file each time this endpoint is used.
operationId: post/archive/products
parameters:
- description: ' time zero of the uploaded product. Format: yyyy-MM-ddTHH:mm:ssZ'
in: query
name: timeZero
required: false
schema:
description: Date-time string that adheres to RFC 3339.
example: '2020-03-18T15:00:00Z'
format: date-time
type: string
- description: area id of the uploaded product
in: query
name: areaId
required: false
schema:
type: string
- description: source id of the uploaded product
in: query
name: sourceId
required: false
schema:
type: string
- description: The sub folder in which the product will be stored. This can
be used as an folder to identify the product easier
in: query
name: subFolder
required: false
schema:
type: string
requestBody:
content:
multipart/form-data:
schema:
properties:
file:
description: file to upload
type: string
required:
- file
responses:
'200':
content:
text/plain:
schema:
description: Empty response it the upload succeeded.
example: ''
title: text/plain
type: string
description: ''
'400':
$ref: '#/components/responses/badRequestInvalidParameter'
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: upload new products to the archive
tags:
- archive
/archive/products/attributes/:
post:
description: Add or update attributes to a product metadata.xml. It's only possible
to add attributes to one xml at a time.
operationId: archive/products/attributes
parameters:
- description: ' the relative path of the product in the archive'
in: query
name: relativePath
required: false
schema:
example: products-rws/2022/05/rivieren/10/product/weerbeeld_maas/2022_05_10_T_09_00_00/KNMI_20220510085242/weerbeeld_maas.txt
type: string
responses:
'200':
content:
text/plain:
schema:
description: Plain text comforming successful update.
example: Attributes were successfully updated.
title: text/plain
type: string
description: ''
'400':
$ref: '#/components/responses/badRequestInvalidParameter'
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Add or update attributes to a product metadata
tags:
- archive
/archive/products/id:
get:
description: Return a specific product from the archive. The relative path in
the archive will be used as the id.
operationId: archive/products/id
parameters:
- description: ' the relative path of the product in the archive'
in: query
name: relativePath
required: false
schema:
example: products-rws/2022/05/rivieren/10/product/weerbeeld_maas/2022_05_10_T_09_00_00/KNMI_20220510085242/weerbeeld_maas.txt
type: string
- description: 'Supported Document Format: BINARY, '
in: query
name: documentFormat
required: false
schema:
enum:
- BINARY
type: string
responses:
'200':
content:
application/json:
schema:
description: Product
example: ''
title: product
type: object
description: ''
'400':
$ref: '#/components/responses/badRequestInvalidParameter'
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Return a specific product from the archive
tags:
- archive
/archive/productsmetadata:
get:
description: Returns a list of metadata found in the archive, where the T0 falls
between the startForecastTime and endForecastTime.
operationId: archive/productsmetadata
parameters:
- description: 'Start Forecast Time Archive Search Period. Format: yyyy-MM-ddTHH:mm:ssZ'
in: query
name: startForecastTime
required: false
schema:
description: Date-time string that adheres to RFC 3339.
example: '2020-03-18T15:00:00Z'
format: date-time
type: string
- description: 'End Forecast Time Archive Search Period. Format: yyyy-MM-ddTHH:mm:ssZ'
in: query
name: endForecastTime
required: false
schema:
description: Date-time string that adheres to RFC 3339.
example: '2020-03-18T15:00:00Z'
format: date-time
type: string
- description: Number of products which should be returned. If no forecast count
is used, all products in the search period will be returned.
in: query
name: forecastCount
required: false
schema:
type: string
- description: 'Supported Document Format: PI_JSON, '
in: query
name: documentFormat
required: false
schema:
enum:
- PI_JSON
type: string
- description: 'Document Version. Latest version is: 1.34'
in: query
name: documentVersion
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: schemas/pirest/pi_rest_archive_productsmetadata.json
description: ''
'400':
$ref: '#/components/responses/badRequestInvalidParameter'
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Returns a list of metadata found in the archive, where the T0 falls
between the startForecastTime and endForecastTime
tags:
- archive
/archive/sources:
get:
description: Returns the available sources for the open archive, netcdf-storage
and the archive database
operationId: archive/sources
parameters:
- description: 'Supported Document Format: PI_JSON, '
in: query
name: documentFormat
required: false
schema:
enum:
- PI_JSON
type: string
- description: 'Document Version. Latest version is: 1.34'
in: query
name: documentVersion
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: schemas/pirest/pi_rest_archive_sources.json
description: ''
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Returns the available sources for the open archive, netcdf-storage
and the archive database
tags:
- archive
/archive/status:
get:
description: Get Archive status
operationId: archive/status
parameters:
- description: 'Supported Document Format: PI_JSON, '
in: query
name: documentFormat
required: false
schema:
enum:
- PI_JSON
type: string
- description: 'Document Version. Latest version is: 1.34'
in: query
name: documentVersion
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
oneOf:
- $ref: schemas/pirest/pi_rest_archive_status.json
description: ''
'400':
$ref: '#/components/responses/badRequestInvalidParameter'
'401':
$ref: '#/components/responses/unAuthorizedError'
'403':
$ref: '#/components/responses/forbiddenError'
'500':
$ref: '#/components/responses/internalServerError'
summary: Get Archive status
tags:
- archive
/colors/default:
get:
description: Get the default colors as configured in the Time Series Display