basyx-typescript-sdk 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,3786 +0,0 @@
1
- // This file is auto-generated by @hey-api/openapi-ts
2
-
3
- export type GetAssetAdministrationShellsResult = PagedResult & {
4
- result?: Array<AssetAdministrationShell>;
5
- };
6
-
7
- export type PagedResult = {
8
- paging_metadata?: PagedResultPagingMetadata;
9
- };
10
-
11
- export type AssetAdministrationShell = Identifiable & HasDataSpecification & {
12
- derivedFrom?: Reference;
13
- assetInformation: AssetInformation;
14
- submodels?: Array<Reference>;
15
- modelType?: string;
16
- };
17
-
18
- export type Identifiable = Referable & {
19
- administration?: AdministrativeInformation;
20
- id: string;
21
- };
22
-
23
- export type Referable = HasExtensions & {
24
- category?: string;
25
- idShort?: unknown;
26
- displayName?: Array<LangStringNameType>;
27
- description?: Array<LangStringTextType>;
28
- modelType: ModelType;
29
- };
30
-
31
- export type HasExtensions = {
32
- extensions?: Array<Extension>;
33
- };
34
-
35
- export type Extension = HasSemantics & {
36
- name: string;
37
- valueType?: DataTypeDefXsd;
38
- value?: string;
39
- refersTo?: Array<Reference>;
40
- };
41
-
42
- export type HasSemantics = {
43
- semanticId?: Reference;
44
- supplementalSemanticIds?: Array<Reference>;
45
- };
46
-
47
- export type Reference = ReferenceParent & {
48
- referredSemanticId?: ReferenceParent;
49
- };
50
-
51
- export type ReferenceParent = {
52
- type: ReferenceTypes;
53
- keys: Array<Key>;
54
- };
55
-
56
- export type ReferenceTypes = 'ExternalReference' | 'ModelReference';
57
-
58
- export type Key = {
59
- type: KeyTypes;
60
- value: string;
61
- };
62
-
63
- export type KeyTypes = 'AnnotatedRelationshipElement' | 'AssetAdministrationShell' | 'BasicEventElement' | 'AasBlob' | 'Capability' | 'ConceptDescription' | 'DataElement' | 'Entity' | 'EventElement' | 'AasFile' | 'FragmentReference' | 'GlobalReference' | 'Identifiable' | 'MultiLanguageProperty' | 'Operation' | 'Property' | 'Range' | 'Referable' | 'ReferenceElement' | 'RelationshipElement' | 'Submodel' | 'SubmodelElement' | 'SubmodelElementCollection' | 'SubmodelElementList';
64
-
65
- export type DataTypeDefXsd = 'xs:anyURI' | 'xs:base64Binary' | 'xs:boolean' | 'xs:byte' | 'xs:date' | 'xs:dateTime' | 'xs:decimal' | 'xs:double' | 'xs:duration' | 'xs:float' | 'xs:gDay' | 'xs:gMonth' | 'xs:gMonthDay' | 'xs:gYear' | 'xs:gYearMonth' | 'xs:hexBinary' | 'xs:int' | 'xs:integer' | 'xs:long' | 'xs:negativeInteger' | 'xs:nonNegativeInteger' | 'xs:nonPositiveInteger' | 'xs:positiveInteger' | 'xs:short' | 'xs:string' | 'xs:time' | 'xs:unsignedByte' | 'xs:unsignedInt' | 'xs:unsignedLong' | 'xs:unsignedShort';
66
-
67
- export type LangStringNameType = AbstractLangString & {
68
- text?: unknown;
69
- };
70
-
71
- export type AbstractLangString = {
72
- language: string;
73
- text: string;
74
- };
75
-
76
- export type LangStringTextType = AbstractLangString & {
77
- text?: unknown;
78
- };
79
-
80
- export type ModelType = 'AnnotatedRelationshipElement' | 'AssetAdministrationShell' | 'BasicEventElement' | 'AasBlob' | 'Capability' | 'ConceptDescription' | 'DataSpecificationIec61360' | 'Entity' | 'AasFile' | 'MultiLanguageProperty' | 'Operation' | 'Property' | 'Range' | 'ReferenceElement' | 'RelationshipElement' | 'Submodel' | 'SubmodelElementCollection' | 'SubmodelElementList';
81
-
82
- export type AdministrativeInformation = HasDataSpecification & {
83
- version?: unknown;
84
- revision?: unknown;
85
- creator?: Reference;
86
- templateId?: string;
87
- };
88
-
89
- export type HasDataSpecification = {
90
- embeddedDataSpecifications?: Array<EmbeddedDataSpecification>;
91
- };
92
-
93
- export type EmbeddedDataSpecification = {
94
- dataSpecificationContent: DataSpecificationContentChoice;
95
- dataSpecification: Reference;
96
- };
97
-
98
- export type DataSpecificationContentChoice = DataSpecificationIec61360;
99
-
100
- export type DataSpecificationIec61360 = DataSpecificationContent & {
101
- preferredName: Array<LangStringPreferredNameTypeIec61360>;
102
- shortName?: Array<LangStringShortNameTypeIec61360>;
103
- unit?: string;
104
- unitId?: Reference;
105
- sourceOfDefinition?: string;
106
- symbol?: string;
107
- dataType?: DataTypeIec61360;
108
- definition?: Array<LangStringDefinitionTypeIec61360>;
109
- valueFormat?: string;
110
- valueList?: ValueList;
111
- value?: string;
112
- levelType?: LevelType;
113
- modelType?: string;
114
- };
115
-
116
- export type DataSpecificationContent = {
117
- modelType: ModelType;
118
- };
119
-
120
- export type LangStringPreferredNameTypeIec61360 = AbstractLangString & {
121
- text?: unknown;
122
- };
123
-
124
- export type LangStringShortNameTypeIec61360 = AbstractLangString & {
125
- text?: unknown;
126
- };
127
-
128
- export type DataTypeIec61360 = 'BLOB' | 'BOOLEAN' | 'DATE' | 'FILE' | 'HTML' | 'INTEGER_COUNT' | 'INTEGER_CURRENCY' | 'INTEGER_MEASURE' | 'IRDI' | 'IRI' | 'RATIONAL' | 'RATIONAL_MEASURE' | 'REAL_COUNT' | 'REAL_CURRENCY' | 'REAL_MEASURE' | 'STRING' | 'STRING_TRANSLATABLE' | 'TIME' | 'TIMESTAMP';
129
-
130
- export type LangStringDefinitionTypeIec61360 = AbstractLangString & {
131
- text?: unknown;
132
- };
133
-
134
- export type ValueList = {
135
- valueReferencePairs: Array<ValueReferencePair>;
136
- };
137
-
138
- export type ValueReferencePair = {
139
- value: string;
140
- valueId: Reference;
141
- };
142
-
143
- export type LevelType = {
144
- min: boolean;
145
- nom: boolean;
146
- typ: boolean;
147
- max: boolean;
148
- };
149
-
150
- export type AssetInformation = {
151
- assetKind: AssetKind;
152
- globalAssetId?: string;
153
- specificAssetIds?: Array<SpecificAssetId>;
154
- assetType?: string;
155
- defaultThumbnail?: Resource;
156
- };
157
-
158
- export type AssetKind = 'Instance' | 'NotApplicable' | 'Type';
159
-
160
- export type SpecificAssetId = HasSemantics & {
161
- name: string;
162
- value: string;
163
- externalSubjectId?: Reference;
164
- };
165
-
166
- export type Resource = {
167
- path: string;
168
- contentType?: unknown;
169
- };
170
-
171
- export type Result = {
172
- messages?: Array<Message>;
173
- };
174
-
175
- export type Message = {
176
- code?: string;
177
- correlationId?: string;
178
- messageType?: 'Undefined' | 'Info' | 'Warning' | 'Error' | 'Exception';
179
- text?: string;
180
- timestamp?: string;
181
- };
182
-
183
- export type GetReferencesResult = PagedResult & {
184
- result?: Array<Reference>;
185
- };
186
-
187
- export type Submodel = Identifiable & HasKind & HasSemantics & Qualifiable & HasDataSpecification & {
188
- submodelElements?: Array<SubmodelElementChoice>;
189
- modelType?: string;
190
- };
191
-
192
- export type HasKind = {
193
- kind?: ModellingKind;
194
- };
195
-
196
- export type ModellingKind = 'Instance' | 'Template';
197
-
198
- export type Qualifiable = {
199
- qualifiers?: Array<Qualifier>;
200
- modelType: ModelType;
201
- };
202
-
203
- export type Qualifier = HasSemantics & {
204
- kind?: QualifierKind;
205
- type: string;
206
- valueType: DataTypeDefXsd;
207
- value?: string;
208
- valueId?: Reference;
209
- };
210
-
211
- export type QualifierKind = 'ConceptQualifier' | 'TemplateQualifier' | 'ValueQualifier';
212
-
213
- export type SubmodelElementChoice = RelationshipElement | AnnotatedRelationshipElement | BasicEventElement | AasBlob | Capability | Entity | AasFile | MultiLanguageProperty | Operation | Property | Range | ReferenceElement | SubmodelElementCollection | SubmodelElementList;
214
-
215
- export type RelationshipElement = RelationshipElementAbstract & {
216
- modelType?: string;
217
- };
218
-
219
- export type RelationshipElementAbstract = SubmodelElement & {
220
- first: Reference;
221
- second: Reference;
222
- };
223
-
224
- export type SubmodelElement = Referable & HasSemantics & Qualifiable & HasDataSpecification;
225
-
226
- export type AnnotatedRelationshipElement = RelationshipElementAbstract & {
227
- annotations?: Array<DataElementChoice>;
228
- modelType?: string;
229
- };
230
-
231
- export type DataElementChoice = AasBlob | AasFile | MultiLanguageProperty | Property | Range | ReferenceElement;
232
-
233
- export type AasBlob = DataElement & {
234
- value?: string;
235
- contentType: unknown;
236
- modelType?: string;
237
- };
238
-
239
- export type DataElement = Referable & HasSemantics & Qualifiable & HasDataSpecification;
240
-
241
- export type AasFile = DataElement & {
242
- value?: string;
243
- contentType: unknown;
244
- modelType?: string;
245
- };
246
-
247
- export type MultiLanguageProperty = DataElement & {
248
- value?: Array<LangStringTextType>;
249
- valueId?: Reference;
250
- modelType?: string;
251
- };
252
-
253
- export type Property = DataElement & {
254
- valueType: DataTypeDefXsd;
255
- value?: string;
256
- valueId?: Reference;
257
- modelType?: string;
258
- };
259
-
260
- export type Range = DataElement & {
261
- valueType: DataTypeDefXsd;
262
- min?: string;
263
- max?: string;
264
- modelType?: string;
265
- };
266
-
267
- export type ReferenceElement = DataElement & {
268
- value?: Reference;
269
- modelType?: string;
270
- };
271
-
272
- export type BasicEventElement = EventElement & {
273
- observed: Reference;
274
- direction: Direction;
275
- state: StateOfEvent;
276
- messageTopic?: string;
277
- messageBroker?: Reference;
278
- lastUpdate?: string;
279
- minInterval?: string;
280
- maxInterval?: string;
281
- modelType?: string;
282
- };
283
-
284
- export type EventElement = Referable & HasSemantics & Qualifiable & HasDataSpecification;
285
-
286
- export type Direction = 'input' | 'output';
287
-
288
- export type StateOfEvent = 'off' | 'on';
289
-
290
- export type Capability = SubmodelElement & {
291
- modelType?: string;
292
- };
293
-
294
- export type Entity = SubmodelElement & {
295
- statements?: Array<SubmodelElementChoice>;
296
- entityType: EntityType;
297
- globalAssetId?: string;
298
- specificAssetIds?: Array<SpecificAssetId>;
299
- modelType?: string;
300
- };
301
-
302
- export type EntityType = 'CoManagedEntity' | 'SelfManagedEntity';
303
-
304
- export type Operation = SubmodelElement & {
305
- inputVariables?: Array<OperationVariable>;
306
- outputVariables?: Array<OperationVariable>;
307
- inoutputVariables?: Array<OperationVariable>;
308
- modelType?: string;
309
- };
310
-
311
- export type OperationVariable = {
312
- value: SubmodelElementChoice;
313
- };
314
-
315
- export type SubmodelElementCollection = SubmodelElement & {
316
- value?: Array<SubmodelElementChoice>;
317
- modelType?: string;
318
- };
319
-
320
- export type SubmodelElementList = SubmodelElement & {
321
- orderRelevant?: boolean;
322
- semanticIdListElement?: Reference;
323
- typeValueListElement: AasSubmodelElements;
324
- valueTypeListElement?: DataTypeDefXsd;
325
- value?: Array<SubmodelElementChoice>;
326
- modelType?: string;
327
- };
328
-
329
- export type AasSubmodelElements = 'AnnotatedRelationshipElement' | 'BasicEventElement' | 'AasBlob' | 'Capability' | 'DataElement' | 'Entity' | 'EventElement' | 'AasFile' | 'MultiLanguageProperty' | 'Operation' | 'Property' | 'Range' | 'ReferenceElement' | 'RelationshipElement' | 'SubmodelElement' | 'SubmodelElementCollection' | 'SubmodelElementList';
330
-
331
- export type SubmodelMetadata = Identifiable & HasDataSpecification & Qualifiable & HasSemantics & HasKind;
332
-
333
- /**
334
- * The ValueOnly serialization (patternProperties and propertyNames will be supported probably with OpenApi 3.1). For the full description of the generic JSON validation schema see the ValueOnly-Serialization as defined in the 'Specification of the Asset Administration Shell - Part 2'.
335
- */
336
- export type SubmodelValue = {
337
- [key: string]: unknown;
338
- };
339
-
340
- export type PathItem = string;
341
-
342
- export type GetSubmodelElementsResult = PagedResult & {
343
- result?: Array<SubmodelElement>;
344
- };
345
-
346
- export type GetSubmodelElementsMetadataResult = PagedResult & {
347
- result?: Array<SubmodelElementMetadata>;
348
- };
349
-
350
- export type SubmodelElementMetadata = BlobMetadata | FileMetadata | CapabilityMetadata | EntityMetadata | BasicEventElementMetadata | MultiLanguagePropertyMetadata | OperationMetadata | PropertyMetadata | RangeMetadata | ReferenceElementMetadata | AnnotatedRelationshipElementMetadata | RelationshipElementMetadata | SubmodelElementListMetadata | SubmodelElementCollectionMetadata;
351
-
352
- export type BlobMetadata = Referable1 & HasDataSpecification & HasSemantics1 & Qualifiable1 & HasKind1;
353
-
354
- export type FileMetadata = SubmodelElementAttributes;
355
-
356
- export type SubmodelElementAttributes = Referable1 & HasDataSpecification & HasSemantics1 & Qualifiable1 & HasKind1;
357
-
358
- export type Referable1 = HasExtensions & {
359
- category?: string;
360
- idShort?: unknown;
361
- displayName?: Array<LangStringNameType>;
362
- description?: Array<LangStringTextType>;
363
- modelType: ModelType;
364
- };
365
-
366
- export type HasSemantics1 = {
367
- semanticId?: Reference;
368
- supplementalSemanticIds?: Array<Reference>;
369
- };
370
-
371
- export type Qualifiable1 = {
372
- qualifiers?: Array<Qualifier1>;
373
- modelType: ModelType;
374
- };
375
-
376
- export type Qualifier1 = HasSemantics1 & {
377
- kind?: QualifierKind;
378
- type: string;
379
- valueType: DataTypeDefXsd;
380
- value?: string;
381
- valueId?: Reference;
382
- };
383
-
384
- export type HasKind1 = {
385
- kind?: ModellingKind;
386
- };
387
-
388
- export type CapabilityMetadata = SubmodelElementAttributes;
389
-
390
- export type EntityMetadata = SubmodelElementAttributes;
391
-
392
- export type BasicEventElementMetadata = SubmodelElementAttributes & {
393
- direction?: Direction;
394
- state?: StateOfEvent;
395
- messageTopic?: string;
396
- messageBroker?: Reference;
397
- lastUpdate?: string;
398
- minInterval?: string;
399
- maxInterval?: string;
400
- };
401
-
402
- export type MultiLanguagePropertyMetadata = SubmodelElementAttributes;
403
-
404
- export type OperationMetadata = SubmodelElementAttributes;
405
-
406
- export type PropertyMetadata = SubmodelElementAttributes & {
407
- valueType?: DataTypeDefXsd;
408
- };
409
-
410
- export type RangeMetadata = SubmodelElementAttributes & {
411
- valueType?: DataTypeDefXsd;
412
- };
413
-
414
- export type ReferenceElementMetadata = SubmodelElementAttributes;
415
-
416
- export type AnnotatedRelationshipElementMetadata = Referable1 & HasDataSpecification & HasSemantics1 & Qualifiable1 & HasKind1;
417
-
418
- export type RelationshipElementMetadata = SubmodelElementAttributes;
419
-
420
- export type SubmodelElementListMetadata = SubmodelElementAttributes & {
421
- orderRelevant?: boolean;
422
- semanticIdListElement?: Reference;
423
- typeValueListElement?: ModelType;
424
- valueTypeListElement?: DataTypeDefXsd;
425
- };
426
-
427
- export type SubmodelElementCollectionMetadata = SubmodelElementAttributes;
428
-
429
- export type GetSubmodelElementsValueResult = PagedResult & {
430
- result?: Array<SubmodelElementValue>;
431
- };
432
-
433
- export type SubmodelElementValue = BasicEventElementValue | PropertyValue | MultiLanguagePropertyValue | BlobValue | FileValue | RangeValue | ReferenceElementValue | RelationshipElementValue | AnnotatedRelationshipElementValue | EntityValue | SubmodelElementCollectionValue | SubmodelElementListValue;
434
-
435
- export type BasicEventElementValue = {
436
- observed: ReferenceValue;
437
- };
438
-
439
- export type ReferenceValue = {
440
- type?: ReferenceTypes;
441
- keys?: Array<Key>;
442
- };
443
-
444
- export type PropertyValue = StringValue | NumberValue | BooleanValue;
445
-
446
- export type StringValue = string;
447
-
448
- export type NumberValue = number;
449
-
450
- export type BooleanValue = boolean;
451
-
452
- /**
453
- * 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.
454
- */
455
- export type MultiLanguagePropertyValue = {
456
- [key: string]: unknown;
457
- };
458
-
459
- export type BlobValue = {
460
- contentType: string;
461
- value?: string;
462
- };
463
-
464
- export type FileValue = {
465
- contentType: string;
466
- value: string;
467
- };
468
-
469
- export type RangeValue = {
470
- max?: RangeValueType;
471
- min?: RangeValueType;
472
- };
473
-
474
- export type RangeValueType = StringValue | NumberValue | BooleanValue;
475
-
476
- export type ReferenceElementValue = {
477
- type?: ReferenceTypes;
478
- keys?: Array<Key>;
479
- };
480
-
481
- export type RelationshipElementValue = {
482
- first: ReferenceValue;
483
- second: ReferenceValue;
484
- };
485
-
486
- export type AnnotatedRelationshipElementValue = {
487
- first: ReferenceValue;
488
- second: ReferenceValue;
489
- annotations?: Array<ValueOnly>;
490
- };
491
-
492
- /**
493
- * The ValueOnly serialization (patternProperties and propertyNames will be supported probably with OpenApi 3.1). For the full description of the generic JSON validation schema see the ValueOnly-Serialization as defined in the 'Specification of the Asset Administration Shell - Part 2'.
494
- */
495
- export type ValueOnly = {
496
- [key: string]: unknown;
497
- };
498
-
499
- export type EntityValue = {
500
- entityType: EntityType;
501
- globalAssetId?: string;
502
- specificAssetIds?: Array<SpecificAssetIdValue>;
503
- statements?: Array<ValueOnly>;
504
- };
505
-
506
- /**
507
- * 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.
508
- */
509
- export type SpecificAssetIdValue = {
510
- [key: string]: unknown;
511
- };
512
-
513
- /**
514
- * 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.
515
- */
516
- export type SubmodelElementCollectionValue = {
517
- [key: string]: unknown;
518
- };
519
-
520
- export type SubmodelElementListValue = Array<SubmodelElementValue>;
521
-
522
- export type GetPathItemsResult = PagedResult & {
523
- result?: Array<PathItem>;
524
- };
525
-
526
- export type OperationRequest = {
527
- inoutputArguments?: Array<OperationVariable>;
528
- inputArguments?: Array<OperationVariable>;
529
- clientTimeoutDuration?: string;
530
- };
531
-
532
- export type OperationResult = BaseOperationResult & {
533
- inoutputArguments?: Array<OperationVariable>;
534
- outputArguments?: Array<OperationVariable>;
535
- };
536
-
537
- export type BaseOperationResult = Result & {
538
- executionState?: ExecutionState;
539
- success?: boolean;
540
- };
541
-
542
- export type ExecutionState = 'Initiated' | 'Running' | 'Completed' | 'Canceled' | 'Failed' | 'Timeout';
543
-
544
- export type OperationRequestValueOnly = {
545
- inoutputArguments?: ValueOnly;
546
- inputArguments?: ValueOnly;
547
- clientTimeoutDuration: string;
548
- };
549
-
550
- export type OperationResultValueOnly = BaseOperationResult & {
551
- inoutputArguments?: ValueOnly;
552
- outputArguments?: ValueOnly;
553
- };
554
-
555
- export type Environment = {
556
- assetAdministrationShells?: Array<AssetAdministrationShell>;
557
- submodels?: Array<Submodel>;
558
- conceptDescriptions?: Array<ConceptDescription>;
559
- };
560
-
561
- export type ConceptDescription = Identifiable & HasDataSpecification & {
562
- isCaseOf?: Array<Reference>;
563
- modelType?: string;
564
- };
565
-
566
- /**
567
- * 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.
568
- */
569
- export type ServiceDescription = {
570
- profiles?: Array<string>;
571
- };
572
-
573
- export type AssetinformationThumbnailBody = {
574
- fileName?: string;
575
- file?: Blob | File;
576
- };
577
-
578
- export type IdShortPathAttachmentBody = {
579
- fileName?: string;
580
- file?: Blob | File;
581
- };
582
-
583
- export type PagedResultPagingMetadata = {
584
- cursor?: string;
585
- };
586
-
587
- /**
588
- * A list of specific Asset identifiers. Every single value asset identifier is a base64-url-encoded [SpecificAssetId](https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/SpecificAssetId).
589
- */
590
- export type AssetIds = Array<string>;
591
-
592
- /**
593
- * The Asset Administration Shell’s IdShort
594
- */
595
- export type IdShort = string;
596
-
597
- /**
598
- * The maximum number of elements in the response array
599
- */
600
- export type Limit = number;
601
-
602
- /**
603
- * A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
604
- */
605
- export type Cursor = string;
606
-
607
- /**
608
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
609
- */
610
- export type AssetAdministrationShellIdentifier = string;
611
-
612
- /**
613
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
614
- */
615
- export type SubmodelIdentifier = string;
616
-
617
- /**
618
- * Determines the structural depth of the respective resource content
619
- */
620
- export type Level = 'deep' | 'core';
621
-
622
- /**
623
- * Determines to which extent the resource is being serialized
624
- */
625
- export type Extent = 'withBlobValue' | 'withoutBlobValue';
626
-
627
- /**
628
- * IdShort path to the submodel element (dot-separated)
629
- */
630
- export type IdShortPath = string;
631
-
632
- /**
633
- * 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)
634
- */
635
- export type HandleId = string;
636
-
637
- export type GetAllAssetAdministrationShellsData = {
638
- body?: never;
639
- path?: never;
640
- query?: {
641
- /**
642
- * A list of specific Asset identifiers. Every single value asset identifier is a base64-url-encoded [SpecificAssetId](https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/SpecificAssetId).
643
- */
644
- assetIds?: Array<string>;
645
- /**
646
- * The Asset Administration Shell’s IdShort
647
- */
648
- idShort?: string;
649
- /**
650
- * The maximum number of elements in the response array
651
- */
652
- limit?: number;
653
- /**
654
- * A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
655
- */
656
- cursor?: string;
657
- };
658
- url: '/shells';
659
- };
660
-
661
- export type GetAllAssetAdministrationShellsErrors = {
662
- /**
663
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
664
- */
665
- 400: Result;
666
- /**
667
- * Unauthorized, e.g. the server refused the authorization attempt.
668
- */
669
- 401: Result;
670
- /**
671
- * Forbidden
672
- */
673
- 403: Result;
674
- /**
675
- * Internal Server Error
676
- */
677
- 500: Result;
678
- /**
679
- * Default error handling for unmentioned status codes
680
- */
681
- default: Result;
682
- };
683
-
684
- export type GetAllAssetAdministrationShellsError = GetAllAssetAdministrationShellsErrors[keyof GetAllAssetAdministrationShellsErrors];
685
-
686
- export type GetAllAssetAdministrationShellsResponses = {
687
- /**
688
- * Requested Asset Administration Shells
689
- */
690
- 200: GetAssetAdministrationShellsResult;
691
- };
692
-
693
- export type GetAllAssetAdministrationShellsResponse = GetAllAssetAdministrationShellsResponses[keyof GetAllAssetAdministrationShellsResponses];
694
-
695
- export type PostAssetAdministrationShellData = {
696
- /**
697
- * Asset Administration Shell object
698
- */
699
- body: AssetAdministrationShell;
700
- path?: never;
701
- query?: never;
702
- url: '/shells';
703
- };
704
-
705
- export type PostAssetAdministrationShellErrors = {
706
- /**
707
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
708
- */
709
- 400: Result;
710
- /**
711
- * Unauthorized, e.g. the server refused the authorization attempt.
712
- */
713
- 401: Result;
714
- /**
715
- * Forbidden
716
- */
717
- 403: Result;
718
- /**
719
- * 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.
720
- */
721
- 409: Result;
722
- /**
723
- * Internal Server Error
724
- */
725
- 500: Result;
726
- /**
727
- * Default error handling for unmentioned status codes
728
- */
729
- default: Result;
730
- };
731
-
732
- export type PostAssetAdministrationShellError = PostAssetAdministrationShellErrors[keyof PostAssetAdministrationShellErrors];
733
-
734
- export type PostAssetAdministrationShellResponses = {
735
- /**
736
- * Asset Administration Shell created successfully
737
- */
738
- 201: AssetAdministrationShell;
739
- };
740
-
741
- export type PostAssetAdministrationShellResponse = PostAssetAdministrationShellResponses[keyof PostAssetAdministrationShellResponses];
742
-
743
- export type GetAllAssetAdministrationShellsReferenceData = {
744
- body?: never;
745
- path?: never;
746
- query?: {
747
- /**
748
- * A list of specific Asset identifiers. Every single value asset identifier is a base64-url-encoded [SpecificAssetId](https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.0.3#/components/schemas/SpecificAssetId).
749
- */
750
- assetIds?: Array<string>;
751
- /**
752
- * The Asset Administration Shell’s IdShort
753
- */
754
- idShort?: string;
755
- /**
756
- * The maximum number of elements in the response array
757
- */
758
- limit?: number;
759
- /**
760
- * A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
761
- */
762
- cursor?: string;
763
- };
764
- url: '/shells/$reference';
765
- };
766
-
767
- export type GetAllAssetAdministrationShellsReferenceErrors = {
768
- /**
769
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
770
- */
771
- 400: Result;
772
- /**
773
- * Unauthorized, e.g. the server refused the authorization attempt.
774
- */
775
- 401: Result;
776
- /**
777
- * Forbidden
778
- */
779
- 403: Result;
780
- /**
781
- * Internal Server Error
782
- */
783
- 500: Result;
784
- /**
785
- * Default error handling for unmentioned status codes
786
- */
787
- default: Result;
788
- };
789
-
790
- export type GetAllAssetAdministrationShellsReferenceError = GetAllAssetAdministrationShellsReferenceErrors[keyof GetAllAssetAdministrationShellsReferenceErrors];
791
-
792
- export type GetAllAssetAdministrationShellsReferenceResponses = {
793
- /**
794
- * Requested Asset Administration Shells as a list of References
795
- */
796
- 200: GetReferencesResult;
797
- };
798
-
799
- export type GetAllAssetAdministrationShellsReferenceResponse = GetAllAssetAdministrationShellsReferenceResponses[keyof GetAllAssetAdministrationShellsReferenceResponses];
800
-
801
- export type DeleteAssetAdministrationShellByIdData = {
802
- body?: never;
803
- path: {
804
- /**
805
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
806
- */
807
- aasIdentifier: string;
808
- };
809
- query?: never;
810
- url: '/shells/{aasIdentifier}';
811
- };
812
-
813
- export type DeleteAssetAdministrationShellByIdErrors = {
814
- /**
815
- * Unauthorized, e.g. the server refused the authorization attempt.
816
- */
817
- 401: Result;
818
- /**
819
- * Forbidden
820
- */
821
- 403: Result;
822
- /**
823
- * Not Found
824
- */
825
- 404: Result;
826
- /**
827
- * Internal Server Error
828
- */
829
- 500: Result;
830
- /**
831
- * Default error handling for unmentioned status codes
832
- */
833
- default: Result;
834
- };
835
-
836
- export type DeleteAssetAdministrationShellByIdError = DeleteAssetAdministrationShellByIdErrors[keyof DeleteAssetAdministrationShellByIdErrors];
837
-
838
- export type DeleteAssetAdministrationShellByIdResponses = {
839
- /**
840
- * Asset Administration Shell deleted successfully
841
- */
842
- 204: void;
843
- };
844
-
845
- export type DeleteAssetAdministrationShellByIdResponse = DeleteAssetAdministrationShellByIdResponses[keyof DeleteAssetAdministrationShellByIdResponses];
846
-
847
- export type GetAssetAdministrationShellByIdData = {
848
- body?: never;
849
- path: {
850
- /**
851
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
852
- */
853
- aasIdentifier: string;
854
- };
855
- query?: never;
856
- url: '/shells/{aasIdentifier}';
857
- };
858
-
859
- export type GetAssetAdministrationShellByIdErrors = {
860
- /**
861
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
862
- */
863
- 400: Result;
864
- /**
865
- * Unauthorized, e.g. the server refused the authorization attempt.
866
- */
867
- 401: Result;
868
- /**
869
- * Forbidden
870
- */
871
- 403: Result;
872
- /**
873
- * Not Found
874
- */
875
- 404: Result;
876
- /**
877
- * Internal Server Error
878
- */
879
- 500: Result;
880
- /**
881
- * Default error handling for unmentioned status codes
882
- */
883
- default: Result;
884
- };
885
-
886
- export type GetAssetAdministrationShellByIdError = GetAssetAdministrationShellByIdErrors[keyof GetAssetAdministrationShellByIdErrors];
887
-
888
- export type GetAssetAdministrationShellByIdResponses = {
889
- /**
890
- * Requested Asset Administration Shell
891
- */
892
- 200: AssetAdministrationShell;
893
- };
894
-
895
- export type GetAssetAdministrationShellByIdResponse = GetAssetAdministrationShellByIdResponses[keyof GetAssetAdministrationShellByIdResponses];
896
-
897
- export type PutAssetAdministrationShellByIdData = {
898
- /**
899
- * Asset Administration Shell object
900
- */
901
- body: AssetAdministrationShell;
902
- path: {
903
- /**
904
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
905
- */
906
- aasIdentifier: string;
907
- };
908
- query?: never;
909
- url: '/shells/{aasIdentifier}';
910
- };
911
-
912
- export type PutAssetAdministrationShellByIdErrors = {
913
- /**
914
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
915
- */
916
- 400: Result;
917
- /**
918
- * Unauthorized, e.g. the server refused the authorization attempt.
919
- */
920
- 401: Result;
921
- /**
922
- * Forbidden
923
- */
924
- 403: Result;
925
- /**
926
- * Not Found
927
- */
928
- 404: Result;
929
- /**
930
- * Internal Server Error
931
- */
932
- 500: Result;
933
- /**
934
- * Default error handling for unmentioned status codes
935
- */
936
- default: Result;
937
- };
938
-
939
- export type PutAssetAdministrationShellByIdError = PutAssetAdministrationShellByIdErrors[keyof PutAssetAdministrationShellByIdErrors];
940
-
941
- export type PutAssetAdministrationShellByIdResponses = {
942
- /**
943
- * Asset Administration Shell updated successfully
944
- */
945
- 204: void;
946
- };
947
-
948
- export type PutAssetAdministrationShellByIdResponse = PutAssetAdministrationShellByIdResponses[keyof PutAssetAdministrationShellByIdResponses];
949
-
950
- export type GetAssetAdministrationShellByIdReferenceAasRepositoryData = {
951
- body?: never;
952
- path: {
953
- /**
954
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
955
- */
956
- aasIdentifier: string;
957
- };
958
- query?: never;
959
- url: '/shells/{aasIdentifier}/$reference';
960
- };
961
-
962
- export type GetAssetAdministrationShellByIdReferenceAasRepositoryErrors = {
963
- /**
964
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
965
- */
966
- 400: Result;
967
- /**
968
- * Unauthorized, e.g. the server refused the authorization attempt.
969
- */
970
- 401: Result;
971
- /**
972
- * Forbidden
973
- */
974
- 403: Result;
975
- /**
976
- * Not Found
977
- */
978
- 404: Result;
979
- /**
980
- * Internal Server Error
981
- */
982
- 500: Result;
983
- /**
984
- * Default error handling for unmentioned status codes
985
- */
986
- default: Result;
987
- };
988
-
989
- export type GetAssetAdministrationShellByIdReferenceAasRepositoryError = GetAssetAdministrationShellByIdReferenceAasRepositoryErrors[keyof GetAssetAdministrationShellByIdReferenceAasRepositoryErrors];
990
-
991
- export type GetAssetAdministrationShellByIdReferenceAasRepositoryResponses = {
992
- /**
993
- * Requested Asset Administration Shell
994
- */
995
- 200: Reference;
996
- };
997
-
998
- export type GetAssetAdministrationShellByIdReferenceAasRepositoryResponse = GetAssetAdministrationShellByIdReferenceAasRepositoryResponses[keyof GetAssetAdministrationShellByIdReferenceAasRepositoryResponses];
999
-
1000
- export type GetAssetInformationAasRepositoryData = {
1001
- body?: never;
1002
- path: {
1003
- /**
1004
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1005
- */
1006
- aasIdentifier: string;
1007
- };
1008
- query?: never;
1009
- url: '/shells/{aasIdentifier}/asset-information';
1010
- };
1011
-
1012
- export type GetAssetInformationAasRepositoryErrors = {
1013
- /**
1014
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1015
- */
1016
- 400: Result;
1017
- /**
1018
- * Unauthorized, e.g. the server refused the authorization attempt.
1019
- */
1020
- 401: Result;
1021
- /**
1022
- * Forbidden
1023
- */
1024
- 403: Result;
1025
- /**
1026
- * Not Found
1027
- */
1028
- 404: Result;
1029
- /**
1030
- * Internal Server Error
1031
- */
1032
- 500: Result;
1033
- /**
1034
- * Default error handling for unmentioned status codes
1035
- */
1036
- default: Result;
1037
- };
1038
-
1039
- export type GetAssetInformationAasRepositoryError = GetAssetInformationAasRepositoryErrors[keyof GetAssetInformationAasRepositoryErrors];
1040
-
1041
- export type GetAssetInformationAasRepositoryResponses = {
1042
- /**
1043
- * Requested Asset Information
1044
- */
1045
- 200: AssetInformation;
1046
- };
1047
-
1048
- export type GetAssetInformationAasRepositoryResponse = GetAssetInformationAasRepositoryResponses[keyof GetAssetInformationAasRepositoryResponses];
1049
-
1050
- export type PutAssetInformationAasRepositoryData = {
1051
- /**
1052
- * Asset Information object
1053
- */
1054
- body: AssetInformation;
1055
- path: {
1056
- /**
1057
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1058
- */
1059
- aasIdentifier: string;
1060
- };
1061
- query?: never;
1062
- url: '/shells/{aasIdentifier}/asset-information';
1063
- };
1064
-
1065
- export type PutAssetInformationAasRepositoryErrors = {
1066
- /**
1067
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1068
- */
1069
- 400: Result;
1070
- /**
1071
- * Unauthorized, e.g. the server refused the authorization attempt.
1072
- */
1073
- 401: Result;
1074
- /**
1075
- * Forbidden
1076
- */
1077
- 403: Result;
1078
- /**
1079
- * Not Found
1080
- */
1081
- 404: Result;
1082
- /**
1083
- * Internal Server Error
1084
- */
1085
- 500: Result;
1086
- /**
1087
- * Default error handling for unmentioned status codes
1088
- */
1089
- default: Result;
1090
- };
1091
-
1092
- export type PutAssetInformationAasRepositoryError = PutAssetInformationAasRepositoryErrors[keyof PutAssetInformationAasRepositoryErrors];
1093
-
1094
- export type PutAssetInformationAasRepositoryResponses = {
1095
- /**
1096
- * Asset Information updated successfully
1097
- */
1098
- 204: void;
1099
- };
1100
-
1101
- export type PutAssetInformationAasRepositoryResponse = PutAssetInformationAasRepositoryResponses[keyof PutAssetInformationAasRepositoryResponses];
1102
-
1103
- export type DeleteThumbnailAasRepositoryData = {
1104
- body?: never;
1105
- path: {
1106
- /**
1107
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1108
- */
1109
- aasIdentifier: string;
1110
- };
1111
- query?: never;
1112
- url: '/shells/{aasIdentifier}/asset-information/thumbnail';
1113
- };
1114
-
1115
- export type DeleteThumbnailAasRepositoryErrors = {
1116
- /**
1117
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1118
- */
1119
- 400: Result;
1120
- /**
1121
- * Unauthorized, e.g. the server refused the authorization attempt.
1122
- */
1123
- 401: Result;
1124
- /**
1125
- * Forbidden
1126
- */
1127
- 403: Result;
1128
- /**
1129
- * Not Found
1130
- */
1131
- 404: Result;
1132
- /**
1133
- * Internal Server Error
1134
- */
1135
- 500: Result;
1136
- /**
1137
- * Default error handling for unmentioned status codes
1138
- */
1139
- default: Result;
1140
- };
1141
-
1142
- export type DeleteThumbnailAasRepositoryError = DeleteThumbnailAasRepositoryErrors[keyof DeleteThumbnailAasRepositoryErrors];
1143
-
1144
- export type DeleteThumbnailAasRepositoryResponses = {
1145
- /**
1146
- * Thumbnail deletion successful
1147
- */
1148
- 200: unknown;
1149
- };
1150
-
1151
- export type GetThumbnailAasRepositoryData = {
1152
- body?: never;
1153
- path: {
1154
- /**
1155
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1156
- */
1157
- aasIdentifier: string;
1158
- };
1159
- query?: never;
1160
- url: '/shells/{aasIdentifier}/asset-information/thumbnail';
1161
- };
1162
-
1163
- export type GetThumbnailAasRepositoryErrors = {
1164
- /**
1165
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1166
- */
1167
- 400: Result;
1168
- /**
1169
- * Unauthorized, e.g. the server refused the authorization attempt.
1170
- */
1171
- 401: Result;
1172
- /**
1173
- * Forbidden
1174
- */
1175
- 403: Result;
1176
- /**
1177
- * Not Found
1178
- */
1179
- 404: Result;
1180
- /**
1181
- * Internal Server Error
1182
- */
1183
- 500: Result;
1184
- /**
1185
- * Default error handling for unmentioned status codes
1186
- */
1187
- default: Result;
1188
- };
1189
-
1190
- export type GetThumbnailAasRepositoryError = GetThumbnailAasRepositoryErrors[keyof GetThumbnailAasRepositoryErrors];
1191
-
1192
- export type GetThumbnailAasRepositoryResponses = {
1193
- /**
1194
- * The thumbnail of the Asset Information.
1195
- */
1196
- 200: Blob | File;
1197
- };
1198
-
1199
- export type GetThumbnailAasRepositoryResponse = GetThumbnailAasRepositoryResponses[keyof GetThumbnailAasRepositoryResponses];
1200
-
1201
- export type PutThumbnailAasRepositoryData = {
1202
- /**
1203
- * Thumbnail to upload
1204
- */
1205
- body: AssetinformationThumbnailBody;
1206
- path: {
1207
- /**
1208
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1209
- */
1210
- aasIdentifier: string;
1211
- };
1212
- query?: never;
1213
- url: '/shells/{aasIdentifier}/asset-information/thumbnail';
1214
- };
1215
-
1216
- export type PutThumbnailAasRepositoryErrors = {
1217
- /**
1218
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1219
- */
1220
- 400: Result;
1221
- /**
1222
- * Unauthorized, e.g. the server refused the authorization attempt.
1223
- */
1224
- 401: Result;
1225
- /**
1226
- * Forbidden
1227
- */
1228
- 403: Result;
1229
- /**
1230
- * Not Found
1231
- */
1232
- 404: Result;
1233
- /**
1234
- * Internal Server Error
1235
- */
1236
- 500: Result;
1237
- /**
1238
- * Default error handling for unmentioned status codes
1239
- */
1240
- default: Result;
1241
- };
1242
-
1243
- export type PutThumbnailAasRepositoryError = PutThumbnailAasRepositoryErrors[keyof PutThumbnailAasRepositoryErrors];
1244
-
1245
- export type PutThumbnailAasRepositoryResponses = {
1246
- /**
1247
- * Thumbnail updated successfully
1248
- */
1249
- 204: void;
1250
- };
1251
-
1252
- export type PutThumbnailAasRepositoryResponse = PutThumbnailAasRepositoryResponses[keyof PutThumbnailAasRepositoryResponses];
1253
-
1254
- export type GetAllSubmodelReferencesAasRepositoryData = {
1255
- body?: never;
1256
- path: {
1257
- /**
1258
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1259
- */
1260
- aasIdentifier: string;
1261
- };
1262
- query?: {
1263
- /**
1264
- * The maximum number of elements in the response array
1265
- */
1266
- limit?: number;
1267
- /**
1268
- * A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
1269
- */
1270
- cursor?: string;
1271
- };
1272
- url: '/shells/{aasIdentifier}/submodel-refs';
1273
- };
1274
-
1275
- export type GetAllSubmodelReferencesAasRepositoryErrors = {
1276
- /**
1277
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1278
- */
1279
- 400: Result;
1280
- /**
1281
- * Unauthorized, e.g. the server refused the authorization attempt.
1282
- */
1283
- 401: Result;
1284
- /**
1285
- * Forbidden
1286
- */
1287
- 403: Result;
1288
- /**
1289
- * Not Found
1290
- */
1291
- 404: Result;
1292
- /**
1293
- * Internal Server Error
1294
- */
1295
- 500: Result;
1296
- /**
1297
- * Default error handling for unmentioned status codes
1298
- */
1299
- default: Result;
1300
- };
1301
-
1302
- export type GetAllSubmodelReferencesAasRepositoryError = GetAllSubmodelReferencesAasRepositoryErrors[keyof GetAllSubmodelReferencesAasRepositoryErrors];
1303
-
1304
- export type GetAllSubmodelReferencesAasRepositoryResponses = {
1305
- /**
1306
- * Requested submodel references
1307
- */
1308
- 200: GetReferencesResult;
1309
- };
1310
-
1311
- export type GetAllSubmodelReferencesAasRepositoryResponse = GetAllSubmodelReferencesAasRepositoryResponses[keyof GetAllSubmodelReferencesAasRepositoryResponses];
1312
-
1313
- export type PostSubmodelReferenceAasRepositoryData = {
1314
- /**
1315
- * Reference to the Submodel
1316
- */
1317
- body: Reference;
1318
- path: {
1319
- /**
1320
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1321
- */
1322
- aasIdentifier: string;
1323
- };
1324
- query?: never;
1325
- url: '/shells/{aasIdentifier}/submodel-refs';
1326
- };
1327
-
1328
- export type PostSubmodelReferenceAasRepositoryErrors = {
1329
- /**
1330
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1331
- */
1332
- 400: Result;
1333
- /**
1334
- * Unauthorized, e.g. the server refused the authorization attempt.
1335
- */
1336
- 401: Result;
1337
- /**
1338
- * Forbidden
1339
- */
1340
- 403: Result;
1341
- /**
1342
- * Not Found
1343
- */
1344
- 404: Result;
1345
- /**
1346
- * 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.
1347
- */
1348
- 409: Result;
1349
- /**
1350
- * Internal Server Error
1351
- */
1352
- 500: Result;
1353
- /**
1354
- * Default error handling for unmentioned status codes
1355
- */
1356
- default: Result;
1357
- };
1358
-
1359
- export type PostSubmodelReferenceAasRepositoryError = PostSubmodelReferenceAasRepositoryErrors[keyof PostSubmodelReferenceAasRepositoryErrors];
1360
-
1361
- export type PostSubmodelReferenceAasRepositoryResponses = {
1362
- /**
1363
- * Submodel reference created successfully
1364
- */
1365
- 201: Reference;
1366
- };
1367
-
1368
- export type PostSubmodelReferenceAasRepositoryResponse = PostSubmodelReferenceAasRepositoryResponses[keyof PostSubmodelReferenceAasRepositoryResponses];
1369
-
1370
- export type DeleteSubmodelReferenceByIdAasRepositoryData = {
1371
- body?: never;
1372
- path: {
1373
- /**
1374
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1375
- */
1376
- aasIdentifier: string;
1377
- /**
1378
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
1379
- */
1380
- submodelIdentifier: string;
1381
- };
1382
- query?: never;
1383
- url: '/shells/{aasIdentifier}/submodel-refs/{submodelIdentifier}';
1384
- };
1385
-
1386
- export type DeleteSubmodelReferenceByIdAasRepositoryErrors = {
1387
- /**
1388
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1389
- */
1390
- 400: Result;
1391
- /**
1392
- * Unauthorized, e.g. the server refused the authorization attempt.
1393
- */
1394
- 401: Result;
1395
- /**
1396
- * Forbidden
1397
- */
1398
- 403: Result;
1399
- /**
1400
- * Not Found
1401
- */
1402
- 404: Result;
1403
- /**
1404
- * Internal Server Error
1405
- */
1406
- 500: Result;
1407
- /**
1408
- * Default error handling for unmentioned status codes
1409
- */
1410
- default: Result;
1411
- };
1412
-
1413
- export type DeleteSubmodelReferenceByIdAasRepositoryError = DeleteSubmodelReferenceByIdAasRepositoryErrors[keyof DeleteSubmodelReferenceByIdAasRepositoryErrors];
1414
-
1415
- export type DeleteSubmodelReferenceByIdAasRepositoryResponses = {
1416
- /**
1417
- * Submodel reference deleted successfully
1418
- */
1419
- 204: void;
1420
- };
1421
-
1422
- export type DeleteSubmodelReferenceByIdAasRepositoryResponse = DeleteSubmodelReferenceByIdAasRepositoryResponses[keyof DeleteSubmodelReferenceByIdAasRepositoryResponses];
1423
-
1424
- export type DeleteSubmodelByIdAasRepositoryData = {
1425
- body?: never;
1426
- path: {
1427
- /**
1428
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1429
- */
1430
- aasIdentifier: string;
1431
- /**
1432
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
1433
- */
1434
- submodelIdentifier: string;
1435
- };
1436
- query?: never;
1437
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}';
1438
- };
1439
-
1440
- export type DeleteSubmodelByIdAasRepositoryErrors = {
1441
- /**
1442
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1443
- */
1444
- 400: Result;
1445
- /**
1446
- * Unauthorized, e.g. the server refused the authorization attempt.
1447
- */
1448
- 401: Result;
1449
- /**
1450
- * Forbidden
1451
- */
1452
- 403: Result;
1453
- /**
1454
- * Not Found
1455
- */
1456
- 404: Result;
1457
- /**
1458
- * Internal Server Error
1459
- */
1460
- 500: Result;
1461
- /**
1462
- * Default error handling for unmentioned status codes
1463
- */
1464
- default: Result;
1465
- };
1466
-
1467
- export type DeleteSubmodelByIdAasRepositoryError = DeleteSubmodelByIdAasRepositoryErrors[keyof DeleteSubmodelByIdAasRepositoryErrors];
1468
-
1469
- export type DeleteSubmodelByIdAasRepositoryResponses = {
1470
- /**
1471
- * Submodel deleted successfully
1472
- */
1473
- 204: void;
1474
- };
1475
-
1476
- export type DeleteSubmodelByIdAasRepositoryResponse = DeleteSubmodelByIdAasRepositoryResponses[keyof DeleteSubmodelByIdAasRepositoryResponses];
1477
-
1478
- export type GetSubmodelByIdAasRepositoryData = {
1479
- body?: never;
1480
- path: {
1481
- /**
1482
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1483
- */
1484
- aasIdentifier: string;
1485
- /**
1486
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
1487
- */
1488
- submodelIdentifier: string;
1489
- };
1490
- query?: {
1491
- /**
1492
- * Determines the structural depth of the respective resource content
1493
- */
1494
- level?: 'deep' | 'core';
1495
- /**
1496
- * Determines to which extent the resource is being serialized
1497
- */
1498
- extent?: 'withBlobValue' | 'withoutBlobValue';
1499
- };
1500
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}';
1501
- };
1502
-
1503
- export type GetSubmodelByIdAasRepositoryErrors = {
1504
- /**
1505
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1506
- */
1507
- 400: Result;
1508
- /**
1509
- * Unauthorized, e.g. the server refused the authorization attempt.
1510
- */
1511
- 401: Result;
1512
- /**
1513
- * Forbidden
1514
- */
1515
- 403: Result;
1516
- /**
1517
- * Not Found
1518
- */
1519
- 404: Result;
1520
- /**
1521
- * Internal Server Error
1522
- */
1523
- 500: Result;
1524
- /**
1525
- * Default error handling for unmentioned status codes
1526
- */
1527
- default: Result;
1528
- };
1529
-
1530
- export type GetSubmodelByIdAasRepositoryError = GetSubmodelByIdAasRepositoryErrors[keyof GetSubmodelByIdAasRepositoryErrors];
1531
-
1532
- export type GetSubmodelByIdAasRepositoryResponses = {
1533
- /**
1534
- * Requested Submodel
1535
- */
1536
- 200: Submodel;
1537
- };
1538
-
1539
- export type GetSubmodelByIdAasRepositoryResponse = GetSubmodelByIdAasRepositoryResponses[keyof GetSubmodelByIdAasRepositoryResponses];
1540
-
1541
- export type PatchSubmodelAasRepositoryData = {
1542
- /**
1543
- * Submodel object
1544
- */
1545
- body: Submodel;
1546
- path: {
1547
- /**
1548
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1549
- */
1550
- aasIdentifier: string;
1551
- /**
1552
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
1553
- */
1554
- submodelIdentifier: string;
1555
- };
1556
- query?: {
1557
- /**
1558
- * Determines the structural depth of the respective resource content
1559
- */
1560
- level?: 'core';
1561
- };
1562
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}';
1563
- };
1564
-
1565
- export type PatchSubmodelAasRepositoryErrors = {
1566
- /**
1567
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1568
- */
1569
- 400: Result;
1570
- /**
1571
- * Unauthorized, e.g. the server refused the authorization attempt.
1572
- */
1573
- 401: Result;
1574
- /**
1575
- * Forbidden
1576
- */
1577
- 403: Result;
1578
- /**
1579
- * Not Found
1580
- */
1581
- 404: Result;
1582
- /**
1583
- * Internal Server Error
1584
- */
1585
- 500: Result;
1586
- /**
1587
- * Default error handling for unmentioned status codes
1588
- */
1589
- default: Result;
1590
- };
1591
-
1592
- export type PatchSubmodelAasRepositoryError = PatchSubmodelAasRepositoryErrors[keyof PatchSubmodelAasRepositoryErrors];
1593
-
1594
- export type PatchSubmodelAasRepositoryResponses = {
1595
- /**
1596
- * Submodel updated successfully
1597
- */
1598
- 204: void;
1599
- };
1600
-
1601
- export type PatchSubmodelAasRepositoryResponse = PatchSubmodelAasRepositoryResponses[keyof PatchSubmodelAasRepositoryResponses];
1602
-
1603
- export type PutSubmodelByIdAasRepositoryData = {
1604
- /**
1605
- * Submodel object
1606
- */
1607
- body: Submodel;
1608
- path: {
1609
- /**
1610
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1611
- */
1612
- aasIdentifier: string;
1613
- /**
1614
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
1615
- */
1616
- submodelIdentifier: string;
1617
- };
1618
- query?: never;
1619
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}';
1620
- };
1621
-
1622
- export type PutSubmodelByIdAasRepositoryErrors = {
1623
- /**
1624
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1625
- */
1626
- 400: Result;
1627
- /**
1628
- * Unauthorized, e.g. the server refused the authorization attempt.
1629
- */
1630
- 401: Result;
1631
- /**
1632
- * Forbidden
1633
- */
1634
- 403: Result;
1635
- /**
1636
- * Not Found
1637
- */
1638
- 404: Result;
1639
- /**
1640
- * Internal Server Error
1641
- */
1642
- 500: Result;
1643
- /**
1644
- * Default error handling for unmentioned status codes
1645
- */
1646
- default: Result;
1647
- };
1648
-
1649
- export type PutSubmodelByIdAasRepositoryError = PutSubmodelByIdAasRepositoryErrors[keyof PutSubmodelByIdAasRepositoryErrors];
1650
-
1651
- export type PutSubmodelByIdAasRepositoryResponses = {
1652
- /**
1653
- * Submodel updated successfully
1654
- */
1655
- 204: void;
1656
- };
1657
-
1658
- export type PutSubmodelByIdAasRepositoryResponse = PutSubmodelByIdAasRepositoryResponses[keyof PutSubmodelByIdAasRepositoryResponses];
1659
-
1660
- export type GetSubmodelByIdMetadataAasRepositoryData = {
1661
- body?: never;
1662
- path: {
1663
- /**
1664
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1665
- */
1666
- aasIdentifier: string;
1667
- /**
1668
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
1669
- */
1670
- submodelIdentifier: string;
1671
- };
1672
- query?: never;
1673
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/$metadata';
1674
- };
1675
-
1676
- export type GetSubmodelByIdMetadataAasRepositoryErrors = {
1677
- /**
1678
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1679
- */
1680
- 400: Result;
1681
- /**
1682
- * Unauthorized, e.g. the server refused the authorization attempt.
1683
- */
1684
- 401: Result;
1685
- /**
1686
- * Forbidden
1687
- */
1688
- 403: Result;
1689
- /**
1690
- * Not Found
1691
- */
1692
- 404: Result;
1693
- /**
1694
- * Internal Server Error
1695
- */
1696
- 500: Result;
1697
- /**
1698
- * Default error handling for unmentioned status codes
1699
- */
1700
- default: Result;
1701
- };
1702
-
1703
- export type GetSubmodelByIdMetadataAasRepositoryError = GetSubmodelByIdMetadataAasRepositoryErrors[keyof GetSubmodelByIdMetadataAasRepositoryErrors];
1704
-
1705
- export type GetSubmodelByIdMetadataAasRepositoryResponses = {
1706
- /**
1707
- * Requested Submodel
1708
- */
1709
- 200: SubmodelMetadata;
1710
- };
1711
-
1712
- export type GetSubmodelByIdMetadataAasRepositoryResponse = GetSubmodelByIdMetadataAasRepositoryResponses[keyof GetSubmodelByIdMetadataAasRepositoryResponses];
1713
-
1714
- export type PatchSubmodelByIdMetadataAasRepositoryData = {
1715
- /**
1716
- * Submodel object
1717
- */
1718
- body: SubmodelMetadata;
1719
- path: {
1720
- /**
1721
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1722
- */
1723
- aasIdentifier: string;
1724
- /**
1725
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
1726
- */
1727
- submodelIdentifier: string;
1728
- };
1729
- query?: never;
1730
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/$metadata';
1731
- };
1732
-
1733
- export type PatchSubmodelByIdMetadataAasRepositoryErrors = {
1734
- /**
1735
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1736
- */
1737
- 400: Result;
1738
- /**
1739
- * Unauthorized, e.g. the server refused the authorization attempt.
1740
- */
1741
- 401: Result;
1742
- /**
1743
- * Forbidden
1744
- */
1745
- 403: Result;
1746
- /**
1747
- * Not Found
1748
- */
1749
- 404: Result;
1750
- /**
1751
- * Internal Server Error
1752
- */
1753
- 500: Result;
1754
- /**
1755
- * Default error handling for unmentioned status codes
1756
- */
1757
- default: Result;
1758
- };
1759
-
1760
- export type PatchSubmodelByIdMetadataAasRepositoryError = PatchSubmodelByIdMetadataAasRepositoryErrors[keyof PatchSubmodelByIdMetadataAasRepositoryErrors];
1761
-
1762
- export type PatchSubmodelByIdMetadataAasRepositoryResponses = {
1763
- /**
1764
- * Submodel updated successfully
1765
- */
1766
- 204: void;
1767
- };
1768
-
1769
- export type PatchSubmodelByIdMetadataAasRepositoryResponse = PatchSubmodelByIdMetadataAasRepositoryResponses[keyof PatchSubmodelByIdMetadataAasRepositoryResponses];
1770
-
1771
- export type GetSubmodelByIdValueOnlyAasRepositoryData = {
1772
- body?: never;
1773
- path: {
1774
- /**
1775
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1776
- */
1777
- aasIdentifier: string;
1778
- /**
1779
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
1780
- */
1781
- submodelIdentifier: string;
1782
- };
1783
- query?: {
1784
- /**
1785
- * Determines the structural depth of the respective resource content
1786
- */
1787
- level?: 'deep' | 'core';
1788
- /**
1789
- * Determines to which extent the resource is being serialized
1790
- */
1791
- extent?: 'withBlobValue' | 'withoutBlobValue';
1792
- };
1793
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/$value';
1794
- };
1795
-
1796
- export type GetSubmodelByIdValueOnlyAasRepositoryErrors = {
1797
- /**
1798
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1799
- */
1800
- 400: Result;
1801
- /**
1802
- * Unauthorized, e.g. the server refused the authorization attempt.
1803
- */
1804
- 401: Result;
1805
- /**
1806
- * Forbidden
1807
- */
1808
- 403: Result;
1809
- /**
1810
- * Not Found
1811
- */
1812
- 404: Result;
1813
- /**
1814
- * Internal Server Error
1815
- */
1816
- 500: Result;
1817
- /**
1818
- * Default error handling for unmentioned status codes
1819
- */
1820
- default: Result;
1821
- };
1822
-
1823
- export type GetSubmodelByIdValueOnlyAasRepositoryError = GetSubmodelByIdValueOnlyAasRepositoryErrors[keyof GetSubmodelByIdValueOnlyAasRepositoryErrors];
1824
-
1825
- export type GetSubmodelByIdValueOnlyAasRepositoryResponses = {
1826
- /**
1827
- * Requested Submodel
1828
- */
1829
- 200: SubmodelValue;
1830
- };
1831
-
1832
- export type GetSubmodelByIdValueOnlyAasRepositoryResponse = GetSubmodelByIdValueOnlyAasRepositoryResponses[keyof GetSubmodelByIdValueOnlyAasRepositoryResponses];
1833
-
1834
- export type PatchSubmodelByIdValueOnlyAasRepositoryData = {
1835
- /**
1836
- * Submodel object in the ValueOnly representation
1837
- */
1838
- body: SubmodelValue;
1839
- path: {
1840
- /**
1841
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1842
- */
1843
- aasIdentifier: string;
1844
- /**
1845
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
1846
- */
1847
- submodelIdentifier: string;
1848
- };
1849
- query?: {
1850
- /**
1851
- * Determines the structural depth of the respective resource content
1852
- */
1853
- level?: 'core';
1854
- };
1855
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/$value';
1856
- };
1857
-
1858
- export type PatchSubmodelByIdValueOnlyAasRepositoryErrors = {
1859
- /**
1860
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1861
- */
1862
- 400: Result;
1863
- /**
1864
- * Unauthorized, e.g. the server refused the authorization attempt.
1865
- */
1866
- 401: Result;
1867
- /**
1868
- * Forbidden
1869
- */
1870
- 403: Result;
1871
- /**
1872
- * Not Found
1873
- */
1874
- 404: Result;
1875
- /**
1876
- * Internal Server Error
1877
- */
1878
- 500: Result;
1879
- /**
1880
- * Default error handling for unmentioned status codes
1881
- */
1882
- default: Result;
1883
- };
1884
-
1885
- export type PatchSubmodelByIdValueOnlyAasRepositoryError = PatchSubmodelByIdValueOnlyAasRepositoryErrors[keyof PatchSubmodelByIdValueOnlyAasRepositoryErrors];
1886
-
1887
- export type PatchSubmodelByIdValueOnlyAasRepositoryResponses = {
1888
- /**
1889
- * Submodel updated successfully
1890
- */
1891
- 204: void;
1892
- };
1893
-
1894
- export type PatchSubmodelByIdValueOnlyAasRepositoryResponse = PatchSubmodelByIdValueOnlyAasRepositoryResponses[keyof PatchSubmodelByIdValueOnlyAasRepositoryResponses];
1895
-
1896
- export type GetSubmodelByIdReferenceAasRepositoryData = {
1897
- body?: never;
1898
- path: {
1899
- /**
1900
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1901
- */
1902
- aasIdentifier: string;
1903
- /**
1904
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
1905
- */
1906
- submodelIdentifier: string;
1907
- };
1908
- query?: never;
1909
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/$reference';
1910
- };
1911
-
1912
- export type GetSubmodelByIdReferenceAasRepositoryErrors = {
1913
- /**
1914
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1915
- */
1916
- 400: Result;
1917
- /**
1918
- * Unauthorized, e.g. the server refused the authorization attempt.
1919
- */
1920
- 401: Result;
1921
- /**
1922
- * Forbidden
1923
- */
1924
- 403: Result;
1925
- /**
1926
- * Not Found
1927
- */
1928
- 404: Result;
1929
- /**
1930
- * Internal Server Error
1931
- */
1932
- 500: Result;
1933
- /**
1934
- * Default error handling for unmentioned status codes
1935
- */
1936
- default: Result;
1937
- };
1938
-
1939
- export type GetSubmodelByIdReferenceAasRepositoryError = GetSubmodelByIdReferenceAasRepositoryErrors[keyof GetSubmodelByIdReferenceAasRepositoryErrors];
1940
-
1941
- export type GetSubmodelByIdReferenceAasRepositoryResponses = {
1942
- /**
1943
- * Requested Submodel as a Reference
1944
- */
1945
- 200: Reference;
1946
- };
1947
-
1948
- export type GetSubmodelByIdReferenceAasRepositoryResponse = GetSubmodelByIdReferenceAasRepositoryResponses[keyof GetSubmodelByIdReferenceAasRepositoryResponses];
1949
-
1950
- export type GetSubmodelByIdPathAasRepositoryData = {
1951
- body?: never;
1952
- path: {
1953
- /**
1954
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
1955
- */
1956
- aasIdentifier: string;
1957
- /**
1958
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
1959
- */
1960
- submodelIdentifier: string;
1961
- };
1962
- query?: {
1963
- /**
1964
- * Determines the structural depth of the respective resource content
1965
- */
1966
- level?: 'deep' | 'core';
1967
- };
1968
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/$path';
1969
- };
1970
-
1971
- export type GetSubmodelByIdPathAasRepositoryErrors = {
1972
- /**
1973
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
1974
- */
1975
- 400: Result;
1976
- /**
1977
- * Unauthorized, e.g. the server refused the authorization attempt.
1978
- */
1979
- 401: Result;
1980
- /**
1981
- * Forbidden
1982
- */
1983
- 403: Result;
1984
- /**
1985
- * Not Found
1986
- */
1987
- 404: Result;
1988
- /**
1989
- * Internal Server Error
1990
- */
1991
- 500: Result;
1992
- /**
1993
- * Default error handling for unmentioned status codes
1994
- */
1995
- default: Result;
1996
- };
1997
-
1998
- export type GetSubmodelByIdPathAasRepositoryError = GetSubmodelByIdPathAasRepositoryErrors[keyof GetSubmodelByIdPathAasRepositoryErrors];
1999
-
2000
- export type GetSubmodelByIdPathAasRepositoryResponses = {
2001
- /**
2002
- * Requested Submodel in Path notation
2003
- */
2004
- 200: Array<PathItem>;
2005
- };
2006
-
2007
- export type GetSubmodelByIdPathAasRepositoryResponse = GetSubmodelByIdPathAasRepositoryResponses[keyof GetSubmodelByIdPathAasRepositoryResponses];
2008
-
2009
- export type GetAllSubmodelElementsAasRepositoryData = {
2010
- body?: never;
2011
- path: {
2012
- /**
2013
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2014
- */
2015
- aasIdentifier: string;
2016
- /**
2017
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2018
- */
2019
- submodelIdentifier: string;
2020
- };
2021
- query?: {
2022
- /**
2023
- * The maximum number of elements in the response array
2024
- */
2025
- limit?: number;
2026
- /**
2027
- * A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
2028
- */
2029
- cursor?: string;
2030
- /**
2031
- * Determines the structural depth of the respective resource content
2032
- */
2033
- level?: 'deep' | 'core';
2034
- /**
2035
- * Determines to which extent the resource is being serialized
2036
- */
2037
- extent?: 'withBlobValue' | 'withoutBlobValue';
2038
- };
2039
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements';
2040
- };
2041
-
2042
- export type GetAllSubmodelElementsAasRepositoryErrors = {
2043
- /**
2044
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2045
- */
2046
- 400: Result;
2047
- /**
2048
- * Unauthorized, e.g. the server refused the authorization attempt.
2049
- */
2050
- 401: Result;
2051
- /**
2052
- * Forbidden
2053
- */
2054
- 403: Result;
2055
- /**
2056
- * Not Found
2057
- */
2058
- 404: Result;
2059
- /**
2060
- * Internal Server Error
2061
- */
2062
- 500: Result;
2063
- /**
2064
- * Default error handling for unmentioned status codes
2065
- */
2066
- default: Result;
2067
- };
2068
-
2069
- export type GetAllSubmodelElementsAasRepositoryError = GetAllSubmodelElementsAasRepositoryErrors[keyof GetAllSubmodelElementsAasRepositoryErrors];
2070
-
2071
- export type GetAllSubmodelElementsAasRepositoryResponses = {
2072
- /**
2073
- * List of found submodel elements
2074
- */
2075
- 200: GetSubmodelElementsResult;
2076
- };
2077
-
2078
- export type GetAllSubmodelElementsAasRepositoryResponse = GetAllSubmodelElementsAasRepositoryResponses[keyof GetAllSubmodelElementsAasRepositoryResponses];
2079
-
2080
- export type PostSubmodelElementAasRepositoryData = {
2081
- /**
2082
- * Requested submodel element
2083
- */
2084
- body: SubmodelElement;
2085
- path: {
2086
- /**
2087
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2088
- */
2089
- aasIdentifier: string;
2090
- /**
2091
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2092
- */
2093
- submodelIdentifier: string;
2094
- };
2095
- query?: never;
2096
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements';
2097
- };
2098
-
2099
- export type PostSubmodelElementAasRepositoryErrors = {
2100
- /**
2101
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2102
- */
2103
- 400: Result;
2104
- /**
2105
- * Unauthorized, e.g. the server refused the authorization attempt.
2106
- */
2107
- 401: Result;
2108
- /**
2109
- * Forbidden
2110
- */
2111
- 403: Result;
2112
- /**
2113
- * Not Found
2114
- */
2115
- 404: Result;
2116
- /**
2117
- * 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.
2118
- */
2119
- 409: Result;
2120
- /**
2121
- * Internal Server Error
2122
- */
2123
- 500: Result;
2124
- /**
2125
- * Default error handling for unmentioned status codes
2126
- */
2127
- default: Result;
2128
- };
2129
-
2130
- export type PostSubmodelElementAasRepositoryError = PostSubmodelElementAasRepositoryErrors[keyof PostSubmodelElementAasRepositoryErrors];
2131
-
2132
- export type PostSubmodelElementAasRepositoryResponses = {
2133
- /**
2134
- * Submodel element created successfully
2135
- */
2136
- 201: SubmodelElement;
2137
- };
2138
-
2139
- export type PostSubmodelElementAasRepositoryResponse = PostSubmodelElementAasRepositoryResponses[keyof PostSubmodelElementAasRepositoryResponses];
2140
-
2141
- export type GetAllSubmodelElementsMetadataAasRepositoryData = {
2142
- body?: never;
2143
- path: {
2144
- /**
2145
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2146
- */
2147
- aasIdentifier: string;
2148
- /**
2149
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2150
- */
2151
- submodelIdentifier: string;
2152
- };
2153
- query?: {
2154
- /**
2155
- * The maximum number of elements in the response array
2156
- */
2157
- limit?: number;
2158
- /**
2159
- * A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
2160
- */
2161
- cursor?: string;
2162
- };
2163
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$metadata';
2164
- };
2165
-
2166
- export type GetAllSubmodelElementsMetadataAasRepositoryErrors = {
2167
- /**
2168
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2169
- */
2170
- 400: Result;
2171
- /**
2172
- * Unauthorized, e.g. the server refused the authorization attempt.
2173
- */
2174
- 401: Result;
2175
- /**
2176
- * Forbidden
2177
- */
2178
- 403: Result;
2179
- /**
2180
- * Not Found
2181
- */
2182
- 404: Result;
2183
- /**
2184
- * Internal Server Error
2185
- */
2186
- 500: Result;
2187
- /**
2188
- * Default error handling for unmentioned status codes
2189
- */
2190
- default: Result;
2191
- };
2192
-
2193
- export type GetAllSubmodelElementsMetadataAasRepositoryError = GetAllSubmodelElementsMetadataAasRepositoryErrors[keyof GetAllSubmodelElementsMetadataAasRepositoryErrors];
2194
-
2195
- export type GetAllSubmodelElementsMetadataAasRepositoryResponses = {
2196
- /**
2197
- * List of found submodel elements
2198
- */
2199
- 200: GetSubmodelElementsMetadataResult;
2200
- };
2201
-
2202
- export type GetAllSubmodelElementsMetadataAasRepositoryResponse = GetAllSubmodelElementsMetadataAasRepositoryResponses[keyof GetAllSubmodelElementsMetadataAasRepositoryResponses];
2203
-
2204
- export type GetAllSubmodelElementsValueOnlyAasRepositoryData = {
2205
- body?: never;
2206
- path: {
2207
- /**
2208
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2209
- */
2210
- aasIdentifier: string;
2211
- /**
2212
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2213
- */
2214
- submodelIdentifier: string;
2215
- };
2216
- query?: {
2217
- /**
2218
- * The maximum number of elements in the response array
2219
- */
2220
- limit?: number;
2221
- /**
2222
- * A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
2223
- */
2224
- cursor?: string;
2225
- /**
2226
- * Determines the structural depth of the respective resource content
2227
- */
2228
- level?: 'deep' | 'core';
2229
- };
2230
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$value';
2231
- };
2232
-
2233
- export type GetAllSubmodelElementsValueOnlyAasRepositoryErrors = {
2234
- /**
2235
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2236
- */
2237
- 400: Result;
2238
- /**
2239
- * Unauthorized, e.g. the server refused the authorization attempt.
2240
- */
2241
- 401: Result;
2242
- /**
2243
- * Forbidden
2244
- */
2245
- 403: Result;
2246
- /**
2247
- * Not Found
2248
- */
2249
- 404: Result;
2250
- /**
2251
- * Internal Server Error
2252
- */
2253
- 500: Result;
2254
- /**
2255
- * Default error handling for unmentioned status codes
2256
- */
2257
- default: Result;
2258
- };
2259
-
2260
- export type GetAllSubmodelElementsValueOnlyAasRepositoryError = GetAllSubmodelElementsValueOnlyAasRepositoryErrors[keyof GetAllSubmodelElementsValueOnlyAasRepositoryErrors];
2261
-
2262
- export type GetAllSubmodelElementsValueOnlyAasRepositoryResponses = {
2263
- /**
2264
- * List of found submodel elements in their ValueOnly representation
2265
- */
2266
- 200: GetSubmodelElementsValueResult;
2267
- };
2268
-
2269
- export type GetAllSubmodelElementsValueOnlyAasRepositoryResponse = GetAllSubmodelElementsValueOnlyAasRepositoryResponses[keyof GetAllSubmodelElementsValueOnlyAasRepositoryResponses];
2270
-
2271
- export type GetAllSubmodelElementsReferenceAasRepositoryData = {
2272
- body?: never;
2273
- path: {
2274
- /**
2275
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2276
- */
2277
- aasIdentifier: string;
2278
- /**
2279
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2280
- */
2281
- submodelIdentifier: string;
2282
- };
2283
- query?: {
2284
- /**
2285
- * The maximum number of elements in the response array
2286
- */
2287
- limit?: number;
2288
- /**
2289
- * A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
2290
- */
2291
- cursor?: string;
2292
- /**
2293
- * Determines the structural depth of the respective resource content
2294
- */
2295
- level?: 'core';
2296
- };
2297
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$reference';
2298
- };
2299
-
2300
- export type GetAllSubmodelElementsReferenceAasRepositoryErrors = {
2301
- /**
2302
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2303
- */
2304
- 400: Result;
2305
- /**
2306
- * Unauthorized, e.g. the server refused the authorization attempt.
2307
- */
2308
- 401: Result;
2309
- /**
2310
- * Forbidden
2311
- */
2312
- 403: Result;
2313
- /**
2314
- * Not Found
2315
- */
2316
- 404: Result;
2317
- /**
2318
- * Internal Server Error
2319
- */
2320
- 500: Result;
2321
- /**
2322
- * Default error handling for unmentioned status codes
2323
- */
2324
- default: Result;
2325
- };
2326
-
2327
- export type GetAllSubmodelElementsReferenceAasRepositoryError = GetAllSubmodelElementsReferenceAasRepositoryErrors[keyof GetAllSubmodelElementsReferenceAasRepositoryErrors];
2328
-
2329
- export type GetAllSubmodelElementsReferenceAasRepositoryResponses = {
2330
- /**
2331
- * List of References of the found submodel elements
2332
- */
2333
- 200: GetReferencesResult;
2334
- };
2335
-
2336
- export type GetAllSubmodelElementsReferenceAasRepositoryResponse = GetAllSubmodelElementsReferenceAasRepositoryResponses[keyof GetAllSubmodelElementsReferenceAasRepositoryResponses];
2337
-
2338
- export type GetAllSubmodelElementsPathAasRepositoryData = {
2339
- body?: never;
2340
- path: {
2341
- /**
2342
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2343
- */
2344
- aasIdentifier: string;
2345
- /**
2346
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2347
- */
2348
- submodelIdentifier: string;
2349
- };
2350
- query?: {
2351
- /**
2352
- * The maximum number of elements in the response array
2353
- */
2354
- limit?: number;
2355
- /**
2356
- * A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
2357
- */
2358
- cursor?: string;
2359
- /**
2360
- * Determines the structural depth of the respective resource content
2361
- */
2362
- level?: 'deep' | 'core';
2363
- /**
2364
- * Determines to which extent the resource is being serialized
2365
- */
2366
- extent?: 'withBlobValue' | 'withoutBlobValue';
2367
- };
2368
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/$path';
2369
- };
2370
-
2371
- export type GetAllSubmodelElementsPathAasRepositoryErrors = {
2372
- /**
2373
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2374
- */
2375
- 400: Result;
2376
- /**
2377
- * Unauthorized, e.g. the server refused the authorization attempt.
2378
- */
2379
- 401: Result;
2380
- /**
2381
- * Forbidden
2382
- */
2383
- 403: Result;
2384
- /**
2385
- * Not Found
2386
- */
2387
- 404: Result;
2388
- /**
2389
- * Internal Server Error
2390
- */
2391
- 500: Result;
2392
- /**
2393
- * Default error handling for unmentioned status codes
2394
- */
2395
- default: Result;
2396
- };
2397
-
2398
- export type GetAllSubmodelElementsPathAasRepositoryError = GetAllSubmodelElementsPathAasRepositoryErrors[keyof GetAllSubmodelElementsPathAasRepositoryErrors];
2399
-
2400
- export type GetAllSubmodelElementsPathAasRepositoryResponses = {
2401
- /**
2402
- * List of found submodel elements in the Path notation
2403
- */
2404
- 200: GetPathItemsResult;
2405
- };
2406
-
2407
- export type GetAllSubmodelElementsPathAasRepositoryResponse = GetAllSubmodelElementsPathAasRepositoryResponses[keyof GetAllSubmodelElementsPathAasRepositoryResponses];
2408
-
2409
- export type DeleteSubmodelElementByPathAasRepositoryData = {
2410
- body?: never;
2411
- path: {
2412
- /**
2413
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2414
- */
2415
- aasIdentifier: string;
2416
- /**
2417
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2418
- */
2419
- submodelIdentifier: string;
2420
- /**
2421
- * IdShort path to the submodel element (dot-separated)
2422
- */
2423
- idShortPath: string;
2424
- };
2425
- query?: never;
2426
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}';
2427
- };
2428
-
2429
- export type DeleteSubmodelElementByPathAasRepositoryErrors = {
2430
- /**
2431
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2432
- */
2433
- 400: Result;
2434
- /**
2435
- * Unauthorized, e.g. the server refused the authorization attempt.
2436
- */
2437
- 401: Result;
2438
- /**
2439
- * Forbidden
2440
- */
2441
- 403: Result;
2442
- /**
2443
- * Not Found
2444
- */
2445
- 404: Result;
2446
- /**
2447
- * Internal Server Error
2448
- */
2449
- 500: Result;
2450
- /**
2451
- * Default error handling for unmentioned status codes
2452
- */
2453
- default: Result;
2454
- };
2455
-
2456
- export type DeleteSubmodelElementByPathAasRepositoryError = DeleteSubmodelElementByPathAasRepositoryErrors[keyof DeleteSubmodelElementByPathAasRepositoryErrors];
2457
-
2458
- export type DeleteSubmodelElementByPathAasRepositoryResponses = {
2459
- /**
2460
- * Submodel element deleted successfully
2461
- */
2462
- 204: void;
2463
- };
2464
-
2465
- export type DeleteSubmodelElementByPathAasRepositoryResponse = DeleteSubmodelElementByPathAasRepositoryResponses[keyof DeleteSubmodelElementByPathAasRepositoryResponses];
2466
-
2467
- export type GetSubmodelElementByPathAasRepositoryData = {
2468
- body?: never;
2469
- path: {
2470
- /**
2471
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2472
- */
2473
- aasIdentifier: string;
2474
- /**
2475
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2476
- */
2477
- submodelIdentifier: string;
2478
- /**
2479
- * IdShort path to the submodel element (dot-separated)
2480
- */
2481
- idShortPath: string;
2482
- };
2483
- query?: {
2484
- /**
2485
- * Determines the structural depth of the respective resource content
2486
- */
2487
- level?: 'deep' | 'core';
2488
- /**
2489
- * Determines to which extent the resource is being serialized
2490
- */
2491
- extent?: 'withBlobValue' | 'withoutBlobValue';
2492
- };
2493
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}';
2494
- };
2495
-
2496
- export type GetSubmodelElementByPathAasRepositoryErrors = {
2497
- /**
2498
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2499
- */
2500
- 400: Result;
2501
- /**
2502
- * Unauthorized, e.g. the server refused the authorization attempt.
2503
- */
2504
- 401: Result;
2505
- /**
2506
- * Forbidden
2507
- */
2508
- 403: Result;
2509
- /**
2510
- * Not Found
2511
- */
2512
- 404: Result;
2513
- /**
2514
- * Internal Server Error
2515
- */
2516
- 500: Result;
2517
- /**
2518
- * Default error handling for unmentioned status codes
2519
- */
2520
- default: Result;
2521
- };
2522
-
2523
- export type GetSubmodelElementByPathAasRepositoryError = GetSubmodelElementByPathAasRepositoryErrors[keyof GetSubmodelElementByPathAasRepositoryErrors];
2524
-
2525
- export type GetSubmodelElementByPathAasRepositoryResponses = {
2526
- /**
2527
- * Requested submodel element
2528
- */
2529
- 200: SubmodelElement;
2530
- };
2531
-
2532
- export type GetSubmodelElementByPathAasRepositoryResponse = GetSubmodelElementByPathAasRepositoryResponses[keyof GetSubmodelElementByPathAasRepositoryResponses];
2533
-
2534
- export type PatchSubmodelElementValueByPathAasRepositoryData = {
2535
- /**
2536
- * The updated value of the submodel element
2537
- */
2538
- body: SubmodelElement;
2539
- path: {
2540
- /**
2541
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2542
- */
2543
- aasIdentifier: string;
2544
- /**
2545
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2546
- */
2547
- submodelIdentifier: string;
2548
- /**
2549
- * IdShort path to the submodel element (dot-separated)
2550
- */
2551
- idShortPath: string;
2552
- };
2553
- query?: {
2554
- /**
2555
- * Determines the structural depth of the respective resource content
2556
- */
2557
- level?: 'deep' | 'core';
2558
- };
2559
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}';
2560
- };
2561
-
2562
- export type PatchSubmodelElementValueByPathAasRepositoryErrors = {
2563
- /**
2564
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2565
- */
2566
- 400: Result;
2567
- /**
2568
- * Unauthorized, e.g. the server refused the authorization attempt.
2569
- */
2570
- 401: Result;
2571
- /**
2572
- * Forbidden
2573
- */
2574
- 403: Result;
2575
- /**
2576
- * Not Found
2577
- */
2578
- 404: Result;
2579
- /**
2580
- * Internal Server Error
2581
- */
2582
- 500: Result;
2583
- /**
2584
- * Default error handling for unmentioned status codes
2585
- */
2586
- default: Result;
2587
- };
2588
-
2589
- export type PatchSubmodelElementValueByPathAasRepositoryError = PatchSubmodelElementValueByPathAasRepositoryErrors[keyof PatchSubmodelElementValueByPathAasRepositoryErrors];
2590
-
2591
- export type PatchSubmodelElementValueByPathAasRepositoryResponses = {
2592
- /**
2593
- * Submodel element updated successfully
2594
- */
2595
- 204: void;
2596
- };
2597
-
2598
- export type PatchSubmodelElementValueByPathAasRepositoryResponse = PatchSubmodelElementValueByPathAasRepositoryResponses[keyof PatchSubmodelElementValueByPathAasRepositoryResponses];
2599
-
2600
- export type PostSubmodelElementByPathAasRepositoryData = {
2601
- /**
2602
- * Requested submodel element
2603
- */
2604
- body: SubmodelElement;
2605
- path: {
2606
- /**
2607
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2608
- */
2609
- aasIdentifier: string;
2610
- /**
2611
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2612
- */
2613
- submodelIdentifier: string;
2614
- /**
2615
- * IdShort path to the submodel element (dot-separated)
2616
- */
2617
- idShortPath: string;
2618
- };
2619
- query?: never;
2620
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}';
2621
- };
2622
-
2623
- export type PostSubmodelElementByPathAasRepositoryErrors = {
2624
- /**
2625
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2626
- */
2627
- 400: Result;
2628
- /**
2629
- * Unauthorized, e.g. the server refused the authorization attempt.
2630
- */
2631
- 401: Result;
2632
- /**
2633
- * Forbidden
2634
- */
2635
- 403: Result;
2636
- /**
2637
- * Not Found
2638
- */
2639
- 404: Result;
2640
- /**
2641
- * 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.
2642
- */
2643
- 409: Result;
2644
- /**
2645
- * Internal Server Error
2646
- */
2647
- 500: Result;
2648
- /**
2649
- * Default error handling for unmentioned status codes
2650
- */
2651
- default: Result;
2652
- };
2653
-
2654
- export type PostSubmodelElementByPathAasRepositoryError = PostSubmodelElementByPathAasRepositoryErrors[keyof PostSubmodelElementByPathAasRepositoryErrors];
2655
-
2656
- export type PostSubmodelElementByPathAasRepositoryResponses = {
2657
- /**
2658
- * Submodel element created successfully
2659
- */
2660
- 201: SubmodelElement;
2661
- };
2662
-
2663
- export type PostSubmodelElementByPathAasRepositoryResponse = PostSubmodelElementByPathAasRepositoryResponses[keyof PostSubmodelElementByPathAasRepositoryResponses];
2664
-
2665
- export type PutSubmodelElementByPathAasRepositoryData = {
2666
- /**
2667
- * Requested submodel element
2668
- */
2669
- body: SubmodelElement;
2670
- path: {
2671
- /**
2672
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2673
- */
2674
- aasIdentifier: string;
2675
- /**
2676
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2677
- */
2678
- submodelIdentifier: string;
2679
- /**
2680
- * IdShort path to the submodel element (dot-separated)
2681
- */
2682
- idShortPath: string;
2683
- };
2684
- query?: never;
2685
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}';
2686
- };
2687
-
2688
- export type PutSubmodelElementByPathAasRepositoryErrors = {
2689
- /**
2690
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2691
- */
2692
- 400: Result;
2693
- /**
2694
- * Unauthorized, e.g. the server refused the authorization attempt.
2695
- */
2696
- 401: Result;
2697
- /**
2698
- * Forbidden
2699
- */
2700
- 403: Result;
2701
- /**
2702
- * Not Found
2703
- */
2704
- 404: Result;
2705
- /**
2706
- * Internal Server Error
2707
- */
2708
- 500: Result;
2709
- /**
2710
- * Default error handling for unmentioned status codes
2711
- */
2712
- default: Result;
2713
- };
2714
-
2715
- export type PutSubmodelElementByPathAasRepositoryError = PutSubmodelElementByPathAasRepositoryErrors[keyof PutSubmodelElementByPathAasRepositoryErrors];
2716
-
2717
- export type PutSubmodelElementByPathAasRepositoryResponses = {
2718
- /**
2719
- * Submodel element updated successfully
2720
- */
2721
- 204: void;
2722
- };
2723
-
2724
- export type PutSubmodelElementByPathAasRepositoryResponse = PutSubmodelElementByPathAasRepositoryResponses[keyof PutSubmodelElementByPathAasRepositoryResponses];
2725
-
2726
- export type GetSubmodelElementByPathMetadataAasRepositoryData = {
2727
- body?: never;
2728
- path: {
2729
- /**
2730
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2731
- */
2732
- aasIdentifier: string;
2733
- /**
2734
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2735
- */
2736
- submodelIdentifier: string;
2737
- /**
2738
- * IdShort path to the submodel element (dot-separated)
2739
- */
2740
- idShortPath: string;
2741
- };
2742
- query?: never;
2743
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata';
2744
- };
2745
-
2746
- export type GetSubmodelElementByPathMetadataAasRepositoryErrors = {
2747
- /**
2748
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2749
- */
2750
- 400: Result;
2751
- /**
2752
- * Unauthorized, e.g. the server refused the authorization attempt.
2753
- */
2754
- 401: Result;
2755
- /**
2756
- * Forbidden
2757
- */
2758
- 403: Result;
2759
- /**
2760
- * Not Found
2761
- */
2762
- 404: Result;
2763
- /**
2764
- * Internal Server Error
2765
- */
2766
- 500: Result;
2767
- /**
2768
- * Default error handling for unmentioned status codes
2769
- */
2770
- default: Result;
2771
- };
2772
-
2773
- export type GetSubmodelElementByPathMetadataAasRepositoryError = GetSubmodelElementByPathMetadataAasRepositoryErrors[keyof GetSubmodelElementByPathMetadataAasRepositoryErrors];
2774
-
2775
- export type GetSubmodelElementByPathMetadataAasRepositoryResponses = {
2776
- /**
2777
- * Requested submodel element
2778
- */
2779
- 200: SubmodelElementMetadata;
2780
- };
2781
-
2782
- export type GetSubmodelElementByPathMetadataAasRepositoryResponse = GetSubmodelElementByPathMetadataAasRepositoryResponses[keyof GetSubmodelElementByPathMetadataAasRepositoryResponses];
2783
-
2784
- export type PatchSubmodelElementValueByPathMetadataData = {
2785
- /**
2786
- * The updated metadata attributes of the submodel element
2787
- */
2788
- body: SubmodelElementMetadata;
2789
- path: {
2790
- /**
2791
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2792
- */
2793
- aasIdentifier: string;
2794
- /**
2795
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2796
- */
2797
- submodelIdentifier: string;
2798
- /**
2799
- * IdShort path to the submodel element (dot-separated)
2800
- */
2801
- idShortPath: string;
2802
- };
2803
- query?: never;
2804
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$metadata';
2805
- };
2806
-
2807
- export type PatchSubmodelElementValueByPathMetadataErrors = {
2808
- /**
2809
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2810
- */
2811
- 400: Result;
2812
- /**
2813
- * Unauthorized, e.g. the server refused the authorization attempt.
2814
- */
2815
- 401: Result;
2816
- /**
2817
- * Forbidden
2818
- */
2819
- 403: Result;
2820
- /**
2821
- * Not Found
2822
- */
2823
- 404: Result;
2824
- /**
2825
- * Internal Server Error
2826
- */
2827
- 500: Result;
2828
- /**
2829
- * Default error handling for unmentioned status codes
2830
- */
2831
- default: Result;
2832
- };
2833
-
2834
- export type PatchSubmodelElementValueByPathMetadataError = PatchSubmodelElementValueByPathMetadataErrors[keyof PatchSubmodelElementValueByPathMetadataErrors];
2835
-
2836
- export type PatchSubmodelElementValueByPathMetadataResponses = {
2837
- /**
2838
- * Submodel element updated successfully
2839
- */
2840
- 204: void;
2841
- };
2842
-
2843
- export type PatchSubmodelElementValueByPathMetadataResponse = PatchSubmodelElementValueByPathMetadataResponses[keyof PatchSubmodelElementValueByPathMetadataResponses];
2844
-
2845
- export type GetSubmodelElementByPathValueOnlyAasRepositoryData = {
2846
- body?: never;
2847
- path: {
2848
- /**
2849
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2850
- */
2851
- aasIdentifier: string;
2852
- /**
2853
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2854
- */
2855
- submodelIdentifier: string;
2856
- /**
2857
- * IdShort path to the submodel element (dot-separated)
2858
- */
2859
- idShortPath: string;
2860
- };
2861
- query?: {
2862
- /**
2863
- * Determines the structural depth of the respective resource content
2864
- */
2865
- level?: 'deep' | 'core';
2866
- /**
2867
- * Determines to which extent the resource is being serialized
2868
- */
2869
- extent?: 'withBlobValue' | 'withoutBlobValue';
2870
- };
2871
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value';
2872
- };
2873
-
2874
- export type GetSubmodelElementByPathValueOnlyAasRepositoryErrors = {
2875
- /**
2876
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2877
- */
2878
- 400: Result;
2879
- /**
2880
- * Unauthorized, e.g. the server refused the authorization attempt.
2881
- */
2882
- 401: Result;
2883
- /**
2884
- * Forbidden
2885
- */
2886
- 403: Result;
2887
- /**
2888
- * Not Found
2889
- */
2890
- 404: Result;
2891
- /**
2892
- * Internal Server Error
2893
- */
2894
- 500: Result;
2895
- /**
2896
- * Default error handling for unmentioned status codes
2897
- */
2898
- default: Result;
2899
- };
2900
-
2901
- export type GetSubmodelElementByPathValueOnlyAasRepositoryError = GetSubmodelElementByPathValueOnlyAasRepositoryErrors[keyof GetSubmodelElementByPathValueOnlyAasRepositoryErrors];
2902
-
2903
- export type GetSubmodelElementByPathValueOnlyAasRepositoryResponses = {
2904
- /**
2905
- * Requested submodel element in its ValueOnly representation
2906
- */
2907
- 200: SubmodelElementValue;
2908
- };
2909
-
2910
- export type GetSubmodelElementByPathValueOnlyAasRepositoryResponse = GetSubmodelElementByPathValueOnlyAasRepositoryResponses[keyof GetSubmodelElementByPathValueOnlyAasRepositoryResponses];
2911
-
2912
- export type PatchSubmodelElementValueByPathValueOnlyData = {
2913
- /**
2914
- * The updated value of the submodel element
2915
- */
2916
- body: SubmodelElementValue;
2917
- path: {
2918
- /**
2919
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2920
- */
2921
- aasIdentifier: string;
2922
- /**
2923
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2924
- */
2925
- submodelIdentifier: string;
2926
- /**
2927
- * IdShort path to the submodel element (dot-separated)
2928
- */
2929
- idShortPath: string;
2930
- };
2931
- query?: {
2932
- /**
2933
- * Determines the structural depth of the respective resource content
2934
- */
2935
- level?: 'deep' | 'core';
2936
- };
2937
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$value';
2938
- };
2939
-
2940
- export type PatchSubmodelElementValueByPathValueOnlyErrors = {
2941
- /**
2942
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
2943
- */
2944
- 400: Result;
2945
- /**
2946
- * Unauthorized, e.g. the server refused the authorization attempt.
2947
- */
2948
- 401: Result;
2949
- /**
2950
- * Forbidden
2951
- */
2952
- 403: Result;
2953
- /**
2954
- * Not Found
2955
- */
2956
- 404: Result;
2957
- /**
2958
- * Internal Server Error
2959
- */
2960
- 500: Result;
2961
- /**
2962
- * Default error handling for unmentioned status codes
2963
- */
2964
- default: Result;
2965
- };
2966
-
2967
- export type PatchSubmodelElementValueByPathValueOnlyError = PatchSubmodelElementValueByPathValueOnlyErrors[keyof PatchSubmodelElementValueByPathValueOnlyErrors];
2968
-
2969
- export type PatchSubmodelElementValueByPathValueOnlyResponses = {
2970
- /**
2971
- * Submodel element updated successfully
2972
- */
2973
- 204: void;
2974
- };
2975
-
2976
- export type PatchSubmodelElementValueByPathValueOnlyResponse = PatchSubmodelElementValueByPathValueOnlyResponses[keyof PatchSubmodelElementValueByPathValueOnlyResponses];
2977
-
2978
- export type GetSubmodelElementByPathReferenceAasRepositoryData = {
2979
- body?: never;
2980
- path: {
2981
- /**
2982
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
2983
- */
2984
- aasIdentifier: string;
2985
- /**
2986
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
2987
- */
2988
- submodelIdentifier: string;
2989
- /**
2990
- * IdShort path to the submodel element (dot-separated)
2991
- */
2992
- idShortPath: string;
2993
- };
2994
- query?: {
2995
- /**
2996
- * Determines the structural depth of the respective resource content
2997
- */
2998
- level?: 'core';
2999
- };
3000
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$reference';
3001
- };
3002
-
3003
- export type GetSubmodelElementByPathReferenceAasRepositoryErrors = {
3004
- /**
3005
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3006
- */
3007
- 400: Result;
3008
- /**
3009
- * Unauthorized, e.g. the server refused the authorization attempt.
3010
- */
3011
- 401: Result;
3012
- /**
3013
- * Forbidden
3014
- */
3015
- 403: Result;
3016
- /**
3017
- * Not Found
3018
- */
3019
- 404: Result;
3020
- /**
3021
- * Internal Server Error
3022
- */
3023
- 500: Result;
3024
- /**
3025
- * Default error handling for unmentioned status codes
3026
- */
3027
- default: Result;
3028
- };
3029
-
3030
- export type GetSubmodelElementByPathReferenceAasRepositoryError = GetSubmodelElementByPathReferenceAasRepositoryErrors[keyof GetSubmodelElementByPathReferenceAasRepositoryErrors];
3031
-
3032
- export type GetSubmodelElementByPathReferenceAasRepositoryResponses = {
3033
- /**
3034
- * Requested submodel element in its ValueOnly representation
3035
- */
3036
- 200: Reference;
3037
- };
3038
-
3039
- export type GetSubmodelElementByPathReferenceAasRepositoryResponse = GetSubmodelElementByPathReferenceAasRepositoryResponses[keyof GetSubmodelElementByPathReferenceAasRepositoryResponses];
3040
-
3041
- export type GetSubmodelElementByPathPathAasRepositoryData = {
3042
- body?: never;
3043
- path: {
3044
- /**
3045
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
3046
- */
3047
- aasIdentifier: string;
3048
- /**
3049
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
3050
- */
3051
- submodelIdentifier: string;
3052
- /**
3053
- * IdShort path to the submodel element (dot-separated)
3054
- */
3055
- idShortPath: string;
3056
- };
3057
- query?: {
3058
- /**
3059
- * Determines the structural depth of the respective resource content
3060
- */
3061
- level?: 'deep' | 'core';
3062
- };
3063
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/$path';
3064
- };
3065
-
3066
- export type GetSubmodelElementByPathPathAasRepositoryErrors = {
3067
- /**
3068
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3069
- */
3070
- 400: Result;
3071
- /**
3072
- * Unauthorized, e.g. the server refused the authorization attempt.
3073
- */
3074
- 401: Result;
3075
- /**
3076
- * Forbidden
3077
- */
3078
- 403: Result;
3079
- /**
3080
- * Not Found
3081
- */
3082
- 404: Result;
3083
- /**
3084
- * Internal Server Error
3085
- */
3086
- 500: Result;
3087
- /**
3088
- * Default error handling for unmentioned status codes
3089
- */
3090
- default: Result;
3091
- };
3092
-
3093
- export type GetSubmodelElementByPathPathAasRepositoryError = GetSubmodelElementByPathPathAasRepositoryErrors[keyof GetSubmodelElementByPathPathAasRepositoryErrors];
3094
-
3095
- export type GetSubmodelElementByPathPathAasRepositoryResponses = {
3096
- /**
3097
- * Requested submodel element in the Path notation
3098
- */
3099
- 200: Array<PathItem>;
3100
- };
3101
-
3102
- export type GetSubmodelElementByPathPathAasRepositoryResponse = GetSubmodelElementByPathPathAasRepositoryResponses[keyof GetSubmodelElementByPathPathAasRepositoryResponses];
3103
-
3104
- export type DeleteFileByPathAasRepositoryData = {
3105
- body?: never;
3106
- path: {
3107
- /**
3108
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
3109
- */
3110
- aasIdentifier: string;
3111
- /**
3112
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
3113
- */
3114
- submodelIdentifier: string;
3115
- /**
3116
- * IdShort path to the submodel element (dot-separated)
3117
- */
3118
- idShortPath: string;
3119
- };
3120
- query?: never;
3121
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment';
3122
- };
3123
-
3124
- export type DeleteFileByPathAasRepositoryErrors = {
3125
- /**
3126
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3127
- */
3128
- 400: Result;
3129
- /**
3130
- * Unauthorized, e.g. the server refused the authorization attempt.
3131
- */
3132
- 401: Result;
3133
- /**
3134
- * Forbidden
3135
- */
3136
- 403: Result;
3137
- /**
3138
- * Not Found
3139
- */
3140
- 404: Result;
3141
- /**
3142
- * Internal Server Error
3143
- */
3144
- 500: Result;
3145
- /**
3146
- * Default error handling for unmentioned status codes
3147
- */
3148
- default: Result;
3149
- };
3150
-
3151
- export type DeleteFileByPathAasRepositoryError = DeleteFileByPathAasRepositoryErrors[keyof DeleteFileByPathAasRepositoryErrors];
3152
-
3153
- export type DeleteFileByPathAasRepositoryResponses = {
3154
- /**
3155
- * Submodel element updated successfully
3156
- */
3157
- 200: unknown;
3158
- };
3159
-
3160
- export type GetFileByPathAasRepositoryData = {
3161
- body?: never;
3162
- path: {
3163
- /**
3164
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
3165
- */
3166
- aasIdentifier: string;
3167
- /**
3168
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
3169
- */
3170
- submodelIdentifier: string;
3171
- /**
3172
- * IdShort path to the submodel element (dot-separated)
3173
- */
3174
- idShortPath: string;
3175
- };
3176
- query?: never;
3177
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment';
3178
- };
3179
-
3180
- export type GetFileByPathAasRepositoryErrors = {
3181
- /**
3182
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3183
- */
3184
- 400: Result;
3185
- /**
3186
- * Unauthorized, e.g. the server refused the authorization attempt.
3187
- */
3188
- 401: Result;
3189
- /**
3190
- * Forbidden
3191
- */
3192
- 403: Result;
3193
- /**
3194
- * Not Found
3195
- */
3196
- 404: Result;
3197
- /**
3198
- * Internal Server Error
3199
- */
3200
- 500: Result;
3201
- /**
3202
- * Default error handling for unmentioned status codes
3203
- */
3204
- default: Result;
3205
- };
3206
-
3207
- export type GetFileByPathAasRepositoryError = GetFileByPathAasRepositoryErrors[keyof GetFileByPathAasRepositoryErrors];
3208
-
3209
- export type GetFileByPathAasRepositoryResponses = {
3210
- /**
3211
- * Requested file
3212
- */
3213
- 200: Blob | File;
3214
- };
3215
-
3216
- export type GetFileByPathAasRepositoryResponse = GetFileByPathAasRepositoryResponses[keyof GetFileByPathAasRepositoryResponses];
3217
-
3218
- export type PutFileByPathAasRepositoryData = {
3219
- /**
3220
- * File to upload
3221
- */
3222
- body: IdShortPathAttachmentBody;
3223
- path: {
3224
- /**
3225
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
3226
- */
3227
- aasIdentifier: string;
3228
- /**
3229
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
3230
- */
3231
- submodelIdentifier: string;
3232
- /**
3233
- * IdShort path to the submodel element (dot-separated)
3234
- */
3235
- idShortPath: string;
3236
- };
3237
- query?: never;
3238
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/attachment';
3239
- };
3240
-
3241
- export type PutFileByPathAasRepositoryErrors = {
3242
- /**
3243
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3244
- */
3245
- 400: Result;
3246
- /**
3247
- * Unauthorized, e.g. the server refused the authorization attempt.
3248
- */
3249
- 401: Result;
3250
- /**
3251
- * Forbidden
3252
- */
3253
- 403: Result;
3254
- /**
3255
- * Not Found
3256
- */
3257
- 404: Result;
3258
- /**
3259
- * Internal Server Error
3260
- */
3261
- 500: Result;
3262
- /**
3263
- * Default error handling for unmentioned status codes
3264
- */
3265
- default: Result;
3266
- };
3267
-
3268
- export type PutFileByPathAasRepositoryError = PutFileByPathAasRepositoryErrors[keyof PutFileByPathAasRepositoryErrors];
3269
-
3270
- export type PutFileByPathAasRepositoryResponses = {
3271
- /**
3272
- * Submodel element updated successfully
3273
- */
3274
- 204: void;
3275
- };
3276
-
3277
- export type PutFileByPathAasRepositoryResponse = PutFileByPathAasRepositoryResponses[keyof PutFileByPathAasRepositoryResponses];
3278
-
3279
- export type InvokeOperationAasRepositoryData = {
3280
- /**
3281
- * Operation request object
3282
- */
3283
- body: OperationRequest;
3284
- path: {
3285
- /**
3286
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
3287
- */
3288
- aasIdentifier: string;
3289
- /**
3290
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
3291
- */
3292
- submodelIdentifier: string;
3293
- /**
3294
- * IdShort path to the submodel element (dot-separated)
3295
- */
3296
- idShortPath: string;
3297
- };
3298
- query?: never;
3299
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke';
3300
- };
3301
-
3302
- export type InvokeOperationAasRepositoryErrors = {
3303
- /**
3304
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3305
- */
3306
- 400: Result;
3307
- /**
3308
- * Unauthorized, e.g. the server refused the authorization attempt.
3309
- */
3310
- 401: Result;
3311
- /**
3312
- * Forbidden
3313
- */
3314
- 403: Result;
3315
- /**
3316
- * Not Found
3317
- */
3318
- 404: Result;
3319
- /**
3320
- * Internal Server Error
3321
- */
3322
- 500: Result;
3323
- /**
3324
- * Default error handling for unmentioned status codes
3325
- */
3326
- default: Result;
3327
- };
3328
-
3329
- export type InvokeOperationAasRepositoryError = InvokeOperationAasRepositoryErrors[keyof InvokeOperationAasRepositoryErrors];
3330
-
3331
- export type InvokeOperationAasRepositoryResponses = {
3332
- /**
3333
- * Operation result object
3334
- */
3335
- 200: OperationResult;
3336
- };
3337
-
3338
- export type InvokeOperationAasRepositoryResponse = InvokeOperationAasRepositoryResponses[keyof InvokeOperationAasRepositoryResponses];
3339
-
3340
- export type InvokeOperationValueOnlyAasRepositoryData = {
3341
- /**
3342
- * Operation request object
3343
- */
3344
- body: OperationRequestValueOnly;
3345
- path: {
3346
- /**
3347
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
3348
- */
3349
- aasIdentifier: string;
3350
- /**
3351
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
3352
- */
3353
- submodelIdentifier: string;
3354
- /**
3355
- * IdShort path to the submodel element (dot-separated)
3356
- */
3357
- idShortPath: string;
3358
- };
3359
- query?: never;
3360
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke/$value';
3361
- };
3362
-
3363
- export type InvokeOperationValueOnlyAasRepositoryErrors = {
3364
- /**
3365
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3366
- */
3367
- 400: Result;
3368
- /**
3369
- * Unauthorized, e.g. the server refused the authorization attempt.
3370
- */
3371
- 401: Result;
3372
- /**
3373
- * Forbidden
3374
- */
3375
- 403: Result;
3376
- /**
3377
- * Not Found
3378
- */
3379
- 404: Result;
3380
- /**
3381
- * Internal Server Error
3382
- */
3383
- 500: Result;
3384
- /**
3385
- * Default error handling for unmentioned status codes
3386
- */
3387
- default: Result;
3388
- };
3389
-
3390
- export type InvokeOperationValueOnlyAasRepositoryError = InvokeOperationValueOnlyAasRepositoryErrors[keyof InvokeOperationValueOnlyAasRepositoryErrors];
3391
-
3392
- export type InvokeOperationValueOnlyAasRepositoryResponses = {
3393
- /**
3394
- * Operation result object
3395
- */
3396
- 200: OperationResultValueOnly;
3397
- };
3398
-
3399
- export type InvokeOperationValueOnlyAasRepositoryResponse = InvokeOperationValueOnlyAasRepositoryResponses[keyof InvokeOperationValueOnlyAasRepositoryResponses];
3400
-
3401
- export type InvokeOperationAsyncAasRepositoryData = {
3402
- /**
3403
- * Operation request object
3404
- */
3405
- body: OperationRequest;
3406
- path: {
3407
- /**
3408
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
3409
- */
3410
- aasIdentifier: string;
3411
- /**
3412
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
3413
- */
3414
- submodelIdentifier: string;
3415
- /**
3416
- * IdShort path to the submodel element (dot-separated)
3417
- */
3418
- idShortPath: string;
3419
- };
3420
- query?: never;
3421
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async';
3422
- };
3423
-
3424
- export type InvokeOperationAsyncAasRepositoryErrors = {
3425
- /**
3426
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3427
- */
3428
- 400: Result;
3429
- /**
3430
- * Unauthorized, e.g. the server refused the authorization attempt.
3431
- */
3432
- 401: Result;
3433
- /**
3434
- * Forbidden
3435
- */
3436
- 403: Result;
3437
- /**
3438
- * Not Found
3439
- */
3440
- 404: Result;
3441
- /**
3442
- * Internal Server Error
3443
- */
3444
- 500: Result;
3445
- /**
3446
- * Default error handling for unmentioned status codes
3447
- */
3448
- default: Result;
3449
- };
3450
-
3451
- export type InvokeOperationAsyncAasRepositoryError = InvokeOperationAsyncAasRepositoryErrors[keyof InvokeOperationAsyncAasRepositoryErrors];
3452
-
3453
- export type InvokeOperationAsyncAasRepositoryResponses = {
3454
- /**
3455
- * The server has accepted the request.
3456
- */
3457
- 202: unknown;
3458
- };
3459
-
3460
- export type InvokeOperationAsyncValueOnlyAasRepositoryData = {
3461
- /**
3462
- * Operation request object
3463
- */
3464
- body: OperationRequestValueOnly;
3465
- path: {
3466
- /**
3467
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
3468
- */
3469
- aasIdentifier: string;
3470
- /**
3471
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
3472
- */
3473
- submodelIdentifier: string;
3474
- /**
3475
- * IdShort path to the submodel element (dot-separated)
3476
- */
3477
- idShortPath: string;
3478
- };
3479
- query?: never;
3480
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/invoke-async/$value';
3481
- };
3482
-
3483
- export type InvokeOperationAsyncValueOnlyAasRepositoryErrors = {
3484
- /**
3485
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3486
- */
3487
- 400: Result;
3488
- /**
3489
- * Unauthorized, e.g. the server refused the authorization attempt.
3490
- */
3491
- 401: Result;
3492
- /**
3493
- * Forbidden
3494
- */
3495
- 403: Result;
3496
- /**
3497
- * Not Found
3498
- */
3499
- 404: Result;
3500
- /**
3501
- * Internal Server Error
3502
- */
3503
- 500: Result;
3504
- /**
3505
- * Default error handling for unmentioned status codes
3506
- */
3507
- default: Result;
3508
- };
3509
-
3510
- export type InvokeOperationAsyncValueOnlyAasRepositoryError = InvokeOperationAsyncValueOnlyAasRepositoryErrors[keyof InvokeOperationAsyncValueOnlyAasRepositoryErrors];
3511
-
3512
- export type InvokeOperationAsyncValueOnlyAasRepositoryResponses = {
3513
- /**
3514
- * The server has accepted the request.
3515
- */
3516
- 202: unknown;
3517
- };
3518
-
3519
- export type GetOperationAsyncStatusAasRepositoryData = {
3520
- body?: never;
3521
- path: {
3522
- /**
3523
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
3524
- */
3525
- aasIdentifier: string;
3526
- /**
3527
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
3528
- */
3529
- submodelIdentifier: string;
3530
- /**
3531
- * IdShort path to the submodel element (dot-separated)
3532
- */
3533
- idShortPath: string;
3534
- /**
3535
- * 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)
3536
- */
3537
- handleId: string;
3538
- };
3539
- query?: never;
3540
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-status/{handleId}';
3541
- };
3542
-
3543
- export type GetOperationAsyncStatusAasRepositoryErrors = {
3544
- /**
3545
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3546
- */
3547
- 400: Result;
3548
- /**
3549
- * Unauthorized, e.g. the server refused the authorization attempt.
3550
- */
3551
- 401: Result;
3552
- /**
3553
- * Forbidden
3554
- */
3555
- 403: Result;
3556
- /**
3557
- * Not Found
3558
- */
3559
- 404: Result;
3560
- /**
3561
- * Internal Server Error
3562
- */
3563
- 500: Result;
3564
- /**
3565
- * Default error handling for unmentioned status codes
3566
- */
3567
- default: Result;
3568
- };
3569
-
3570
- export type GetOperationAsyncStatusAasRepositoryError = GetOperationAsyncStatusAasRepositoryErrors[keyof GetOperationAsyncStatusAasRepositoryErrors];
3571
-
3572
- export type GetOperationAsyncStatusAasRepositoryResponses = {
3573
- /**
3574
- * Operation result object containing information that the 'executionState' is still 'Running'
3575
- */
3576
- 200: BaseOperationResult;
3577
- };
3578
-
3579
- export type GetOperationAsyncStatusAasRepositoryResponse = GetOperationAsyncStatusAasRepositoryResponses[keyof GetOperationAsyncStatusAasRepositoryResponses];
3580
-
3581
- export type GetOperationAsyncResultAasRepositoryData = {
3582
- body?: never;
3583
- path: {
3584
- /**
3585
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
3586
- */
3587
- aasIdentifier: string;
3588
- /**
3589
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
3590
- */
3591
- submodelIdentifier: string;
3592
- /**
3593
- * IdShort path to the submodel element (dot-separated)
3594
- */
3595
- idShortPath: string;
3596
- /**
3597
- * 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)
3598
- */
3599
- handleId: string;
3600
- };
3601
- query?: never;
3602
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}';
3603
- };
3604
-
3605
- export type GetOperationAsyncResultAasRepositoryErrors = {
3606
- /**
3607
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3608
- */
3609
- 400: Result;
3610
- /**
3611
- * Unauthorized, e.g. the server refused the authorization attempt.
3612
- */
3613
- 401: Result;
3614
- /**
3615
- * Forbidden
3616
- */
3617
- 403: Result;
3618
- /**
3619
- * Not Found
3620
- */
3621
- 404: Result;
3622
- /**
3623
- * Internal Server Error
3624
- */
3625
- 500: Result;
3626
- /**
3627
- * Default error handling for unmentioned status codes
3628
- */
3629
- default: Result;
3630
- };
3631
-
3632
- export type GetOperationAsyncResultAasRepositoryError = GetOperationAsyncResultAasRepositoryErrors[keyof GetOperationAsyncResultAasRepositoryErrors];
3633
-
3634
- export type GetOperationAsyncResultAasRepositoryResponses = {
3635
- /**
3636
- * Operation result object
3637
- */
3638
- 200: OperationResult;
3639
- };
3640
-
3641
- export type GetOperationAsyncResultAasRepositoryResponse = GetOperationAsyncResultAasRepositoryResponses[keyof GetOperationAsyncResultAasRepositoryResponses];
3642
-
3643
- export type GetOperationAsyncResultValueOnlyAasRepositoryData = {
3644
- body?: never;
3645
- path: {
3646
- /**
3647
- * The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
3648
- */
3649
- aasIdentifier: string;
3650
- /**
3651
- * The Submodel’s unique id (UTF8-BASE64-URL-encoded)
3652
- */
3653
- submodelIdentifier: string;
3654
- /**
3655
- * IdShort path to the submodel element (dot-separated)
3656
- */
3657
- idShortPath: string;
3658
- /**
3659
- * 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)
3660
- */
3661
- handleId: string;
3662
- };
3663
- query?: never;
3664
- url: '/shells/{aasIdentifier}/submodels/{submodelIdentifier}/submodel-elements/{idShortPath}/operation-results/{handleId}/$value';
3665
- };
3666
-
3667
- export type GetOperationAsyncResultValueOnlyAasRepositoryErrors = {
3668
- /**
3669
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3670
- */
3671
- 400: Result;
3672
- /**
3673
- * Unauthorized, e.g. the server refused the authorization attempt.
3674
- */
3675
- 401: Result;
3676
- /**
3677
- * Forbidden
3678
- */
3679
- 403: Result;
3680
- /**
3681
- * Not Found
3682
- */
3683
- 404: Result;
3684
- /**
3685
- * Internal Server Error
3686
- */
3687
- 500: Result;
3688
- /**
3689
- * Default error handling for unmentioned status codes
3690
- */
3691
- default: Result;
3692
- };
3693
-
3694
- export type GetOperationAsyncResultValueOnlyAasRepositoryError = GetOperationAsyncResultValueOnlyAasRepositoryErrors[keyof GetOperationAsyncResultValueOnlyAasRepositoryErrors];
3695
-
3696
- export type GetOperationAsyncResultValueOnlyAasRepositoryResponses = {
3697
- /**
3698
- * Operation result object
3699
- */
3700
- 200: OperationResultValueOnly;
3701
- };
3702
-
3703
- export type GetOperationAsyncResultValueOnlyAasRepositoryResponse = GetOperationAsyncResultValueOnlyAasRepositoryResponses[keyof GetOperationAsyncResultValueOnlyAasRepositoryResponses];
3704
-
3705
- export type GenerateSerializationByIdsData = {
3706
- body?: never;
3707
- path?: never;
3708
- query?: {
3709
- /**
3710
- * The Asset Administration Shells' unique ids (UTF8-BASE64-URL-encoded)
3711
- */
3712
- aasIds?: Array<string>;
3713
- /**
3714
- * The Submodels' unique ids (UTF8-BASE64-URL-encoded)
3715
- */
3716
- submodelIds?: Array<string>;
3717
- /**
3718
- * Include Concept Descriptions?
3719
- */
3720
- includeConceptDescriptions?: boolean;
3721
- };
3722
- url: '/serialization';
3723
- };
3724
-
3725
- export type GenerateSerializationByIdsErrors = {
3726
- /**
3727
- * Bad Request, e.g. the request parameters of the format of the request body is wrong.
3728
- */
3729
- 400: Result;
3730
- /**
3731
- * Unauthorized, e.g. the server refused the authorization attempt.
3732
- */
3733
- 401: Result;
3734
- /**
3735
- * Forbidden
3736
- */
3737
- 403: Result;
3738
- /**
3739
- * Internal Server Error
3740
- */
3741
- 500: Result;
3742
- /**
3743
- * Default error handling for unmentioned status codes
3744
- */
3745
- default: Result;
3746
- };
3747
-
3748
- export type GenerateSerializationByIdsError = GenerateSerializationByIdsErrors[keyof GenerateSerializationByIdsErrors];
3749
-
3750
- export type GenerateSerializationByIdsResponses = {
3751
- /**
3752
- * AASX package
3753
- */
3754
- 200: Blob | File;
3755
- };
3756
-
3757
- export type GenerateSerializationByIdsResponse = GenerateSerializationByIdsResponses[keyof GenerateSerializationByIdsResponses];
3758
-
3759
- export type GetDescriptionData = {
3760
- body?: never;
3761
- path?: never;
3762
- query?: never;
3763
- url: '/description';
3764
- };
3765
-
3766
- export type GetDescriptionErrors = {
3767
- /**
3768
- * Unauthorized, e.g. the server refused the authorization attempt.
3769
- */
3770
- 401: Result;
3771
- /**
3772
- * Forbidden
3773
- */
3774
- 403: Result;
3775
- };
3776
-
3777
- export type GetDescriptionError = GetDescriptionErrors[keyof GetDescriptionErrors];
3778
-
3779
- export type GetDescriptionResponses = {
3780
- /**
3781
- * Requested Description
3782
- */
3783
- 200: ServiceDescription;
3784
- };
3785
-
3786
- export type GetDescriptionResponse = GetDescriptionResponses[keyof GetDescriptionResponses];