-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathopenapi.yaml
14282 lines (13762 loc) · 455 KB
/
openapi.yaml
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
openapi: 3.0.3
info:
title: Platform API
description: |
_OpenAPI specification for the **Platform API** of **Empire**, the allocation and nomination platform of BritNed_
---
Additional documentation available in the API's [GitHub repository](https://github.com/britned/empire-platform-api)
version: 5.0.3
contact:
name: BritNed
url: https://www.britned.com
email: [email protected]
termsOfService: https://www.britned.com/empire-api-terms-of-use/
servers:
- description: PRODUCTION
url: https://api.empire.britned.com
- description: TRAINING
url: https://api.training.empire.britned.com
tags:
- name: metadata
description: Metadata endpoints
- name: allocated-auction
description: Allocated Auctions
- name: attachment
description: Attachments
- name: auction
description: Auctions
- name: audit-log
description: Audit Logs
- name: bidding-configuration
description: Bidding Configuration
- name: buy-now-offers
description: Buy Now Offers
- name: default-bid
description: Default Bids
- name: default-nomination
description: Default Nominations
- name: finance-information
description: Finance Information
- name: finance
description: Finance
- name: manual-file-upload
description: Manual File Upload
- name: messages
description: Messages
- name: nomination
description: Nominations
- name: organisation-document
description: Organisation Documents
- name: organisation
description: Organisations
- name: participant-dashboard
description: Participant Dashboard
- name: participant-overview
description: Participant Overview
- name: profile
description: Profile
- name: public-allocated-auction
description: Public / Allocated Auctions
- name: public-auction
description: Public / Auctions
- name: public-nominations
description: Public / Nominations
- name: reporting
description: Reporting
- name: secondary-market
description: Secondary Market
- name: transmission-right
description: Transmission Rights
- name: user
description: Users
paths:
/v1/public/version:
get:
operationId: getVersion
description: |
Fetch the current version of the Platform Backend and API in MAJOR.MINOR.PATCH format
tags:
- metadata
responses:
'200':
description: __OK__
content:
application/json:
schema:
$ref: '#/components/schemas/Version'
/v1/allocated-auctions:
get:
operationId: getAllocatedAuctions
description: |-
Fetch a paginated, sortable, filterable list of Allocated Auctions
---
__Requires Permission:__ (at least one)
* `VIEW_PUBLISHED_AUCTIONS`
* `VIEW_ANY_AUCTIONS`
tags:
- allocated-auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- VIEW_PUBLISHED_AUCTIONS
- VIEW_ANY_AUCTIONS
parameters:
- $ref: '#/components/parameters/PageLimit'
- $ref: '#/components/parameters/PageOffset'
- name: sortBy
in: query
required: true
schema:
$ref: '#/components/schemas/AllocatedAuctionSortBy'
- $ref: '#/components/parameters/BorderDirectionOptional'
- $ref: '#/components/parameters/TimescalesOptional'
- $ref: '#/components/parameters/ProductTypesOptional'
- $ref: '#/components/parameters/ParticipantIdOptional'
- name: participantStatus
in: query
schema:
$ref: '#/components/schemas/AllocatedAuctionParticipantStatus'
- name: biddingPeriodStart
in: query
description: Filter for start of bidding period
schema:
$ref: '#/components/schemas/DateTime'
- name: biddingPeriodEnd
in: query
description: Filter for end of bidding period
schema:
$ref: '#/components/schemas/DateTime'
- name: deliveryPeriodStart
in: query
schema:
$ref: '#/components/schemas/MtuStart'
- name: deliveryPeriodEnd
in: query
schema:
$ref: '#/components/schemas/MtuEnd'
- name: query
in: query
schema:
type: string
responses:
'200':
description: __OK__
content:
application/json:
schema:
$ref: '#/components/schemas/AllocatedAuctionBatch'
'400':
description: |-
__Bad Request__
* `INVALID_PARTICIPANT_ID` - specified Participant not found in the system
* `INVALID_PARTICIPANT_FILTER` - the `X-Participant-Id` and `participantStatus` parameters need to be either both specified, or none specified
x-errors:
- code: INVALID_PARTICIPANT_ID
description: specified Participant not found in the system
- code: INVALID_PARTICIPANT_FILTER
description: the `X-Participant-Id` and `participantStatus` parameters need to be either both specified, or none specified
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'422':
description: |-
__Unprocessable Entity__
* `PERIOD_MISALIGNED` - if delivery period start and end parameters are both set, they need to come after each other
* `MTU_BORDER_MISMATCH` - delivery period start and end dates does not comform to MTU borders
x-errors:
- code: PERIOD_MISALIGNED
description: if delivery period start and end parameters are both set, they need to come after each other
- code: MTU_BORDER_MISMATCH
description: delivery period start and end dates does not comform to MTU borders
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/allocated-auctions/aggregated:
get:
operationId: getAggregatedAllocatedAuctions
description: |-
Fetch a filterable list of Aggregated Allocated Auctions
---
__Requires Permission:__ (at least one)
* `VIEW_PUBLISHED_AUCTIONS`
* `VIEW_ANY_AUCTIONS`
tags:
- allocated-auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- VIEW_PUBLISHED_AUCTIONS
- VIEW_ANY_AUCTIONS
parameters:
- $ref: '#/components/parameters/BorderDirectionOptional'
- $ref: '#/components/parameters/TimescalesOptional'
- $ref: '#/components/parameters/ProductTypesOptional'
- $ref: '#/components/parameters/ParticipantIdOptional'
- name: participantStatus
in: query
schema:
$ref: '#/components/schemas/AllocatedAuctionParticipantStatus'
- name: biddingPeriodStart
in: query
description: Filter for start of bidding period
schema:
$ref: '#/components/schemas/DateTime'
- name: biddingPeriodEnd
in: query
description: Filter for end of bidding period
schema:
$ref: '#/components/schemas/DateTime'
- name: deliveryPeriodStart
in: query
schema:
$ref: '#/components/schemas/MtuStart'
- name: deliveryPeriodEnd
in: query
schema:
$ref: '#/components/schemas/MtuEnd'
responses:
'200':
description: __OK__
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AggregatedAllocatedAuction'
'400':
description: |-
__Bad Request__
* `INVALID_PARTICIPANT_ID` - specified Participant not found in the system
* `INVALID_PARTICIPANT_FILTER` - the `X-Participant-Id` and `participantStatus` parameters need to be either both specified, or none specified
x-errors:
- code: INVALID_PARTICIPANT_ID
description: specified Participant not found in the system
- code: INVALID_PARTICIPANT_FILTER
description: the `X-Participant-Id` and `participantStatus` parameters need to be either both specified, or none specified
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'422':
description: |-
__Unprocessable Entity__
* `PERIOD_MISALIGNED` - if delivery period start and end parameters are both set, they need to come after each other
* `MTU_BORDER_MISMATCH` - delivery period start and end dates does not comform to MTU borders
x-errors:
- code: PERIOD_MISALIGNED
description: if delivery period start and end parameters are both set, they need to come after each other
- code: MTU_BORDER_MISMATCH
description: delivery period start and end dates does not comform to MTU borders
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/attachments:
post:
operationId: uploadAttachment
description: |-
Upload a single Attachment (file)
On successful upload the file gets persisted and metadata for the Attachment is returned. The Attachment can be referenced by its identifier in other functions (e.g Organisation Documents)
**File size limit:** 50 MB
**File types accepted:**
* images:
- .jpg | image/jpeg
- .png | image/png
* documents:
- .doc | application/msword
- .docx | application/vnd.openxmlformats-officedocument.wordprocessingml.document
- .xls | application/vnd.ms-excel
- .xlsx | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- .ppt | application/vnd.ms-powerpoint
- .pptx | application/vnd.openxmlformats-officedocument.presentationml.presentation
- .pdf | application/pdf
* text files:
- .txt | text/plain
- .xml | application/xml
- .json | application/json
* archives:
- .zip | application/zip
- .rar | application/vnd.rar
---
__Requires Permission:__ (at least one)
* `MANAGE_CRISIS_ACTIONS`
* `INVITE_USERS`
* `MANAGE_OWN_MANUAL_FILE_UPLOAD_BIDS`
* `MANAGE_OWN_MANUAL_FILE_UPLOAD_NOMINATIONS`
* `MANAGE_ANY_MANUAL_FILE_UPLOAD`
* `MANAGE_ANY_ORGANISATION_DOCUMENTS`
* `MANAGE_OWN_ORGANISATION_DOCUMENTS`
__Generates Audit Log Entry:__ `UPLOAD_ATTACHMENT`
tags:
- attachment
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- MANAGE_CRISIS_ACTIONS
- INVITE_USERS
- MANAGE_OWN_MANUAL_FILE_UPLOAD_BIDS
- MANAGE_OWN_MANUAL_FILE_UPLOAD_NOMINATIONS
- MANAGE_ANY_MANUAL_FILE_UPLOAD
- MANAGE_ANY_ORGANISATION_DOCUMENTS
- MANAGE_OWN_ORGANISATION_DOCUMENTS
x-audit-log: UPLOAD_ATTACHMENT
requestBody:
content:
multipart/form-data:
schema:
type: object
required:
- fileName
- file
properties:
fileName:
$ref: '#/components/schemas/FileName'
file:
type: string
format: binary
responses:
'201':
description: __Created__
content:
application/json:
schema:
$ref: '#/components/schemas/Attachment'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'413':
description: |
__Payload Too Large__
The attachment to be uploaded exceeded to defined size limit
'422':
description: |-
__Unprocessable Entity__
* `INVALID_ATTACHMENT_FILE_TYPE` - only files with the specified file types can be uploaded
x-errors:
- code: INVALID_ATTACHMENT_FILE_TYPE
description: only files with the specified file types can be uploaded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/auctions/{id}/reduction-periods:
get:
operationId: getAuctionReductionPeriods
description: |-
Fetch reduction periods that possibly affects the Auction
---
__Requires Permission:__ (at least one)
* `VIEW_PUBLISHED_AUCTIONS`
* `VIEW_ANY_AUCTIONS`
tags:
- auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- VIEW_PUBLISHED_AUCTIONS
- VIEW_ANY_AUCTIONS
parameters:
- $ref: '#/components/parameters/Identifier'
responses:
'200':
description: __OK__
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AuctionReductionPeriod'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
/v1/auctions:
get:
operationId: getAuctions
description: |-
Paginated, sortable, filterable list of Auctions
---
__Requires Permission:__ (at least one)
* `VIEW_PUBLISHED_AUCTIONS`
* `VIEW_ANY_AUCTIONS`
tags:
- auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- VIEW_PUBLISHED_AUCTIONS
- VIEW_ANY_AUCTIONS
parameters:
- $ref: '#/components/parameters/PageLimit'
- $ref: '#/components/parameters/PageOffset'
- name: sortBy
in: query
required: true
description: Sort list by given attribute and direction
schema:
$ref: '#/components/schemas/AuctionSortBy'
- $ref: '#/components/parameters/BorderDirectionOptional'
- $ref: '#/components/parameters/TimescalesOptional'
- $ref: '#/components/parameters/ProductTypesOptional'
- name: statuses
in: query
description: Filter for given statuses
schema:
type: array
items:
$ref: '#/components/schemas/AuctionFilterStatus'
- name: biddingPeriodStart
in: query
description: Filter for start of bidding period
schema:
$ref: '#/components/schemas/DateTime'
- name: biddingPeriodEnd
in: query
description: Filter for end of bidding period
schema:
$ref: '#/components/schemas/DateTime'
- name: deliveryPeriodStart
in: query
description: Filter for start of delivery period (aligned to MTUs)
schema:
$ref: '#/components/schemas/MtuStart'
- name: deliveryPeriodEnd
in: query
description: Filter for end of delivery period (aligned to MTUs)
schema:
$ref: '#/components/schemas/MtuEnd'
- name: query
in: query
description: Free text search in name
schema:
type: string
responses:
'200':
description: __OK__
content:
application/json:
schema:
$ref: '#/components/schemas/AuctionBatch'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'422':
description: |-
__Unprocessable Entity__
* `PERIOD_MISALIGNED`
- if period start and end parameters are both set, they need to come after each other
- both for bidding period and delivery period
* `MTU_BORDER_MISMATCH` - delivery period start and end dates does not comform to MTU borders
x-errors:
- code: PERIOD_MISALIGNED
description: |
- if period start and end parameters are both set, they need to come after each other
- both for bidding period and delivery period
- code: MTU_BORDER_MISMATCH
description: delivery period start and end dates does not comform to MTU borders
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/auctions/long-term/{id}:
get:
operationId: getLongTermAuction
description: |-
Fetch a Long Term Auction by its identifier
---
__Requires Permission:__ (at least one)
* `VIEW_PUBLISHED_AUCTIONS`
* `VIEW_ANY_AUCTIONS`
tags:
- auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- VIEW_PUBLISHED_AUCTIONS
- VIEW_ANY_AUCTIONS
parameters:
- $ref: '#/components/parameters/Identifier'
responses:
'200':
description: __OK__
content:
application/json:
schema:
$ref: '#/components/schemas/LongTermAuction'
'400':
description: |-
__Bad Request__
* `TIMESCALE_MISMATCH` - endpoint matching Auction timescale need to be used
x-errors:
- code: TIMESCALE_MISMATCH
description: endpoint matching Auction timescale need to be used
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
/v1/auctions/day-ahead/{id}:
get:
operationId: getDayAheadAuction
description: |-
Fetch a Day Ahead Auction by its identifier
---
__Requires Permission:__ (at least one)
* `VIEW_PUBLISHED_AUCTIONS`
* `VIEW_ANY_AUCTIONS`
tags:
- auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- VIEW_PUBLISHED_AUCTIONS
- VIEW_ANY_AUCTIONS
parameters:
- $ref: '#/components/parameters/Identifier'
responses:
'200':
description: __OK__
content:
application/json:
schema:
$ref: '#/components/schemas/DayAheadAuction'
'400':
description: |-
__Bad Request__
* `TIMESCALE_MISMATCH` - endpoint matching Auction timescale need to be used
x-errors:
- code: TIMESCALE_MISMATCH
description: endpoint matching Auction timescale need to be used
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
/v1/auctions/intra-day/{id}:
get:
operationId: getIntraDayAuction
description: |-
Fetch an Intra Day Auction by its identifier
---
__Requires Permission:__ (at least one)
* `VIEW_PUBLISHED_AUCTIONS`
* `VIEW_ANY_AUCTIONS`
tags:
- auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- VIEW_PUBLISHED_AUCTIONS
- VIEW_ANY_AUCTIONS
parameters:
- $ref: '#/components/parameters/Identifier'
responses:
'200':
description: __OK__
content:
application/json:
schema:
$ref: '#/components/schemas/IntraDayAuction'
'400':
description: |-
__Bad Request__
* `TIMESCALE_MISMATCH` - endpoint matching Auction timescale need to be used
x-errors:
- code: TIMESCALE_MISMATCH
description: endpoint matching Auction timescale need to be used
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
/v1/auctions/{id}/bidding-configuration:
get:
operationId: getAuctionBiddingConfiguration
description: |-
Fetch the Participant's Bidding Configuration for the given Auction's direction
---
__Requires Permission:__ (at least one)
* `MANAGE_LT_AUCTION_BIDS`
* `MANAGE_DA_ID_AUCTION_BIDS`
tags:
- auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- MANAGE_LT_AUCTION_BIDS
- MANAGE_DA_ID_AUCTION_BIDS
parameters:
- $ref: '#/components/parameters/Identifier'
responses:
'200':
description: __OK__
content:
application/json:
schema:
$ref: '#/components/schemas/BiddingConfigurationPerDirection'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
/v1/auctions/long-term/{id}/bids:
get:
operationId: getLongTermAuctionBids
description: |-
Fetch Bids for a Long Term Auction by its identifier
---
__Requires Permission:__ (at least one)
* `MANAGE_LT_AUCTION_BIDS`
tags:
- auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- MANAGE_LT_AUCTION_BIDS
parameters:
- $ref: '#/components/parameters/Identifier'
responses:
'200':
description: __OK__
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LongTermAuctionBid'
'400':
description: |-
__Bad Request__
* `TIMESCALE_MISMATCH` - endpoint matching Auction timescale need to be used
x-errors:
- code: TIMESCALE_MISMATCH
description: endpoint matching Auction timescale need to be used
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
put:
operationId: submitLongTermAuctionBids
description: |-
Submit a collection of Bids for Long Term Auctions
Rules for creating/updating/deleting Bids:
- a full list of every valid bid need to be always submitted
- Bids that are not yet present in the system need to be sent with NULL identifiers
- Bids to be edited need to be sent with their respective identifiers
- Bids to be deleted need to be left out from the list to be submitted
---
__Requires Permission:__ (at least one)
* `MANAGE_LT_AUCTION_BIDS`
__Generates Audit Log Entry:__ `SUBMIT_LONG_TERM_BIDS`
tags:
- auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- MANAGE_LT_AUCTION_BIDS
x-audit-log: SUBMIT_LONG_TERM_BIDS
parameters:
- $ref: '#/components/parameters/Identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitLongTermBidsRequest'
responses:
'204':
$ref: '#/components/responses/NoContent'
'400':
description: |-
__Bad Request__
* `TIMESCALE_MISMATCH` - endpoint matching Auction timescale need to be used
* `BIDDING_NOT_POSSIBLE`
- bidding is only possible when the Auction is in the following statuses:
- PRELIMINARY_SPEC_PUBLISHED (only if `preBiddingAllowed` is TRUE)
- FINAL_SPEC_PUBLISHED (only if `preBiddingAllowed` is TRUE)
- BIDDING_OPEN
* `CREDIT_LIMIT_EXCEEDED` - Participant's "credit limit" is already exceeded, no bidding is possible
* `CREDIT_LIMIT_TO_BE_EXCEECED` - if submitting and winning this bid, the Participants "credit limit" would be exceeded
x-errors:
- code: TIMESCALE_MISMATCH
description: endpoint matching Auction timescale need to be used
- code: BIDDING_NOT_POSSIBLE
description: |
- bidding is only possible when the Auction is in the following statuses:
- PRELIMINARY_SPEC_PUBLISHED (only if `preBiddingAllowed` is TRUE)
- FINAL_SPEC_PUBLISHED (only if `preBiddingAllowed` is TRUE)
- BIDDING_OPEN
- code: CREDIT_LIMIT_EXCEEDED
description: Participant's "credit limit" is already exceeded, no bidding is possible
- code: CREDIT_LIMIT_TO_BE_EXCEECED
description: if submitting and winning this bid, the Participants "credit limit" would be exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
description: |-
__Unprocessable Entity__
* `INVALID_BID_ID`
- bid to be updated is invalid, either:
- non-existing in the system
- not part of the given Auction
- does not belong to the given Participant
* `INVALID_BID_CAPACITY`
- capacity for long-term bid
- must be greater than zero
- must be a multiply of the Auction's allocation resolution
- must be less than or equal to the "maximum bid capacity" in the Partcipant's Bidding Configuration for the Auction's border direction
* `INVALID_BID_PRICE`
- depending on "minimum bid price" being configured for the Auction:
* if NOT set: must be greater than or equal to zero
* if set: must be greater than or equal to the configured "minimum bid price"
- must be less than or equal to the "maximum bid price" in the Participant's Bidding Configuration for the Auction's border direction
- price value must be unique across all bids for the given Auction
* `TOO_MANY_BIDS`
- you cannot enter more bids than the configured "maximum bid count per participants" for the Aucion
x-errors:
- code: INVALID_BID_ID
description: |
- bid to be updated is invalid, either:
- non-existing in the system
- not part of the given Auction
- does not belong to the given Participant
- code: INVALID_BID_CAPACITY
description: |
- capacity for long-term bid
- must be greater than zero
- must be a multiply of the Auction's allocation resolution
- must be less than or equal to the "maximum bid capacity" in the Partcipant's Bidding Configuration for the Auction's border direction
- code: INVALID_BID_PRICE
description: |
- depending on "minimum bid price" being configured for the Auction:
* if NOT set: must be greater than or equal to zero
* if set: must be greater than or equal to the configured "minimum bid price"
- must be less than or equal to the "maximum bid price" in the Participant's Bidding Configuration for the Auction's border direction
- price value must be unique across all bids for the given Auction
- code: TOO_MANY_BIDS
description: |
- you cannot enter more bids than the configured "maximum bid count per participants" for the Aucion
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/auctions/day-ahead-or-intra-day/{id}/bids:
get:
operationId: getDayAheadOrIntraDayAuctionBids
description: |-
Fetch Bids for a Day Ahead or an Intra Day Auction by its identifier
---
__Requires Permission:__ (at least one)
* `MANAGE_DA_ID_AUCTION_BIDS`
tags:
- auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- MANAGE_DA_ID_AUCTION_BIDS
parameters:
- $ref: '#/components/parameters/Identifier'
responses:
'200':
description: __OK__
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DayAheadOrIntraDayAuctionBidGroup'
'400':
description: |-
__Bad Request__
* `TIMESCALE_MISMATCH` - endpoint matching Auction timescale need to be used
x-errors:
- code: TIMESCALE_MISMATCH
description: endpoint matching Auction timescale need to be used
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
put:
operationId: submitDayAheadOrIntraDayAuctionBids
description: |-
Submit a collection of Bids for Day Ahead or Intra Day Auctions
Rules for creating/updating/deleting Bids:
- a full list of every valid bid need to be always submitted
- Bids that are not yet present in the system need to be sent with NULL identifiers
- Bids to be edited need to be sent with their respective identifiers
- Bids to be deleted need to be left out from the list to be submitted
---
__Requires Permission:__ (at least one)
* `MANAGE_DA_ID_AUCTION_BIDS`
__Generates Audit Log Entry:__ `SUBMIT_DAY_AHEAD_OR_INTRA_DAY_BIDS`
tags:
- auction
security:
- ApiKey: []
- AuthToken: []
x-permissions:
- MANAGE_DA_ID_AUCTION_BIDS
x-audit-log: SUBMIT_DAY_AHEAD_OR_INTRA_DAY_BIDS
parameters:
- $ref: '#/components/parameters/Identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SubmitDayAheadOrIntraDayBidsRequest'
responses:
'204':
$ref: '#/components/responses/NoContent'
'400':
description: |-
__Bad Request__
* `TIMESCALE_MISMATCH` - endpoint matching Auction timescale need to be used
* `BIDDING_NOT_POSSIBLE` - bidding is only possible between PRELIMINARY_SPEC_PUBLISHED and BIDDING_CLOSED Auction states
* `CREDIT_LIMIT_EXCEEDED` - participant's "credit limit" is already exceeded, no bidding is possible
* `CREDIT_LIMIT_TO_BE_EXCEECED` - if submitting and winning this bid, the Participants "credit limit" would be exceeded
x-errors:
- code: TIMESCALE_MISMATCH
description: endpoint matching Auction timescale need to be used
- code: BIDDING_NOT_POSSIBLE
description: bidding is only possible between PRELIMINARY_SPEC_PUBLISHED and BIDDING_CLOSED Auction states
- code: CREDIT_LIMIT_EXCEEDED
description: participant's "credit limit" is already exceeded, no bidding is possible
- code: CREDIT_LIMIT_TO_BE_EXCEECED
description: if submitting and winning this bid, the Participants "credit limit" would be exceeded
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
description: |-
__Unprocessable Entity__
* `INVALID_BID_ID`
- bid to be updated is invalid, either:
- non-existing in the system
- not part of the given Auction
- does not belong to the given Participant
* `INVALID_BID_CAPACITY`
- capacity for day ahead or intra-day bid
- must be greater than or equal to zero
- must be a multiply of the Auction's allocation resolution
* `INVALID_BID_PRICE`
- must be greater than or equal to the configured "minimum bid price" for the Auction
- price value for a given MTU must be unique across all bid groups for the given Auction
* `TOO_MANY_BIDS`
- you cannot enter more bids than the configured "maximum bid count per participants" for the Aucion for the Auction's border direction
* `MTU_LIST_MISALIGNED`
- in the `bids` arra
- one or more MTU start times are not aligned to MTU borders (considering MTU size)
- the number of MTUs defined does not match the required number (pay special attention to daylight saving changes!)
x-errors:
- code: INVALID_BID_ID
description: |
- bid to be updated is invalid, either:
- non-existing in the system
- not part of the given Auction
- does not belong to the given Participant
- code: INVALID_BID_CAPACITY
description: |
- capacity for day ahead or intra-day bid
- must be greater than or equal to zero
- must be a multiply of the Auction's allocation resolution
- code: INVALID_BID_PRICE
description: |
- must be greater than or equal to the configured "minimum bid price" for the Auction
- price value for a given MTU must be unique across all bid groups for the given Auction
- code: TOO_MANY_BIDS
description: |
- you cannot enter more bids than the configured "maximum bid count per participants" for the Aucion for the Auction's border direction
- code: MTU_LIST_MISALIGNED
description: |
- in the `bids` arra
- one or more MTU start times are not aligned to MTU borders (considering MTU size)
- the number of MTUs defined does not match the required number (pay special attention to daylight saving changes!)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/v1/auctions/long-term/{id}/results: