basyx-typescript-sdk 2.1.2 → 2.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bundle/index.cjs +7037 -2076
- package/bundle/index.cjs.map +1 -1
- package/bundle/index.mjs +7020 -2062
- package/bundle/index.mjs.map +1 -1
- package/dist/clients/AasDiscoveryClient.d.ts +31 -0
- package/dist/clients/AasDiscoveryClient.js +51 -0
- package/dist/clients/AasRegistryClient.d.ts +11 -0
- package/dist/clients/AasRegistryClient.js +20 -0
- package/dist/clients/AasRepositoryClient.d.ts +50 -0
- package/dist/clients/AasRepositoryClient.js +81 -0
- package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +28 -0
- package/dist/clients/ConceptDescriptionRepositoryClient.js +47 -0
- package/dist/clients/SubmodelRegistryClient.d.ts +11 -0
- package/dist/clients/SubmodelRegistryClient.js +20 -0
- package/dist/clients/SubmodelRepositoryClient.d.ts +229 -0
- package/dist/clients/SubmodelRepositoryClient.js +501 -0
- package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +2 -2
- package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +2 -2
- package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +2 -2
- package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +2 -2
- package/dist/generated/AasRegistryService/index.d.ts +1 -0
- package/dist/generated/AasRegistryService/index.js +1 -0
- package/dist/generated/AasRegistryService/models/index.d.ts +10 -10
- package/dist/generated/AasRegistryService/models/index.js +1 -1
- package/dist/generated/AasRegistryService/runtime.d.ts +181 -0
- package/dist/generated/AasRegistryService/runtime.js +326 -0
- package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.d.ts +2 -2
- package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +2 -2
- package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +2 -2
- package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +2 -2
- package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +2 -2
- package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +2 -2
- package/dist/generated/AasRepositoryService/index.d.ts +1 -0
- package/dist/generated/AasRepositoryService/index.js +1 -0
- package/dist/generated/AasRepositoryService/runtime.d.ts +181 -0
- package/dist/generated/AasRepositoryService/runtime.js +326 -0
- package/dist/lib/apiConfig.d.ts +1 -2
- package/dist/lib/apiConfig.js +2 -3
- package/dist/lib/index.d.ts +1 -0
- package/dist/lib/index.js +2 -0
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/package.json +2 -2
|
@@ -43,6 +43,94 @@ export class SubmodelRepositoryClient {
|
|
|
43
43
|
return { success: false, error: customError };
|
|
44
44
|
}
|
|
45
45
|
}
|
|
46
|
+
/**
|
|
47
|
+
* Returns all Submodels in metadata representation
|
|
48
|
+
*/
|
|
49
|
+
async getAllSubmodelsMetadata(options) {
|
|
50
|
+
const { configuration, semanticId, idShort, limit, cursor } = options;
|
|
51
|
+
try {
|
|
52
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
53
|
+
const encodedSemanticId = semanticId ? base64Encode(JSON.stringify(semanticId)) : undefined;
|
|
54
|
+
const result = await apiInstance.getAllSubmodelsMetadata({
|
|
55
|
+
semanticId: encodedSemanticId,
|
|
56
|
+
idShort: idShort,
|
|
57
|
+
limit: limit,
|
|
58
|
+
cursor: cursor,
|
|
59
|
+
});
|
|
60
|
+
return { success: true, data: result };
|
|
61
|
+
}
|
|
62
|
+
catch (err) {
|
|
63
|
+
const customError = await handleApiError(err);
|
|
64
|
+
return { success: false, error: customError };
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
/**
|
|
68
|
+
* Returns all Submodels in value-only representation
|
|
69
|
+
*/
|
|
70
|
+
async getAllSubmodelsValueOnly(options) {
|
|
71
|
+
const { configuration, semanticId, idShort, limit, cursor, level, extent } = options;
|
|
72
|
+
try {
|
|
73
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
74
|
+
const encodedSemanticId = semanticId ? base64Encode(JSON.stringify(semanticId)) : undefined;
|
|
75
|
+
const result = await apiInstance.getAllSubmodelsValueOnly({
|
|
76
|
+
semanticId: encodedSemanticId,
|
|
77
|
+
idShort: idShort,
|
|
78
|
+
limit: limit,
|
|
79
|
+
cursor: cursor,
|
|
80
|
+
level: level,
|
|
81
|
+
extent: extent,
|
|
82
|
+
});
|
|
83
|
+
return { success: true, data: result };
|
|
84
|
+
}
|
|
85
|
+
catch (err) {
|
|
86
|
+
const customError = await handleApiError(err);
|
|
87
|
+
return { success: false, error: customError };
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Returns references to all Submodels
|
|
92
|
+
*/
|
|
93
|
+
async getAllSubmodelsReference(options) {
|
|
94
|
+
const { configuration, semanticId, idShort, limit, cursor, level } = options;
|
|
95
|
+
try {
|
|
96
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
97
|
+
const encodedSemanticId = semanticId ? base64Encode(JSON.stringify(semanticId)) : undefined;
|
|
98
|
+
const result = await apiInstance.getAllSubmodelsReference({
|
|
99
|
+
semanticId: encodedSemanticId,
|
|
100
|
+
idShort: idShort,
|
|
101
|
+
limit: limit,
|
|
102
|
+
cursor: cursor,
|
|
103
|
+
level: level,
|
|
104
|
+
});
|
|
105
|
+
return { success: true, data: result };
|
|
106
|
+
}
|
|
107
|
+
catch (err) {
|
|
108
|
+
const customError = await handleApiError(err);
|
|
109
|
+
return { success: false, error: customError };
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* Returns paths of all Submodels
|
|
114
|
+
*/
|
|
115
|
+
async getAllSubmodelsPath(options) {
|
|
116
|
+
const { configuration, semanticId, idShort, limit, cursor, level } = options;
|
|
117
|
+
try {
|
|
118
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
119
|
+
const encodedSemanticId = semanticId ? base64Encode(JSON.stringify(semanticId)) : undefined;
|
|
120
|
+
const result = await apiInstance.getAllSubmodelsPath({
|
|
121
|
+
semanticId: encodedSemanticId,
|
|
122
|
+
idShort: idShort,
|
|
123
|
+
limit: limit,
|
|
124
|
+
cursor: cursor,
|
|
125
|
+
level: level,
|
|
126
|
+
});
|
|
127
|
+
return { success: true, data: result };
|
|
128
|
+
}
|
|
129
|
+
catch (err) {
|
|
130
|
+
const customError = await handleApiError(err);
|
|
131
|
+
return { success: false, error: customError };
|
|
132
|
+
}
|
|
133
|
+
}
|
|
46
134
|
/**
|
|
47
135
|
* Creates a new Submodel
|
|
48
136
|
*
|
|
@@ -118,6 +206,43 @@ export class SubmodelRepositoryClient {
|
|
|
118
206
|
return { success: false, error: customError };
|
|
119
207
|
}
|
|
120
208
|
}
|
|
209
|
+
/**
|
|
210
|
+
* Returns a specific Submodel in reference representation
|
|
211
|
+
*/
|
|
212
|
+
async getSubmodelByIdReference(options) {
|
|
213
|
+
const { configuration, submodelIdentifier } = options;
|
|
214
|
+
try {
|
|
215
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
216
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
217
|
+
const result = await apiInstance.getSubmodelByIdReference({
|
|
218
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
219
|
+
});
|
|
220
|
+
return { success: true, data: result };
|
|
221
|
+
}
|
|
222
|
+
catch (err) {
|
|
223
|
+
const customError = await handleApiError(err);
|
|
224
|
+
return { success: false, error: customError };
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* Returns a specific Submodel in path representation
|
|
229
|
+
*/
|
|
230
|
+
async getSubmodelByIdPath(options) {
|
|
231
|
+
const { configuration, submodelIdentifier, level } = options;
|
|
232
|
+
try {
|
|
233
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
234
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
235
|
+
const result = await apiInstance.getSubmodelByIdPath({
|
|
236
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
237
|
+
level: level,
|
|
238
|
+
});
|
|
239
|
+
return { success: true, data: result };
|
|
240
|
+
}
|
|
241
|
+
catch (err) {
|
|
242
|
+
const customError = await handleApiError(err);
|
|
243
|
+
return { success: false, error: customError };
|
|
244
|
+
}
|
|
245
|
+
}
|
|
121
246
|
/**
|
|
122
247
|
* Updates an existing Submodel
|
|
123
248
|
*
|
|
@@ -144,6 +269,26 @@ export class SubmodelRepositoryClient {
|
|
|
144
269
|
return { success: false, error: customError };
|
|
145
270
|
}
|
|
146
271
|
}
|
|
272
|
+
/**
|
|
273
|
+
* Updates an existing Submodel partially
|
|
274
|
+
*/
|
|
275
|
+
async patchSubmodelById(options) {
|
|
276
|
+
const { configuration, submodelIdentifier, submodel, level } = options;
|
|
277
|
+
try {
|
|
278
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
279
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
280
|
+
const result = await apiInstance.patchSubmodelById({
|
|
281
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
282
|
+
submodel: convertCoreSubmodelToApiSubmodel(submodel),
|
|
283
|
+
level: level,
|
|
284
|
+
});
|
|
285
|
+
return { success: true, data: result };
|
|
286
|
+
}
|
|
287
|
+
catch (err) {
|
|
288
|
+
const customError = await handleApiError(err);
|
|
289
|
+
return { success: false, error: customError };
|
|
290
|
+
}
|
|
291
|
+
}
|
|
147
292
|
/**
|
|
148
293
|
* Returns all submodel elements including their hierarchy
|
|
149
294
|
*
|
|
@@ -180,6 +325,90 @@ export class SubmodelRepositoryClient {
|
|
|
180
325
|
return { success: false, error: customError };
|
|
181
326
|
}
|
|
182
327
|
}
|
|
328
|
+
/**
|
|
329
|
+
* Returns all submodel elements in metadata representation
|
|
330
|
+
*/
|
|
331
|
+
async getAllSubmodelElementsMetadata(options) {
|
|
332
|
+
const { configuration, submodelIdentifier, limit, cursor } = options;
|
|
333
|
+
try {
|
|
334
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
335
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
336
|
+
const result = await apiInstance.getAllSubmodelElementsMetadataSubmodelRepo({
|
|
337
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
338
|
+
limit: limit,
|
|
339
|
+
cursor: cursor,
|
|
340
|
+
});
|
|
341
|
+
return { success: true, data: result };
|
|
342
|
+
}
|
|
343
|
+
catch (err) {
|
|
344
|
+
const customError = await handleApiError(err);
|
|
345
|
+
return { success: false, error: customError };
|
|
346
|
+
}
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* Returns all submodel elements in value-only representation
|
|
350
|
+
*/
|
|
351
|
+
async getAllSubmodelElementsValueOnly(options) {
|
|
352
|
+
const { configuration, submodelIdentifier, limit, cursor, level, extent } = options;
|
|
353
|
+
try {
|
|
354
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
355
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
356
|
+
const result = await apiInstance.getAllSubmodelElementsValueOnlySubmodelRepo({
|
|
357
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
358
|
+
limit: limit,
|
|
359
|
+
cursor: cursor,
|
|
360
|
+
level: level,
|
|
361
|
+
extent: extent,
|
|
362
|
+
});
|
|
363
|
+
return { success: true, data: result };
|
|
364
|
+
}
|
|
365
|
+
catch (err) {
|
|
366
|
+
const customError = await handleApiError(err);
|
|
367
|
+
return { success: false, error: customError };
|
|
368
|
+
}
|
|
369
|
+
}
|
|
370
|
+
/**
|
|
371
|
+
* Returns references to all submodel elements
|
|
372
|
+
*/
|
|
373
|
+
async getAllSubmodelElementsReference(options) {
|
|
374
|
+
const { configuration, submodelIdentifier, limit, cursor, level } = options;
|
|
375
|
+
try {
|
|
376
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
377
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
378
|
+
const result = await apiInstance.getAllSubmodelElementsReferenceSubmodelRepo({
|
|
379
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
380
|
+
limit: limit,
|
|
381
|
+
cursor: cursor,
|
|
382
|
+
level: level,
|
|
383
|
+
});
|
|
384
|
+
return { success: true, data: result };
|
|
385
|
+
}
|
|
386
|
+
catch (err) {
|
|
387
|
+
const customError = await handleApiError(err);
|
|
388
|
+
return { success: false, error: customError };
|
|
389
|
+
}
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* Returns paths of all submodel elements
|
|
393
|
+
*/
|
|
394
|
+
async getAllSubmodelElementsPath(options) {
|
|
395
|
+
const { configuration, submodelIdentifier, limit, cursor, level } = options;
|
|
396
|
+
try {
|
|
397
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
398
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
399
|
+
const result = await apiInstance.getAllSubmodelElementsPathSubmodelRepo({
|
|
400
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
401
|
+
limit: limit,
|
|
402
|
+
cursor: cursor,
|
|
403
|
+
level: level,
|
|
404
|
+
});
|
|
405
|
+
return { success: true, data: result };
|
|
406
|
+
}
|
|
407
|
+
catch (err) {
|
|
408
|
+
const customError = await handleApiError(err);
|
|
409
|
+
return { success: false, error: customError };
|
|
410
|
+
}
|
|
411
|
+
}
|
|
183
412
|
/**
|
|
184
413
|
* Creates a new submodel element
|
|
185
414
|
*
|
|
@@ -235,6 +464,64 @@ export class SubmodelRepositoryClient {
|
|
|
235
464
|
return { success: false, error: customError };
|
|
236
465
|
}
|
|
237
466
|
}
|
|
467
|
+
/**
|
|
468
|
+
* Returns metadata attributes of a specific submodel element
|
|
469
|
+
*/
|
|
470
|
+
async getSubmodelElementByPathMetadata(options) {
|
|
471
|
+
const { configuration, submodelIdentifier, idShortPath } = options;
|
|
472
|
+
try {
|
|
473
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
474
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
475
|
+
const result = await apiInstance.getSubmodelElementByPathMetadataSubmodelRepo({
|
|
476
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
477
|
+
idShortPath: idShortPath,
|
|
478
|
+
});
|
|
479
|
+
return { success: true, data: result };
|
|
480
|
+
}
|
|
481
|
+
catch (err) {
|
|
482
|
+
const customError = await handleApiError(err);
|
|
483
|
+
return { success: false, error: customError };
|
|
484
|
+
}
|
|
485
|
+
}
|
|
486
|
+
/**
|
|
487
|
+
* Returns a specific submodel element in reference representation
|
|
488
|
+
*/
|
|
489
|
+
async getSubmodelElementByPathReference(options) {
|
|
490
|
+
const { configuration, submodelIdentifier, idShortPath } = options;
|
|
491
|
+
try {
|
|
492
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
493
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
494
|
+
const result = await apiInstance.getSubmodelElementByPathReferenceSubmodelRepo({
|
|
495
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
496
|
+
idShortPath: idShortPath,
|
|
497
|
+
});
|
|
498
|
+
return { success: true, data: result };
|
|
499
|
+
}
|
|
500
|
+
catch (err) {
|
|
501
|
+
const customError = await handleApiError(err);
|
|
502
|
+
return { success: false, error: customError };
|
|
503
|
+
}
|
|
504
|
+
}
|
|
505
|
+
/**
|
|
506
|
+
* Returns a specific submodel element in path representation
|
|
507
|
+
*/
|
|
508
|
+
async getSubmodelElementByPathPath(options) {
|
|
509
|
+
const { configuration, submodelIdentifier, idShortPath, level } = options;
|
|
510
|
+
try {
|
|
511
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
512
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
513
|
+
const result = await apiInstance.getSubmodelElementByPathPathSubmodelRepo({
|
|
514
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
515
|
+
idShortPath: idShortPath,
|
|
516
|
+
level: level,
|
|
517
|
+
});
|
|
518
|
+
return { success: true, data: result };
|
|
519
|
+
}
|
|
520
|
+
catch (err) {
|
|
521
|
+
const customError = await handleApiError(err);
|
|
522
|
+
return { success: false, error: customError };
|
|
523
|
+
}
|
|
524
|
+
}
|
|
238
525
|
/**
|
|
239
526
|
* Creates a new submodel element at a specified path within submodel elements hierarchy
|
|
240
527
|
*
|
|
@@ -319,6 +606,27 @@ export class SubmodelRepositoryClient {
|
|
|
319
606
|
return { success: false, error: customError };
|
|
320
607
|
}
|
|
321
608
|
}
|
|
609
|
+
/**
|
|
610
|
+
* Updates values of an existing submodel element at a specified path
|
|
611
|
+
*/
|
|
612
|
+
async patchSubmodelElementByPath(options) {
|
|
613
|
+
const { configuration, submodelIdentifier, idShortPath, submodelElement, level } = options;
|
|
614
|
+
try {
|
|
615
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
616
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
617
|
+
const result = await apiInstance.patchSubmodelElementByPathSubmodelRepo({
|
|
618
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
619
|
+
idShortPath: idShortPath,
|
|
620
|
+
submodelElement: convertCoreSubmodelElementToApiSubmodelElement(submodelElement),
|
|
621
|
+
level: level,
|
|
622
|
+
});
|
|
623
|
+
return { success: true, data: result };
|
|
624
|
+
}
|
|
625
|
+
catch (err) {
|
|
626
|
+
const customError = await handleApiError(err);
|
|
627
|
+
return { success: false, error: customError };
|
|
628
|
+
}
|
|
629
|
+
}
|
|
322
630
|
/**
|
|
323
631
|
* Returns the metadata attributes of a specific Submodel
|
|
324
632
|
*
|
|
@@ -343,6 +651,26 @@ export class SubmodelRepositoryClient {
|
|
|
343
651
|
return { success: false, error: customError };
|
|
344
652
|
}
|
|
345
653
|
}
|
|
654
|
+
/**
|
|
655
|
+
* Updates metadata attributes of an existing Submodel
|
|
656
|
+
*/
|
|
657
|
+
async patchSubmodelByIdMetadata(options) {
|
|
658
|
+
const { configuration, submodelIdentifier, submodelMetadata, level } = options;
|
|
659
|
+
try {
|
|
660
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
661
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
662
|
+
const result = await apiInstance.patchSubmodelByIdMetadata({
|
|
663
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
664
|
+
submodelMetadata: submodelMetadata,
|
|
665
|
+
level: level,
|
|
666
|
+
});
|
|
667
|
+
return { success: true, data: result };
|
|
668
|
+
}
|
|
669
|
+
catch (err) {
|
|
670
|
+
const customError = await handleApiError(err);
|
|
671
|
+
return { success: false, error: customError };
|
|
672
|
+
}
|
|
673
|
+
}
|
|
346
674
|
/**
|
|
347
675
|
* Returns a specific Submodel in the ValueOnly representation
|
|
348
676
|
*
|
|
@@ -458,6 +786,85 @@ export class SubmodelRepositoryClient {
|
|
|
458
786
|
return { success: false, error: customError };
|
|
459
787
|
}
|
|
460
788
|
}
|
|
789
|
+
/**
|
|
790
|
+
* Updates metadata attributes of an existing SubmodelElement
|
|
791
|
+
*/
|
|
792
|
+
async patchSubmodelElementByPathMetadata(options) {
|
|
793
|
+
const { configuration, submodelIdentifier, idShortPath, submodelElementMetadata } = options;
|
|
794
|
+
try {
|
|
795
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
796
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
797
|
+
const result = await apiInstance.patchSubmodelElementByPathMetadataSubmodelRepo({
|
|
798
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
799
|
+
idShortPath: idShortPath,
|
|
800
|
+
submodelElementMetadata: submodelElementMetadata,
|
|
801
|
+
});
|
|
802
|
+
return { success: true, data: result };
|
|
803
|
+
}
|
|
804
|
+
catch (err) {
|
|
805
|
+
const customError = await handleApiError(err);
|
|
806
|
+
return { success: false, error: customError };
|
|
807
|
+
}
|
|
808
|
+
}
|
|
809
|
+
/**
|
|
810
|
+
* Returns file content for a submodel element at a specified path
|
|
811
|
+
*/
|
|
812
|
+
async getFileByPath(options) {
|
|
813
|
+
const { configuration, submodelIdentifier, idShortPath } = options;
|
|
814
|
+
try {
|
|
815
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
816
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
817
|
+
const result = await apiInstance.getFileByPathSubmodelRepo({
|
|
818
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
819
|
+
idShortPath: idShortPath,
|
|
820
|
+
});
|
|
821
|
+
return { success: true, data: result };
|
|
822
|
+
}
|
|
823
|
+
catch (err) {
|
|
824
|
+
const customError = await handleApiError(err);
|
|
825
|
+
return { success: false, error: customError };
|
|
826
|
+
}
|
|
827
|
+
}
|
|
828
|
+
/**
|
|
829
|
+
* Updates file content for a submodel element at a specified path
|
|
830
|
+
*/
|
|
831
|
+
async putFileByPath(options) {
|
|
832
|
+
const { configuration, submodelIdentifier, idShortPath, fileName, file } = options;
|
|
833
|
+
try {
|
|
834
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
835
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
836
|
+
const result = await apiInstance.putFileByPathSubmodelRepo({
|
|
837
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
838
|
+
idShortPath: idShortPath,
|
|
839
|
+
fileName: fileName,
|
|
840
|
+
file: file,
|
|
841
|
+
});
|
|
842
|
+
return { success: true, data: result };
|
|
843
|
+
}
|
|
844
|
+
catch (err) {
|
|
845
|
+
const customError = await handleApiError(err);
|
|
846
|
+
return { success: false, error: customError };
|
|
847
|
+
}
|
|
848
|
+
}
|
|
849
|
+
/**
|
|
850
|
+
* Deletes file content of an existing submodel element at a specified path
|
|
851
|
+
*/
|
|
852
|
+
async deleteFileByPath(options) {
|
|
853
|
+
const { configuration, submodelIdentifier, idShortPath } = options;
|
|
854
|
+
try {
|
|
855
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
856
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
857
|
+
const result = await apiInstance.deleteFileByPathSubmodelRepo({
|
|
858
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
859
|
+
idShortPath: idShortPath,
|
|
860
|
+
});
|
|
861
|
+
return { success: true, data: result };
|
|
862
|
+
}
|
|
863
|
+
catch (err) {
|
|
864
|
+
const customError = await handleApiError(err);
|
|
865
|
+
return { success: false, error: customError };
|
|
866
|
+
}
|
|
867
|
+
}
|
|
461
868
|
/**
|
|
462
869
|
* Synchronously invokes an Operation at a specified path
|
|
463
870
|
*
|
|
@@ -578,4 +985,98 @@ export class SubmodelRepositoryClient {
|
|
|
578
985
|
return { success: false, error: customError };
|
|
579
986
|
}
|
|
580
987
|
}
|
|
988
|
+
/**
|
|
989
|
+
* Returns status of an asynchronously invoked operation
|
|
990
|
+
*/
|
|
991
|
+
async getOperationAsyncStatus(options) {
|
|
992
|
+
const { configuration, submodelIdentifier, idShortPath, handleId } = options;
|
|
993
|
+
try {
|
|
994
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
995
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
996
|
+
const result = await apiInstance.getOperationAsyncStatus({
|
|
997
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
998
|
+
idShortPath: idShortPath,
|
|
999
|
+
handleId: handleId,
|
|
1000
|
+
});
|
|
1001
|
+
return { success: true, data: result };
|
|
1002
|
+
}
|
|
1003
|
+
catch (err) {
|
|
1004
|
+
const customError = await handleApiError(err);
|
|
1005
|
+
return { success: false, error: customError };
|
|
1006
|
+
}
|
|
1007
|
+
}
|
|
1008
|
+
/**
|
|
1009
|
+
* Returns result of an asynchronously invoked operation
|
|
1010
|
+
*/
|
|
1011
|
+
async getOperationAsyncResult(options) {
|
|
1012
|
+
const { configuration, submodelIdentifier, idShortPath, handleId } = options;
|
|
1013
|
+
try {
|
|
1014
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
1015
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
1016
|
+
const result = await apiInstance.getOperationAsyncResult({
|
|
1017
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
1018
|
+
idShortPath: idShortPath,
|
|
1019
|
+
handleId: handleId,
|
|
1020
|
+
});
|
|
1021
|
+
return { success: true, data: result };
|
|
1022
|
+
}
|
|
1023
|
+
catch (err) {
|
|
1024
|
+
const customError = await handleApiError(err);
|
|
1025
|
+
return { success: false, error: customError };
|
|
1026
|
+
}
|
|
1027
|
+
}
|
|
1028
|
+
/**
|
|
1029
|
+
* Returns result of an asynchronously invoked operation in value-only representation
|
|
1030
|
+
*/
|
|
1031
|
+
async getOperationAsyncResultValueOnly(options) {
|
|
1032
|
+
const { configuration, submodelIdentifier, idShortPath, handleId } = options;
|
|
1033
|
+
try {
|
|
1034
|
+
const apiInstance = new SubmodelRepositoryService.SubmodelRepositoryAPIApi(applyDefaults(configuration));
|
|
1035
|
+
const encodedSubmodelIdentifier = base64Encode(submodelIdentifier);
|
|
1036
|
+
const result = await apiInstance.getOperationAsyncResultValueOnly({
|
|
1037
|
+
submodelIdentifier: encodedSubmodelIdentifier,
|
|
1038
|
+
idShortPath: idShortPath,
|
|
1039
|
+
handleId: handleId,
|
|
1040
|
+
});
|
|
1041
|
+
return { success: true, data: result };
|
|
1042
|
+
}
|
|
1043
|
+
catch (err) {
|
|
1044
|
+
const customError = await handleApiError(err);
|
|
1045
|
+
return { success: false, error: customError };
|
|
1046
|
+
}
|
|
1047
|
+
}
|
|
1048
|
+
/**
|
|
1049
|
+
* Returns an appropriate serialization based on the specified format
|
|
1050
|
+
*/
|
|
1051
|
+
async generateSerializationByIds(options) {
|
|
1052
|
+
const { configuration, aasIds, submodelIds, includeConceptDescriptions } = options;
|
|
1053
|
+
try {
|
|
1054
|
+
const apiInstance = new SubmodelRepositoryService.SerializationAPIApi(applyDefaults(configuration));
|
|
1055
|
+
const result = await apiInstance.generateSerializationByIds({
|
|
1056
|
+
aasIds: aasIds,
|
|
1057
|
+
submodelIds: submodelIds,
|
|
1058
|
+
includeConceptDescriptions: includeConceptDescriptions,
|
|
1059
|
+
});
|
|
1060
|
+
return { success: true, data: result };
|
|
1061
|
+
}
|
|
1062
|
+
catch (err) {
|
|
1063
|
+
const customError = await handleApiError(err);
|
|
1064
|
+
return { success: false, error: customError };
|
|
1065
|
+
}
|
|
1066
|
+
}
|
|
1067
|
+
/**
|
|
1068
|
+
* Returns the self-describing information of a network resource (ServiceDescription)
|
|
1069
|
+
*/
|
|
1070
|
+
async getSelfDescription(options) {
|
|
1071
|
+
const { configuration } = options;
|
|
1072
|
+
try {
|
|
1073
|
+
const apiInstance = new SubmodelRepositoryService.DescriptionAPIApi(applyDefaults(configuration));
|
|
1074
|
+
const result = await apiInstance.getSelfDescription();
|
|
1075
|
+
return { success: true, data: result };
|
|
1076
|
+
}
|
|
1077
|
+
catch (err) {
|
|
1078
|
+
const customError = await handleApiError(err);
|
|
1079
|
+
return { success: false, error: customError };
|
|
1080
|
+
}
|
|
1081
|
+
}
|
|
581
1082
|
}
|
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
* DotAAS Part 2 | HTTP/REST | Asset Administration Shell Registry Service Specification
|
|
3
3
|
* The Full Profile of the Asset Administration Shell Registry Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). Copyright: Industrial Digital Twin Association (IDTA) 2025
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: V3.1.
|
|
5
|
+
* The version of the OpenAPI document: V3.1.1_SSP-001
|
|
6
6
|
* Contact: info@idtwin.org
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import * as runtime from '
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
13
|
import type { AssetAdministrationShellDescriptor, AssetKind, GetAssetAdministrationShellDescriptorsResult, GetSubmodelDescriptorsResult, SubmodelDescriptor } from '../models/index';
|
|
14
14
|
export interface DeleteAssetAdministrationShellDescriptorByIdRequest {
|
|
15
15
|
aasIdentifier: string;
|
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
* DotAAS Part 2 | HTTP/REST | Asset Administration Shell Registry Service Specification
|
|
5
5
|
* The Full Profile of the Asset Administration Shell Registry Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). Copyright: Industrial Digital Twin Association (IDTA) 2025
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: V3.1.
|
|
7
|
+
* The version of the OpenAPI document: V3.1.1_SSP-001
|
|
8
8
|
* Contact: info@idtwin.org
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
import * as runtime from '
|
|
14
|
+
import * as runtime from '../runtime';
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
17
17
|
*/
|
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
* DotAAS Part 2 | HTTP/REST | Asset Administration Shell Registry Service Specification
|
|
3
3
|
* The Full Profile of the Asset Administration Shell Registry Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). Copyright: Industrial Digital Twin Association (IDTA) 2025
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: V3.1.
|
|
5
|
+
* The version of the OpenAPI document: V3.1.1_SSP-001
|
|
6
6
|
* Contact: info@idtwin.org
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
-
import * as runtime from '
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
13
|
import type { ServiceDescription } from '../models/index';
|
|
14
14
|
/**
|
|
15
15
|
*
|
|
@@ -4,14 +4,14 @@
|
|
|
4
4
|
* DotAAS Part 2 | HTTP/REST | Asset Administration Shell Registry Service Specification
|
|
5
5
|
* The Full Profile of the Asset Administration Shell Registry Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). Copyright: Industrial Digital Twin Association (IDTA) 2025
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: V3.1.
|
|
7
|
+
* The version of the OpenAPI document: V3.1.1_SSP-001
|
|
8
8
|
* Contact: info@idtwin.org
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
-
import * as runtime from '
|
|
14
|
+
import * as runtime from '../runtime';
|
|
15
15
|
/**
|
|
16
16
|
*
|
|
17
17
|
*/
|