basyx-typescript-sdk 0.1.1 → 0.1.3

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