forked from eclipse-tractusx/bpdm
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgate.yaml
1857 lines (1857 loc) · 55.8 KB
/
gate.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.1
info:
title: Business Partner Data Management Gate
description: A gate for a member to share business partner data with CatenaX
version: 6.3.0-SNAPSHOT
servers:
- url: http://localhost:8081
description: Generated server url
security:
- open_id_scheme: []
- bearer_scheme: []
paths:
/v6/input/business-partners:
put:
tags:
- business-partner-controller
summary: Create or update business partner with given external ID
description: Create or update generic business partner. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of business partners in the request is limited to 100 entries.
operationId: upsertBusinessPartnersInput
requestBody:
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BusinessPartnerInputRequest'
required: true
responses:
'200':
description: Business partner were successfully updated or created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BusinessPartnerInputDto'
'400':
description: On malformed legal entity request
/v6/sharing-state/ready:
post:
tags:
- sharing-state-controller
summary: Sets the given business partners into ready to be shared state
description: The business partners to set the ready state for are identified by their external-id. Only business partners in an initial or error state can be set to ready. If any given business partner could not be set into ready state for any reason (for example, it has not been found or it is in the wrong state) the whole request fails (all or nothing approach).
operationId: postSharingStateReady
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PostSharingStateReadyRequest'
required: true
responses:
'204':
description: All business partners put in ready to be shared state
'400':
description: Business partners can't be put into ready state (e.g. external-ID not found, wrong sharing state)
/v6/output/changelog/search:
post:
tags:
- changelog-controller
summary: Returns changelog entries for changes to the business partner output stage
description: Returns changelog entries as of a specified timestamp from the output stage, optionally filtered by timestamp, an array of external IDs and a business partner type.
operationId: getOutputChangelog
parameters:
- name: page
in: query
description: Number of page to get results from
required: false
schema:
minimum: 0
type: string
default: '0'
- name: size
in: query
description: Size of each page
required: false
schema:
maximum: 100
minimum: 0
type: string
default: '10'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangelogSearchRequest'
required: true
responses:
'200':
description: The changelog entries for the specified parameters
content:
application/json:
schema:
$ref: '#/components/schemas/PageChangeLogDtoChangelogGateDto'
'400':
description: On malformed pagination request
/v6/output/business-partners/search:
post:
tags:
- business-partner-controller
summary: Search business partners by an array of external IDs from the output stage
description: Get page of business partners output data filtered by a collection of external IDs. An empty external ID list will return a paginated list of all business partners.
operationId: getBusinessPartnersOutput
parameters:
- name: page
in: query
description: Number of page to get results from
required: false
schema:
minimum: 0
type: string
default: '0'
- name: size
in: query
description: Size of each page
required: false
schema:
maximum: 100
minimum: 0
type: string
default: '10'
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
responses:
'200':
description: The requested page of business partners
content:
application/json:
schema:
$ref: '#/components/schemas/PageDtoBusinessPartnerOutputDto'
'400':
description: On malformed pagination request
/v6/input/partner-upload-process:
post:
tags:
- partner-upload-controller
summary: Create or update business partners from uploaded CSV file
description: 'Create or update generic business partners. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a requested file. '
operationId: uploadPartnerCsvFile
requestBody:
content:
multipart/form-data:
schema:
required:
- file
type: object
properties:
file:
type: string
format: binary
responses:
'200':
description: Business partners were successfully updated or created
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BusinessPartnerInputDto'
multipart/form-data:
schema:
type: array
items:
$ref: '#/components/schemas/BusinessPartnerInputDto'
'400':
description: On malformed Business partner upload request
content:
application/json:
schema:
$ref: '#/components/schemas/PartnerUploadErrorResponse'
/v6/input/changelog/search:
post:
tags:
- changelog-controller
summary: Returns changelog entries for changes to the business partner input stage
description: Returns changelog entries as of a specified timestamp from the input stage, optionally filtered by timestamp, an array of external IDs and a business partner type.
operationId: getInputChangelog
parameters:
- name: page
in: query
description: Number of page to get results from
required: false
schema:
minimum: 0
type: string
default: '0'
- name: size
in: query
description: Size of each page
required: false
schema:
maximum: 100
minimum: 0
type: string
default: '10'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangelogSearchRequest'
required: true
responses:
'200':
description: The changelog entries for the specified parameters
content:
application/json:
schema:
$ref: '#/components/schemas/PageChangeLogDtoChangelogGateDto'
'400':
description: On malformed pagination request
/v6/input/business-partners/search:
post:
tags:
- business-partner-controller
summary: Search business partner by external ID. An empty external ID list returns a paginated list of all business partners.
description: Get page of business partners filtered by a collection of external IDs.
operationId: getBusinessPartnersInput
parameters:
- name: page
in: query
description: Number of page to get results from
required: false
schema:
minimum: 0
type: string
default: '0'
- name: size
in: query
description: Size of each page
required: false
schema:
maximum: 100
minimum: 0
type: string
default: '10'
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
responses:
'200':
description: The requested page of busines partners
content:
application/json:
schema:
$ref: '#/components/schemas/PageDtoBusinessPartnerInputDto'
'400':
description: On malformed pagination request
/v6/stats/{stage}/address-types:
get:
tags:
- stats-controller
operationId: countAddressTypes
parameters:
- name: stage
in: path
required: true
schema:
type: string
enum:
- Input
- Output
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/StatsAddressTypesResponse'
/v6/stats/stages:
get:
tags:
- stats-controller
operationId: countPartnersPerStage
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/StatsStagesResponse'
/v6/stats/sharing-states:
get:
tags:
- stats-controller
operationId: countPartnersBySharingState
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/StatsSharingStatesResponse'
/v6/stats/confidence-criteria:
get:
tags:
- stats-controller
operationId: getConfidenceCriteriaStats
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/StatsConfidenceCriteriaResponse'
/v6/sharing-state:
get:
tags:
- sharing-state-controller
summary: Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs
operationId: getSharingStates
parameters:
- name: page
in: query
description: Number of page to get results from
required: false
schema:
minimum: 0
type: string
default: '0'
- name: size
in: query
description: Size of each page
required: false
schema:
maximum: 100
minimum: 0
type: string
default: '10'
- name: externalIds
in: query
description: External IDs
required: false
schema:
type: array
items:
type: string
responses:
'200':
description: Page of sharing states
content:
application/json:
schema:
$ref: '#/components/schemas/PageDtoSharingStateDto'
/v6/input/partner-upload-template:
get:
tags:
- partner-upload-controller
summary: Get CSV template with headers in file
description: Create empty CSV file template including headers.Generated CSV file can later be used for uploading business partner data.
operationId: getPartnerCsvTemplate
responses:
'200':
description: CSV file template generated successfully
content:
application/json:
schema:
type: string
format: binary
multipart/form-data:
schema:
type: string
format: binary
components:
schemas:
AddressComponentOutputDto:
required:
- addressBpn
- bpnA
- confidenceCriteria
- physicalPostalAddress
- states
type: object
properties:
addressBpn:
type: string
description: The BPNA of the address, on which the business partner provides a view.
name:
type: string
description: The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance.
addressType:
type: string
description: 'One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. '
enum:
- LegalAndSiteMainAddress
- LegalAddress
- SiteMainAddress
- AdditionalAddress
physicalPostalAddress:
$ref: '#/components/schemas/PhysicalPostalAddressDto'
alternativePostalAddress:
$ref: '#/components/schemas/AlternativePostalAddressDto'
confidenceCriteria:
$ref: '#/components/schemas/ConfidenceCriteriaDto'
states:
type: array
items:
$ref: '#/components/schemas/BusinessPartnerStateDto'
description: Address properties of business partner output data
AddressRepresentationInputDto:
required:
- physicalPostalAddress
- states
type: object
properties:
addressBpn:
type: string
description: The BPNA of the address, on which the business partner provides a view.
name:
type: string
description: The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance.
addressType:
type: string
description: 'One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. '
enum:
- LegalAndSiteMainAddress
- LegalAddress
- SiteMainAddress
- AdditionalAddress
physicalPostalAddress:
$ref: '#/components/schemas/PhysicalPostalAddressDto'
alternativePostalAddress:
$ref: '#/components/schemas/AlternativePostalAddressDto'
states:
type: array
items:
$ref: '#/components/schemas/BusinessPartnerStateDto'
description: 'The address, on which the business partner provides a view. '
AlternativePostalAddressDto:
type: object
properties:
geographicCoordinates:
$ref: '#/components/schemas/GeoCoordinateDto'
country:
type: string
description: The 2-digit country code of the physical postal address according to ISO 3166-1.
enum:
- UNDEFINED
- AC
- AD
- AE
- AF
- AG
- AI
- AL
- AM
- AN
- AO
- AQ
- AR
- AS
- AT
- AU
- AW
- AX
- AZ
- BA
- BB
- BD
- BE
- BF
- BG
- BH
- BI
- BJ
- BL
- BM
- BN
- BO
- BQ
- BR
- BS
- BT
- BU
- BV
- BW
- BY
- BZ
- CA
- CC
- CD
- CF
- CG
- CH
- CI
- CK
- CL
- CM
- CN
- CO
- CP
- CR
- CS
- CU
- CV
- CW
- CX
- CY
- CZ
- DE
- DG
- DJ
- DK
- DM
- DO
- DZ
- EA
- EC
- EE
- EG
- EH
- ER
- ES
- ET
- EU
- EZ
- FI
- FJ
- FK
- FM
- FO
- FR
- FX
- GA
- GB
- GD
- GE
- GF
- GG
- GH
- GI
- GL
- GM
- GN
- GP
- GQ
- GR
- GS
- GT
- GU
- GW
- GY
- HK
- HM
- HN
- HR
- HT
- HU
- IC
- ID
- IE
- IL
- IM
- IN
- IO
- IQ
- IR
- IS
- IT
- JE
- JM
- JO
- JP
- KE
- KG
- KH
- KI
- KM
- KN
- KP
- KR
- KW
- KY
- KZ
- LA
- LB
- LC
- LI
- LK
- LR
- LS
- LT
- LU
- LV
- LY
- MA
- MC
- MD
- ME
- MF
- MG
- MH
- MK
- ML
- MM
- MN
- MO
- MP
- MQ
- MR
- MS
- MT
- MU
- MV
- MW
- MX
- MY
- MZ
- NA
- NC
- NE
- NF
- NG
- NI
- NL
- 'NO'
- NP
- NR
- NT
- NU
- NZ
- OM
- PA
- PE
- PF
- PG
- PH
- PK
- PL
- PM
- PN
- PR
- PS
- PT
- PW
- PY
- QA
- RE
- RO
- RS
- RU
- RW
- SA
- SB
- SC
- SD
- SE
- SF
- SG
- SH
- SI
- SJ
- SK
- SL
- SM
- SN
- SO
- SR
- SS
- ST
- SU
- SV
- SX
- SY
- SZ
- TA
- TC
- TD
- TF
- TG
- TH
- TJ
- TK
- TL
- TM
- TN
- TO
- TP
- TR
- TT
- TV
- TW
- TZ
- UA
- UG
- UK
- UM
- US
- UY
- UZ
- VA
- VC
- VE
- VG
- VI
- VN
- VU
- WF
- WS
- XI
- XU
- XK
- YE
- YT
- YU
- ZA
- ZM
- ZR
- ZW
administrativeAreaLevel1:
type: string
description: The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
postalCode:
type: string
description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
city:
type: string
description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.'
deliveryServiceType:
type: string
description: 'One of the alternative postal address types: P.O. box, private bag, boite postale.'
enum:
- PO_BOX
- PRIVATE_BAG
- BOITE_POSTALE
deliveryServiceQualifier:
type: string
description: The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.
deliveryServiceNumber:
type: string
description: The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.
description: An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else.
BusinessPartnerIdentifierDto:
type: object
properties:
type:
type: string
description: The type of the identifier.
value:
type: string
description: The value of the identifier like “DE123465789.
issuingBody:
type: string
description: The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart.
BusinessPartnerInputDto:
required:
- address
- bpnA
- bpnL
- createdAt
- externalId
- identifiers
- isOwnCompanyData
- legalEntity
- nameParts
- postalAddress
- roles
- site
- states
- updatedAt
type: object
properties:
externalId:
type: string
description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.
nameParts:
type: array
description: The list of name parts to accommodate the different number of name fields in different systems.
items:
type: string
identifiers:
type: array
description: The list of identifiers of the business partner. Sorted and duplicates removed by the service.
items:
$ref: '#/components/schemas/BusinessPartnerIdentifierDto'
states:
type: array
description: The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.
items:
$ref: '#/components/schemas/BusinessPartnerStateDto'
roles:
type: array
description: 'One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.'
items:
type: string
enum:
- SUPPLIER
- CUSTOMER
- ONE_TIME_SUPPLIER
- ONE_TIME_CUSTOMER
isOwnCompanyData:
type: boolean
description: Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member.
legalEntity:
$ref: '#/components/schemas/LegalEntityRepresentationInputDto'
site:
$ref: '#/components/schemas/SiteRepresentationInputDto'
address:
$ref: '#/components/schemas/AddressRepresentationInputDto'
createdAt:
type: string
description: The date when the data record has been created.
format: date-time
updatedAt:
type: string
description: The date when the data record has been last updated.
format: date-time
description: Generic business partner with external id
BusinessPartnerInputRequest:
required:
- address
- externalId
- identifiers
- isOwnCompanyData
- legalEntity
- nameParts
- roles
- site
- states
type: object
properties:
externalId:
type: string
description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.
nameParts:
type: array
description: The list of name parts to accommodate the different number of name fields in different systems.
items:
type: string
identifiers:
type: array
description: The list of identifiers of the business partner. Sorted and duplicates removed by the service.
items:
$ref: '#/components/schemas/BusinessPartnerIdentifierDto'
states:
type: array
description: The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.
items:
$ref: '#/components/schemas/BusinessPartnerStateDto'
roles:
type: array
description: 'One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.'
items:
type: string
enum:
- SUPPLIER
- CUSTOMER
- ONE_TIME_SUPPLIER
- ONE_TIME_CUSTOMER
isOwnCompanyData:
type: boolean
description: Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member.
legalEntity:
$ref: '#/components/schemas/LegalEntityRepresentationInputDto'
site:
$ref: '#/components/schemas/SiteRepresentationInputDto'
address:
$ref: '#/components/schemas/AddressRepresentationInputDto'
description: Generic business partner with external id
BusinessPartnerOutputDto:
required:
- address
- createdAt
- externalId
- identifiers
- isOwnCompanyData
- legalEntity
- nameParts
- roles
- states
- updatedAt
type: object
properties:
externalId:
type: string
description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.
nameParts:
type: array
description: The list of name parts to accommodate the different number of name fields in different systems.
items:
type: string
identifiers:
type: array
description: The list of identifiers of the business partner. Sorted and duplicates removed by the service.
items:
$ref: '#/components/schemas/BusinessPartnerIdentifierDto'
states:
type: array
description: The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.
items:
$ref: '#/components/schemas/BusinessPartnerStateDto'
roles:
type: array
description: 'One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.'
items:
type: string
enum:
- SUPPLIER
- CUSTOMER
- ONE_TIME_SUPPLIER
- ONE_TIME_CUSTOMER
isOwnCompanyData:
type: boolean
description: Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member.
legalEntity:
$ref: '#/components/schemas/LegalEntityRepresentationOutputDto'
site:
$ref: '#/components/schemas/SiteRepresentationOutputDto'
address:
$ref: '#/components/schemas/AddressComponentOutputDto'
createdAt:
type: string
description: The date when the data record has been created.
format: date-time
updatedAt:
type: string
description: The date when the data record has been last updated.
format: date-time
description: Generic business partner output with external id
BusinessPartnerStateDto:
type: object
properties:
validFrom:
type: string
description: Date since when the status is/was valid.
format: date-time
validTo:
type: string
description: Date until the status was valid, if applicable.
format: date-time
type:
type: string
description: The type of this specified status.
enum:
- ACTIVE
- INACTIVE
ChangelogGateDto:
required:
- changelogType
- externalId
- timestamp
type: object
properties:
externalId:
type: string
description: The external identifier of the business partner for which the changelog entry was created.
timestamp:
type: string
description: The date and time when the changelog entry was created.
format: date-time
changelogType:
type: string
description: 'One of the actions for which the changelog entry was created: create, update.'
enum:
- CREATE
- UPDATE
description: An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included.
ChangelogSearchRequest:
type: object
properties:
timestampAfter:
type: string
description: Only changelog entries created after this time. Ignored if empty.
format: date-time
example: '2023-03-20T10:23:28.194Z'
externalIds:
uniqueItems: true
type: array
description: Only for business partners with the given array of external IDs. Ignored if empty.
items:
type: string
ConfidenceCriteriaDto:
required:
- checkedByExternalDataSource
- confidenceLevel
- lastConfidenceCheckAt
- nextConfidenceCheckAt
- numberOfSharingMembers
- sharedByOwner
type: object
properties:
sharedByOwner:
type: boolean
checkedByExternalDataSource:
type: boolean
numberOfSharingMembers:
type: integer
format: int32
lastConfidenceCheckAt:
type: string
format: date-time
nextConfidenceCheckAt: