forked from admin-shell-io/aas-specs-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
911 lines (907 loc) · 35.4 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
# OpenAPI version identifier - required for OpenAPI 3.0 domains
openapi: 3.0.3
info:
title: DotAAS Part 2 | API | Schemas
description: >-
The schemas implementing the [Specification of the Asset Administration Shell: Part 2](http://industrialdigitaltwin.org/en/content-hub).
Publisher: Industrial Digital Twin Association (IDTA) 2023
contact:
name: Industrial Digital Twin Association (IDTA)
email: [email protected]
license:
name: CC BY 4.0
url: https://creativecommons.org/licenses/by/4.0/
version: V3.0.1
components:
parameters:
AssetAdministrationShellIdentifier:
name: aasIdentifier
in: path
description: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
required: true
style: simple
explode: false
schema:
type: string
format: byte
AssetKind:
name: assetKind
in: query
required: false
description: The Asset's kind (Instance or Type)
schema:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/AssetKind"
AssetIds:
name: assetIds
in: query
description: A list of specific Asset identifiers. Each Asset identifier is a base64-url-encoded [SpecificAssetId](https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/SpecificAssetId)
required: false
style: form
explode: true
schema:
type: array
items:
type: string
format: byte
example: '?assetIds=eyAibmFtZSI6ICJzb21lLWFzc2V0LWlkIiwgInZhbHVlIjogImh0dHA6Ly9leGFtcGxlLWNvbXBhbnkuY29tL215QXNzZXQiLCAiZXh0ZXJuYWxTdWJqZWN0SWQiOiB7ICJrZXlzIjogWyB7ICJ0eXBlIjogIkdsb2JhbFJlZmVyZW5jZSIsICJ2YWx1ZSI6ICJodHRwOi8vZXhhbXBsZS1jb21wYW55LmNvbS9leGFtcGxlLWNvbXBhbnlzLWFzc2V0LWtleXMiIH0gXSwgInR5cGUiOiAiR2xvYmFsUmVmZXJlbmNlIiB9IH0&assetIds=eyAibmFtZSI6ICJzb21lLW90aGVyLWFzc2V0LWlkIiwgInZhbHVlIjogIjEyMzQ1QUJDIiwgImV4dGVybmFsU3ViamVjdElkIjogeyAia2V5cyI6IFsgeyAidHlwZSI6ICJHbG9iYWxSZWZlcmVuY2UiLCAidmFsdWUiOiAiaHR0cDovL215LW93bi1jb21wYW55LmNvbS9rZXlzIiB9IF0sICJ0eXBlIjogIkdsb2JhbFJlZmVyZW5jZSIgfSB9'
AssetType:
name: assetType
in: query
description: The Asset's type (UTF8-BASE64-URL-encoded)
required: false
schema:
type: string
minLength: 1
maxLength: 2000
pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
Cursor:
name: cursor
in: query
description: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
required: false
schema:
type: string
Extent:
name: extent
in: query
description: Determines to which extent the resource is being serialized
required: false
schema:
type: string
default: withoutBlobValue
enum:
- withBlobValue
- withoutBlobValue
HandleId:
name: handleId
in: path
description: The returned handle id of an operation’s asynchronous invocation used to request the current state of the operation’s execution (UTF8-BASE64-URL-encoded)
required: true
style: simple
explode: false
schema:
type: string
format: byte
IdShort:
name: idShort
in: query
description: The Asset Administration Shell’s IdShort
required: false
style: form
explode: true
schema:
type: string
IdShortPath:
name: idShortPath
in: path
description: IdShort path to the submodel element (dot-separated)
required: true
style: simple
explode: false
schema:
type: string
Level:
name: level
in: query
description: Determines the structural depth of the respective resource content
required: false
schema:
type: string
default: deep
enum:
- deep
- core
Limit:
name: limit
in: query
description: The maximum number of elements in the response array
required: false
schema:
type: integer
minimum: 1
SemanticId:
name: semanticId
in: query
description: The value of the semantic id reference (BASE64-URL-encoded)
schema:
type: string
maxLength: 3072
minLength: 1
SubmodelIdentifier:
name: submodelIdentifier
in: path
description: The Submodel’s unique id (UTF8-BASE64-URL-encoded)
required: true
style: simple
explode: false
schema:
type: string
format: byte
schemas:
AnnotatedRelationshipElementMetadata:
$ref: "#/components/schemas/SubmodelElementAttributes"
AnnotatedRelationshipElementValue:
properties:
first:
$ref: "#/components/schemas/ReferenceValue"
second:
$ref: "#/components/schemas/ReferenceValue"
annotations:
type: array
items:
$ref: "#/components/schemas/ValueOnly"
required:
- first
- second
type: object
AssetAdministrationShellDescriptor:
allOf:
- $ref: "#/components/schemas/Descriptor"
- properties:
administration:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/AdministrativeInformation"
assetKind:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/AssetKind"
assetType:
type: string
minLength: 1
maxLength: 2000
pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
endpoints:
items:
$ref: "#/components/schemas/Endpoint"
minItems: 1
type: array
globalAssetId:
type: string
minLength: 1
maxLength: 2000
pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
idShort:
type: string
maxLength: 128
id:
type: string
maxLength: 2000
minLength: 1
pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
specificAssetIds:
type: array
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/SpecificAssetId"
submodelDescriptors:
items:
$ref: "#/components/schemas/SubmodelDescriptor"
type: array
required:
- id
type: object
example: '{ "id": "https://example.org/aas/motor", "endpoints": [ { "protocolInformation": { "href": "https://localhost:1234/api/v3.0/aas", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"] }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "opc.tcp://localhost:4840" }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "https://localhost:5678", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"], "subprotocol": "OPC UA Basic SOAP", "subprotocolBody": "ns=2;s=MyAAS", "subprotocolBodyEncoding": "application/soap+xml" }, "interface": "AAS-3.0" } ] }'
AssetAdministrationShellMetadata:
allOf:
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Identifiable"
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/HasDataSpecification"
- properties:
derivedFrom:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Reference"
BaseOperationResult:
allOf:
- $ref: "#/components/schemas/Result"
- properties:
executionState:
$ref: "#/components/schemas/ExecutionState"
success:
type: boolean
BasicEventElementMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
- properties:
direction:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Direction"
state:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/StateOfEvent"
messageTopic:
type: string
maxLength: 255
messageBroker:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Reference"
lastUpdate:
type: string
minInterval:
type: string
maxInterval:
type: string
BasicEventElementValue:
properties:
observed:
$ref: "#/components/schemas/ReferenceValue"
required:
- observed
type: object
BlobMetadata:
$ref: "#/components/schemas/SubmodelElementAttributes"
BlobValue:
properties:
contentType:
type: string
minLength: 1
maxLength: 100
value:
type: string
required:
- contentType
- value
type: object
BooleanValue:
type: boolean
CapabilityMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
Descriptor:
example: '{ "endpoints": [ { "protocolInformation": { "href": "https://localhost:1234/api/v3.0/aas", "endpointProtocolVersion": ["1.1"] }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "opc.tcp://localhost:4840" }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "https://localhost:5678", "endpointProtocolVersion": ["1.1"], "subprotocol": "OPC UA Basic SOAP", "subprotocolBody": "ns=2;s=MyAAS", "subprotocolBodyEncoding": "application/soap+xml" }, "interface": "AAS-3.0" } ] }'
properties:
description:
type: array
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/LangStringTextType"
displayName:
type: array
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/LangStringNameType"
extensions:
type: array
items:
"$ref": "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Extension"
minItems: 1
type: object
Endpoint:
properties:
interface:
type: string
maxLength: 128
protocolInformation:
$ref: "#/components/schemas/ProtocolInformation"
required:
- protocolInformation
- interface
type: object
EntityMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
EntityValue:
properties:
entityType:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/EntityType"
globalAssetId:
type: string
minLength: 1
maxLength: 2000
pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
specificAssetIds:
type: array
items:
$ref: "#/components/schemas/SpecificAssetIdValue"
statements:
items:
$ref: "#/components/schemas/ValueOnly"
type: array
required:
- statements
- entityType
type: object
ExecutionState:
enum:
- Initiated
- Running
- Completed
- Canceled
- Failed
- Timeout
type: string
FileValue:
properties:
contentType:
type: string
minLength: 1
maxLength: 100
value:
type: string
minLength: 1
maxLength: 2000
required:
- contentType
- value
type: object
FileMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
GetAssetAdministrationShellDescriptorsResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "#/components/schemas/AssetAdministrationShellDescriptor"
GetAssetAdministrationShellsMetadataResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "#/components/schemas/AssetAdministrationShellMetadata"
GetAssetAdministrationShellsResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/AssetAdministrationShell"
GetConceptDescriptionsResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/ConceptDescription"
GetPackageDescriptionsResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "#/components/schemas/PackageDescription"
GetPathItemsResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "#/components/schemas/PathItem"
GetReferencesResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Reference"
GetSubmodelDescriptorsResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "#/components/schemas/SubmodelDescriptor"
GetSubmodelElementsMetadataResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "#/components/schemas/SubmodelElementMetadata"
GetSubmodelElementsResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/SubmodelElement"
GetSubmodelElementsValueResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "#/components/schemas/SubmodelElementValue"
GetSubmodelsMetadataResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "#/components/schemas/SubmodelMetadata"
GetSubmodelsResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Submodel"
GetSubmodelsValueResult:
allOf:
- $ref: '#/components/schemas/PagedResult'
- type: object
properties:
result:
type: array
items:
$ref: "#/components/schemas/SubmodelValue"
Message:
properties:
code:
type: string
maxLength: 32
minLength: 1
correlationId:
type: string
maxLength: 128
minLength: 1
messageType:
enum:
- Undefined
- Info
- Warning
- Error
- Exception
type: string
text:
type: string
timestamp:
type: string
pattern: "^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\\.[0-9]+)?)|24:00:00(\\.0+)?)(Z|\\+00:00|-00:00)$"
type: object
MultiLanguagePropertyMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
MultiLanguagePropertyValue:
type: object
description: Since patternProperties and propertyNames are not supported by OpenApi yet, the ValueOnly serialization for this elements works with the key-attribute as the JSON-property name and the value-attribute as the corresponding value.
NumberValue:
type: number
OperationHandle:
properties:
handleId:
type: string
maxLength: 128
type: object
OperationMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
OperationRequest:
properties:
inoutputArguments:
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/OperationVariable"
type: array
inputArguments:
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/OperationVariable"
type: array
clientTimeoutDuration:
type: string
pattern: "^(-?)P(?=.)((\\d+)Y)?((\\d+)M)?((\\d+)D)?(T(?=.)((\\d+)H)?((\\d+)M)?(\\d*(\\.\\d+)?S)?)?$"
type: object
OperationRequestValueOnly:
properties:
inoutputArguments:
$ref: "#/components/schemas/ValueOnly"
inputArguments:
$ref: "#/components/schemas/ValueOnly"
clientTimeoutDuration:
type: string
pattern: "^(-?)P(?=.)((\\d+)Y)?((\\d+)M)?((\\d+)D)?(T(?=.)((\\d+)H)?((\\d+)M)?(\\d*(\\.\\d+)?S)?)?$"
type: object
required:
- clientTimeoutDuration
OperationResult:
allOf:
- $ref: '#/components/schemas/BaseOperationResult'
- properties:
inoutputArguments:
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/OperationVariable"
type: array
outputArguments:
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/OperationVariable"
type: array
type: object
OperationResultValueOnly:
allOf:
- $ref: '#/components/schemas/BaseOperationResult'
- properties:
inoutputArguments:
$ref: "#/components/schemas/ValueOnly"
outputArguments:
$ref: "#/components/schemas/ValueOnly"
type: object
PagedResult:
type: object
properties:
paging_metadata:
type: object
properties:
cursor:
type: string
example: wJlCDLIl6KTWypN7T6vc6nWEmEYe99Hjf1XY1xmqV-M=#
PackageDescription:
properties:
aasIds:
items:
type: string
pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
maxLength: 2000
type: array
packageId:
type: string
maxLength: 128
type: object
PathItem:
type: string
pattern: "[A-Za-z][A-Za-z0-9_]+(\\.[A-Za-z][A-Za-z0-9_]+){0,}"
PropertyMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
properties:
valueType:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/DataTypeDefXsd"
PropertyValue:
oneOf:
- $ref: "#/components/schemas/StringValue"
- $ref: "#/components/schemas/NumberValue"
- $ref: "#/components/schemas/BooleanValue"
ProtocolInformation:
properties:
href:
type: string
maxLength: 2048
endpointProtocol:
type: string
maxLength: 128
endpointProtocolVersion:
type: array
items:
type: string
maxLength: 128
subprotocol:
type: string
maxLength: 128
subprotocolBody:
type: string
maxLength: 128
subprotocolBodyEncoding:
type: string
maxLength: 128
securityAttributes:
type: array
items:
type: object
properties:
type:
type: string
enum:
- "NONE"
- "RFC_TLSA"
- "W3C_DID"
key:
type: string
value:
type: string
required:
- type
- key
- value
minItems: 1
# TODO: align with content of the part 2 document
required:
- href
type: object
RangeMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
properties:
valueType:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/DataTypeDefXsd"
RangeValue:
properties:
max:
type: number
min:
type: number
required:
- min
- max
type: object
ReferenceElementMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
ReferenceElementValue:
$ref: "#/components/schemas/ReferenceValue"
ReferenceValue:
type: object
properties:
type:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/ReferenceTypes"
keys:
type: array
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Key"
RelationshipElementMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
RelationshipElementValue:
properties:
first:
$ref: "#/components/schemas/ReferenceValue"
second:
$ref: "#/components/schemas/ReferenceValue"
required:
- first
- second
type: object
Result:
properties:
messages:
items:
$ref: "#/components/schemas/Message"
type: array
type: object
ServiceDescription:
description: The Description object enables servers to present their capabilities to the clients, in particular which profiles they implement. At least one defined profile is required. Additional, proprietary attributes might be included. Nevertheless, the server must not expect that a regular client understands them.
example: >-
{
"profiles": [
"https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002",
"https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002"
]
}
properties:
profiles:
type: array
minItems: 1
items:
type: string
enum:
- "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-001"
- "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellServiceSpecification/SSP-002"
- "https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-001"
- "https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-002"
- "https://admin-shell.io/aas/API/3/0/SubmodelServiceSpecification/SSP-003"
- "https://admin-shell.io/aas/API/3/0/AasxFileServerServiceSpecification/SSP-001"
- "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-001"
- "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRegistryServiceSpecification/SSP-002"
- "https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-001"
- "https://admin-shell.io/aas/API/3/0/SubmodelRegistryServiceSpecification/SSP-002"
- "https://admin-shell.io/aas/API/3/0/DiscoveryServiceSpecification/SSP-001"
- "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-001"
- "https://admin-shell.io/aas/API/3/0/AssetAdministrationShellRepositoryServiceSpecification/SSP-002"
- "https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-001"
- "https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-002"
- "https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-003"
- "https://admin-shell.io/aas/API/3/0/SubmodelRepositoryServiceSpecification/SSP-004"
- "https://admin-shell.io/aas/API/3/0/ConceptDescriptionServiceSpecification/SSP-001"
type: object
SpecificAssetIdValue:
type: object
description: Since patternProperties and propertyNames are not supported by OpenApi yet, the ValueOnly serialization for this elements works with the key-attribute as the JSON-property name and the value-attribute as the corresponding value.
StringValue:
type: string
SubmodelDescriptor:
allOf:
- $ref: "#/components/schemas/Descriptor"
properties:
administration:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/AdministrativeInformation"
endpoints:
items:
$ref: "#/components/schemas/Endpoint"
minItems: 1
type: array
idShort:
type: string
maxLength: 128
id:
type: string
minLength: 1
maxLength: 2000
pattern: "^[\\x09\\x0A\\x0D\\x20-\\uD7FF\\uE000-\\uFFFD\\U00010000-\\U0010FFFF]*$"
semanticId:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Reference"
supplementalSemanticId:
type: array
items:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Reference"
minItems: 1
required:
- id
- endpoints
type: object
example: '{ "id": "https://admin-shell.io/zvei/nameplate/1/0/Nameplate", "endpoints": [ { "href": { "href": "https://localhost:1234/api/v3.0/submodel", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"] }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "opc.tcp://localhost:4840" }, "interface": "AAS-3.0" }, { "protocolInformation": { "href": "https://localhost:5678", "endpointProtocol": "HTTP", "endpointProtocolVersion": ["1.1"], "subprotocol": "OPC UA Basic SOAP", "subprotocolBody": "ns=2;s=MyAAS", "subprotocolBodyEncoding": "application/soap+xml" }, "interface": "AAS-3.0" } ] }'
SubmodelElementAttributes:
allOf:
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Referable"
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/HasDataSpecification"
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/HasSemantics"
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Qualifiable"
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/HasKind"
SubmodelElementListMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
properties:
orderRelevant:
type: boolean
semanticIdListElement:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Reference"
typeValueListElement:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/ModelType"
valueTypeListElement:
$ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/DataTypeDefXsd"
SubmodelElementListValue:
type: array
items:
$ref: "#/components/schemas/SubmodelElementValue"
SubmodelElementCollectionMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
SubmodelElementCollectionValue:
type: object
description: Since patternProperties and propertyNames are not supported by OpenApi yet, the ValueOnly serialization for this elements works with the key-attribute as the JSON-property name and the value-attribute as the corresponding value.
SubmodelElementMetadata:
allOf:
- $ref: "#/components/schemas/SubmodelElementAttributes"
oneOf:
- $ref: "#/components/schemas/BlobMetadata"
- $ref: "#/components/schemas/FileMetadata"
- $ref: "#/components/schemas/CapabilityMetadata"
- $ref: "#/components/schemas/EntityMetadata"
- $ref: "#/components/schemas/BasicEventElementMetadata"
- $ref: "#/components/schemas/MultiLanguagePropertyMetadata"
- $ref: "#/components/schemas/OperationMetadata"
- $ref: "#/components/schemas/PropertyMetadata"
- $ref: "#/components/schemas/RangeMetadata"
- $ref: "#/components/schemas/ReferenceElementMetadata"
- $ref: "#/components/schemas/AnnotatedRelationshipElementMetadata"
- $ref: "#/components/schemas/RelationshipElementMetadata"
- $ref: "#/components/schemas/SubmodelElementListMetadata"
- $ref: "#/components/schemas/SubmodelElementCollectionMetadata"
SubmodelElementValue:
oneOf:
- $ref: "#/components/schemas/BasicEventElementValue"
- $ref: "#/components/schemas/PropertyValue"
- $ref: "#/components/schemas/MultiLanguagePropertyValue"
- $ref: "#/components/schemas/BlobValue"
- $ref: "#/components/schemas/FileValue"
- $ref: "#/components/schemas/RangeValue"
- $ref: "#/components/schemas/ReferenceElementValue"
- $ref: "#/components/schemas/RelationshipElementValue"
- $ref: "#/components/schemas/AnnotatedRelationshipElementValue"
- $ref: "#/components/schemas/EntityValue"
- $ref: "#/components/schemas/SubmodelElementCollectionValue"
- $ref: "#/components/schemas/SubmodelElementListValue"
SubmodelMetadata:
allOf:
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Identifiable"
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/HasDataSpecification"
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/Qualifiable"
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/HasSemantics"
- $ref: "https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/HasKind"
SubmodelValue:
properties:
submodelElements:
type: array
items:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/SubmodelElement'
minItems: 1
ValueOnly:
description: "The ValueOnly serialization of submodel elements (patternProperties and propertyNames will be supported propably with OpenApi 3.1). The full description of the generic JSON validation schema for the ValueOnly-serialization can be found in chapter 11.4.3 in Details of the Asset Administration Shell Part 2.\n"
type: object
responses:
'accepted':
description: The server has accepted the request.
headers:
Location:
description: The URL where the client can find more information about the request.
schema:
type: string
'no-content':
description: No Content, request was successful but no content is returned
content:
application/json:
schema:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.1#/components/schemas/AssetAdministrationShell'
'found':
description: The target resource is available but at a different location.
headers:
Location:
description: The URL where the client can find the target resource.
schema:
type: string
'bad-request':
description: Bad Request, e.g. the request parameters of the format of the request body is wrong.
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
'unauthorized':
description: Unauthorized, e.g. the server refused the authorization attempt.
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
'forbidden':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
'not-found':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
'method-not-allowed':
description: Method Not Allowed, the server does not offer this method for the client
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
'conflict':
description: Conflict, a resource which shall be created exists already. Might be thrown if a Submodel or SubmodelElement with the same ShortId is contained in a POST request.
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
'internal-server-error':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
'not-implemented':
description: Method Not Implemented by the server
content:
application/json:
schema:
$ref: '#/components/schemas/Result'
'default':
description: Default error handling for unmentioned status codes
content:
application/json:
schema:
$ref: '#/components/schemas/Result'