basyx-typescript-sdk 2.2.5 → 2.3.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/README.md +54 -0
- package/bundle/index.cjs +1190 -513
- package/bundle/index.cjs.map +1 -1
- package/bundle/index.mjs +1190 -513
- package/bundle/index.mjs.map +1 -1
- package/dist/clients/AasDiscoveryClient.d.ts +9 -3
- package/dist/clients/AasDiscoveryClient.js +28 -9
- package/dist/clients/AasRegistryClient.d.ts +28 -8
- package/dist/clients/AasRegistryClient.js +63 -21
- package/dist/clients/AasRepositoryClient.d.ts +170 -56
- package/dist/clients/AasRepositoryClient.js +385 -136
- package/dist/clients/AasxFileClient.d.ts +11 -3
- package/dist/clients/AasxFileClient.js +27 -11
- package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +11 -3
- package/dist/clients/ConceptDescriptionRepositoryClient.js +40 -12
- package/dist/clients/SubmodelRegistryClient.d.ts +11 -3
- package/dist/clients/SubmodelRegistryClient.js +28 -8
- package/dist/clients/SubmodelRepositoryClient.d.ts +108 -34
- package/dist/clients/SubmodelRepositoryClient.js +262 -106
- package/dist/lib/apiConfig.d.ts +2 -1
- package/dist/lib/apiConfig.js +27 -2
- package/dist/lib/conditionalRequests.d.ts +28 -0
- package/dist/lib/conditionalRequests.js +55 -0
- package/dist/lib/errorHandler.js +9 -4
- package/dist/models/api.d.ts +38 -2
- package/dist/services/AasService.d.ts +13 -3
- package/dist/services/AasService.js +45 -7
- package/dist/services/SubmodelService.d.ts +13 -3
- package/dist/services/SubmodelService.js +49 -7
- package/package.json +1 -1
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { AssetAdministrationShell, AssetInformation, ISubmodelElement, Reference, Submodel } from '@aas-core-works/aas-core3.1-typescript/types';
|
|
2
|
-
import type { ApiResult } from '../models/api';
|
|
2
|
+
import type { ApiResult, ConditionalApiResult } from '../models/api';
|
|
3
3
|
import type { AssetId } from '../models/AssetId';
|
|
4
4
|
import { AasRepositoryService } from '../generated';
|
|
5
5
|
import { Configuration } from '../generated/runtime';
|
|
@@ -69,12 +69,14 @@ export declare class AasRepositoryClient {
|
|
|
69
69
|
* @param options Object containing:
|
|
70
70
|
* - configuration: The http request options
|
|
71
71
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
72
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
72
73
|
*
|
|
73
74
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
74
75
|
*/
|
|
75
76
|
deleteAssetAdministrationShellById(options: {
|
|
76
77
|
configuration: Configuration;
|
|
77
78
|
aasIdentifier: string;
|
|
79
|
+
ifMatch?: string;
|
|
78
80
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
79
81
|
/**
|
|
80
82
|
* Returns a specific Asset Administration Shell
|
|
@@ -82,13 +84,15 @@ export declare class AasRepositoryClient {
|
|
|
82
84
|
* @param options Object containing:
|
|
83
85
|
* - configuration: The http request options
|
|
84
86
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
87
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
85
88
|
*
|
|
86
89
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
87
90
|
*/
|
|
88
|
-
getAssetAdministrationShellById(options: {
|
|
91
|
+
getAssetAdministrationShellById<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
89
92
|
configuration: Configuration;
|
|
90
93
|
aasIdentifier: string;
|
|
91
|
-
|
|
94
|
+
ifNoneMatch?: IfNoneMatch;
|
|
95
|
+
}): Promise<ConditionalApiResult<AssetAdministrationShell, AasRepositoryService.Result, IfNoneMatch>>;
|
|
92
96
|
/**
|
|
93
97
|
* Updates an existing Asset Administration Shell
|
|
94
98
|
*
|
|
@@ -96,6 +100,8 @@ export declare class AasRepositoryClient {
|
|
|
96
100
|
* - configuration: The http request options
|
|
97
101
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
98
102
|
* - assetAdministrationShell: Asset Administration Shell object
|
|
103
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
104
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
|
|
99
105
|
*
|
|
100
106
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
101
107
|
*/
|
|
@@ -103,6 +109,8 @@ export declare class AasRepositoryClient {
|
|
|
103
109
|
configuration: Configuration;
|
|
104
110
|
aasIdentifier: string;
|
|
105
111
|
assetAdministrationShell: AssetAdministrationShell;
|
|
112
|
+
ifMatch?: string;
|
|
113
|
+
ifNoneMatch?: string;
|
|
106
114
|
}): Promise<ApiResult<AssetAdministrationShell | void, AasRepositoryService.Result>>;
|
|
107
115
|
/**
|
|
108
116
|
* Returns a specific Asset Administration Shell in reference representation
|
|
@@ -110,26 +118,30 @@ export declare class AasRepositoryClient {
|
|
|
110
118
|
* @param options Object containing:
|
|
111
119
|
* - configuration: The http request options
|
|
112
120
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
121
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
113
122
|
*
|
|
114
123
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
115
124
|
*/
|
|
116
|
-
getAssetAdministrationShellByIdReferenceAasRepository(options: {
|
|
125
|
+
getAssetAdministrationShellByIdReferenceAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
117
126
|
configuration: Configuration;
|
|
118
127
|
aasIdentifier: string;
|
|
119
|
-
|
|
128
|
+
ifNoneMatch?: IfNoneMatch;
|
|
129
|
+
}): Promise<ConditionalApiResult<Reference, AasRepositoryService.Result, IfNoneMatch>>;
|
|
120
130
|
/**
|
|
121
131
|
* Returns the Asset Information
|
|
122
132
|
*
|
|
123
133
|
* @param options Object containing:
|
|
124
134
|
* - configuration: The http request options
|
|
125
135
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
136
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
126
137
|
*
|
|
127
138
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
128
139
|
*/
|
|
129
|
-
getAssetInformationAasRepository(options: {
|
|
140
|
+
getAssetInformationAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
130
141
|
configuration: Configuration;
|
|
131
142
|
aasIdentifier: string;
|
|
132
|
-
|
|
143
|
+
ifNoneMatch?: IfNoneMatch;
|
|
144
|
+
}): Promise<ConditionalApiResult<AssetInformation, AasRepositoryService.Result, IfNoneMatch>>;
|
|
133
145
|
/**
|
|
134
146
|
* Updates the Asset Information
|
|
135
147
|
*
|
|
@@ -137,6 +149,8 @@ export declare class AasRepositoryClient {
|
|
|
137
149
|
* - configuration: The http request options
|
|
138
150
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
139
151
|
* - assetInformation: Asset Information object
|
|
152
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
153
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
|
|
140
154
|
*
|
|
141
155
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
142
156
|
*/
|
|
@@ -144,6 +158,8 @@ export declare class AasRepositoryClient {
|
|
|
144
158
|
configuration: Configuration;
|
|
145
159
|
aasIdentifier: string;
|
|
146
160
|
assetInformation: AssetInformation;
|
|
161
|
+
ifMatch?: string;
|
|
162
|
+
ifNoneMatch?: string;
|
|
147
163
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
148
164
|
/**
|
|
149
165
|
* Deletes the Thumbnail associated with the given AAS
|
|
@@ -151,12 +167,14 @@ export declare class AasRepositoryClient {
|
|
|
151
167
|
* @param options Object containing:
|
|
152
168
|
* - configuration: The http request options
|
|
153
169
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
170
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
154
171
|
*
|
|
155
172
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
156
173
|
*/
|
|
157
174
|
deleteThumbnailAasRepository(options: {
|
|
158
175
|
configuration: Configuration;
|
|
159
176
|
aasIdentifier: string;
|
|
177
|
+
ifMatch?: string;
|
|
160
178
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
161
179
|
/**
|
|
162
180
|
* Returns the Thumbnail associated with an AAS, if any
|
|
@@ -164,13 +182,15 @@ export declare class AasRepositoryClient {
|
|
|
164
182
|
* @param options Object containing:
|
|
165
183
|
* - configuration: The http request options
|
|
166
184
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
185
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
167
186
|
*
|
|
168
187
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
169
188
|
*/
|
|
170
|
-
getThumbnailAasRepository(options: {
|
|
189
|
+
getThumbnailAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
171
190
|
configuration: Configuration;
|
|
172
191
|
aasIdentifier: string;
|
|
173
|
-
|
|
192
|
+
ifNoneMatch?: IfNoneMatch;
|
|
193
|
+
}): Promise<ConditionalApiResult<Blob, AasRepositoryService.Result, IfNoneMatch>>;
|
|
174
194
|
/**
|
|
175
195
|
* Updates (or creates) the Thumbnail for the given AAS
|
|
176
196
|
*
|
|
@@ -179,6 +199,8 @@ export declare class AasRepositoryClient {
|
|
|
179
199
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
180
200
|
* - fileName: The name of the file
|
|
181
201
|
* - file: The file to upload
|
|
202
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
203
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
|
|
182
204
|
*
|
|
183
205
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
184
206
|
*/
|
|
@@ -187,6 +209,8 @@ export declare class AasRepositoryClient {
|
|
|
187
209
|
aasIdentifier: string;
|
|
188
210
|
fileName: string;
|
|
189
211
|
file: Blob;
|
|
212
|
+
ifMatch?: string;
|
|
213
|
+
ifNoneMatch?: string;
|
|
190
214
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
191
215
|
/**
|
|
192
216
|
* Returns all submodel references
|
|
@@ -196,18 +220,20 @@ export declare class AasRepositoryClient {
|
|
|
196
220
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
197
221
|
* - limit?: The maximum number of elements in the response array
|
|
198
222
|
* - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
|
|
223
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
199
224
|
*
|
|
200
225
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
201
226
|
*/
|
|
202
|
-
getAllSubmodelReferencesAasRepository(options: {
|
|
227
|
+
getAllSubmodelReferencesAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
203
228
|
configuration: Configuration;
|
|
204
229
|
aasIdentifier: string;
|
|
205
230
|
limit?: number;
|
|
206
231
|
cursor?: string;
|
|
207
|
-
|
|
232
|
+
ifNoneMatch?: IfNoneMatch;
|
|
233
|
+
}): Promise<ConditionalApiResult<{
|
|
208
234
|
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
209
235
|
result: Reference[];
|
|
210
|
-
}, AasRepositoryService.Result>>;
|
|
236
|
+
}, AasRepositoryService.Result, IfNoneMatch>>;
|
|
211
237
|
/**
|
|
212
238
|
* Creates a submodel reference at the Asset Administration Shell
|
|
213
239
|
*
|
|
@@ -215,6 +241,7 @@ export declare class AasRepositoryClient {
|
|
|
215
241
|
* - configuration: The http request options
|
|
216
242
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
217
243
|
* - submodelReference: Reference to the Submodel
|
|
244
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
218
245
|
*
|
|
219
246
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
220
247
|
*/
|
|
@@ -222,6 +249,7 @@ export declare class AasRepositoryClient {
|
|
|
222
249
|
configuration: Configuration;
|
|
223
250
|
aasIdentifier: string;
|
|
224
251
|
submodelReference: Reference;
|
|
252
|
+
ifMatch?: string;
|
|
225
253
|
}): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
|
|
226
254
|
/**
|
|
227
255
|
* Deletes a submodel reference from the given AAS (does not delete the submodel itself).
|
|
@@ -230,6 +258,7 @@ export declare class AasRepositoryClient {
|
|
|
230
258
|
* - configuration: The http request options
|
|
231
259
|
* - aasIdentifier: Unique ID of the AAS
|
|
232
260
|
* - submodelIdentifier: The submodel's unique ID
|
|
261
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
233
262
|
*
|
|
234
263
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
235
264
|
*/
|
|
@@ -237,48 +266,59 @@ export declare class AasRepositoryClient {
|
|
|
237
266
|
configuration: Configuration;
|
|
238
267
|
aasIdentifier: string;
|
|
239
268
|
submodelIdentifier: string;
|
|
269
|
+
ifMatch?: string;
|
|
240
270
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
241
|
-
getAssetInformation(options: {
|
|
271
|
+
getAssetInformation<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
242
272
|
configuration: Configuration;
|
|
243
273
|
aasIdentifier: string;
|
|
244
|
-
|
|
274
|
+
ifNoneMatch?: IfNoneMatch;
|
|
275
|
+
}): Promise<ConditionalApiResult<AssetInformation, AasRepositoryService.Result, IfNoneMatch>>;
|
|
245
276
|
putAssetInformation(options: {
|
|
246
277
|
configuration: Configuration;
|
|
247
278
|
aasIdentifier: string;
|
|
248
279
|
assetInformation: AssetInformation;
|
|
280
|
+
ifMatch?: string;
|
|
281
|
+
ifNoneMatch?: string;
|
|
249
282
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
250
283
|
deleteThumbnail(options: {
|
|
251
284
|
configuration: Configuration;
|
|
252
285
|
aasIdentifier: string;
|
|
286
|
+
ifMatch?: string;
|
|
253
287
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
254
|
-
getThumbnail(options: {
|
|
288
|
+
getThumbnail<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
255
289
|
configuration: Configuration;
|
|
256
290
|
aasIdentifier: string;
|
|
257
|
-
|
|
291
|
+
ifNoneMatch?: IfNoneMatch;
|
|
292
|
+
}): Promise<ConditionalApiResult<Blob, AasRepositoryService.Result, IfNoneMatch>>;
|
|
258
293
|
putThumbnail(options: {
|
|
259
294
|
configuration: Configuration;
|
|
260
295
|
aasIdentifier: string;
|
|
261
296
|
fileName: string;
|
|
262
297
|
file: Blob;
|
|
298
|
+
ifMatch?: string;
|
|
299
|
+
ifNoneMatch?: string;
|
|
263
300
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
264
|
-
getAllSubmodelReferences(options: {
|
|
301
|
+
getAllSubmodelReferences<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
265
302
|
configuration: Configuration;
|
|
266
303
|
aasIdentifier: string;
|
|
267
304
|
limit?: number;
|
|
268
305
|
cursor?: string;
|
|
269
|
-
|
|
306
|
+
ifNoneMatch?: IfNoneMatch;
|
|
307
|
+
}): Promise<ConditionalApiResult<{
|
|
270
308
|
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
271
309
|
result: Reference[];
|
|
272
|
-
}, AasRepositoryService.Result>>;
|
|
310
|
+
}, AasRepositoryService.Result, IfNoneMatch>>;
|
|
273
311
|
postSubmodelReference(options: {
|
|
274
312
|
configuration: Configuration;
|
|
275
313
|
aasIdentifier: string;
|
|
276
314
|
submodelReference: Reference;
|
|
315
|
+
ifMatch?: string;
|
|
277
316
|
}): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
|
|
278
317
|
deleteSubmodelReferenceById(options: {
|
|
279
318
|
configuration: Configuration;
|
|
280
319
|
aasIdentifier: string;
|
|
281
320
|
submodelIdentifier: string;
|
|
321
|
+
ifMatch?: string;
|
|
282
322
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
283
323
|
/**
|
|
284
324
|
* Returns the Submodel
|
|
@@ -289,16 +329,18 @@ export declare class AasRepositoryClient {
|
|
|
289
329
|
* - submodelIdentifier: The submodel's unique ID
|
|
290
330
|
* - level?: Determines the structural depth of the respective resource content
|
|
291
331
|
* - extent?: Determines to which extent the resource is being serialized
|
|
332
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
292
333
|
*
|
|
293
334
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
294
335
|
*/
|
|
295
|
-
getSubmodelByIdAasRepository(options: {
|
|
336
|
+
getSubmodelByIdAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
296
337
|
configuration: Configuration;
|
|
297
338
|
aasIdentifier: string;
|
|
298
339
|
submodelIdentifier: string;
|
|
299
340
|
level?: AasRepositoryService.GetSubmodelByIdAasRepositoryLevelEnum;
|
|
300
341
|
extent?: AasRepositoryService.GetSubmodelByIdAasRepositoryExtentEnum;
|
|
301
|
-
|
|
342
|
+
ifNoneMatch?: IfNoneMatch;
|
|
343
|
+
}): Promise<ConditionalApiResult<Submodel, AasRepositoryService.Result, IfNoneMatch>>;
|
|
302
344
|
/**
|
|
303
345
|
* Creates or updates the Submodel
|
|
304
346
|
*
|
|
@@ -307,6 +349,8 @@ export declare class AasRepositoryClient {
|
|
|
307
349
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
308
350
|
* - submodelIdentifier: The Submodel’s unique id
|
|
309
351
|
* - submodel: Submodel object
|
|
352
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
353
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
|
|
310
354
|
*
|
|
311
355
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
312
356
|
*/
|
|
@@ -315,6 +359,8 @@ export declare class AasRepositoryClient {
|
|
|
315
359
|
aasIdentifier: string;
|
|
316
360
|
submodelIdentifier: string;
|
|
317
361
|
submodel: Submodel;
|
|
362
|
+
ifMatch?: string;
|
|
363
|
+
ifNoneMatch?: string;
|
|
318
364
|
}): Promise<ApiResult<Submodel | void, AasRepositoryService.Result>>;
|
|
319
365
|
/**
|
|
320
366
|
* Deletes the submodel from the Asset Administration Shell and the Repository.
|
|
@@ -323,6 +369,7 @@ export declare class AasRepositoryClient {
|
|
|
323
369
|
* - configuration: The http request options
|
|
324
370
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
325
371
|
* - submodelIdentifier: The Submodel’s unique id
|
|
372
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
326
373
|
*
|
|
327
374
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
328
375
|
*/
|
|
@@ -330,6 +377,7 @@ export declare class AasRepositoryClient {
|
|
|
330
377
|
configuration: Configuration;
|
|
331
378
|
aasIdentifier: string;
|
|
332
379
|
submodelIdentifier: string;
|
|
380
|
+
ifMatch?: string;
|
|
333
381
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
334
382
|
/**
|
|
335
383
|
* Updates the Submodel
|
|
@@ -340,6 +388,7 @@ export declare class AasRepositoryClient {
|
|
|
340
388
|
* - submodelIdentifier: The Submodel’s unique id
|
|
341
389
|
* - submodel: Submodel object
|
|
342
390
|
* - level?: Determines the structural depth of the respective resource content
|
|
391
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
343
392
|
*
|
|
344
393
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
345
394
|
*/
|
|
@@ -349,6 +398,7 @@ export declare class AasRepositoryClient {
|
|
|
349
398
|
submodelIdentifier: string;
|
|
350
399
|
submodel: Submodel;
|
|
351
400
|
level?: AasRepositoryService.PatchSubmodelAasRepositoryLevelEnum;
|
|
401
|
+
ifMatch?: string;
|
|
352
402
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
353
403
|
/**
|
|
354
404
|
* Returns the Submodel's metadata elements
|
|
@@ -357,14 +407,16 @@ export declare class AasRepositoryClient {
|
|
|
357
407
|
* - configuration: The http request options
|
|
358
408
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
359
409
|
* - submodelIdentifier: The Submodel’s unique id
|
|
410
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
360
411
|
*
|
|
361
412
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
362
413
|
*/
|
|
363
|
-
getSubmodelByIdMetadataAasRepository(options: {
|
|
414
|
+
getSubmodelByIdMetadataAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
364
415
|
configuration: Configuration;
|
|
365
416
|
aasIdentifier: string;
|
|
366
417
|
submodelIdentifier: string;
|
|
367
|
-
|
|
418
|
+
ifNoneMatch?: IfNoneMatch;
|
|
419
|
+
}): Promise<ConditionalApiResult<AasRepositoryService.SubmodelMetadata, AasRepositoryService.Result, IfNoneMatch>>;
|
|
368
420
|
/**
|
|
369
421
|
* Updates the metadata attributes of the Submodel
|
|
370
422
|
*
|
|
@@ -373,6 +425,7 @@ export declare class AasRepositoryClient {
|
|
|
373
425
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
374
426
|
* - submodelIdentifier: The Submodel’s unique id
|
|
375
427
|
* - submodelMetadata: The Submodel Metadata object
|
|
428
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
376
429
|
*
|
|
377
430
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
378
431
|
*/
|
|
@@ -381,6 +434,7 @@ export declare class AasRepositoryClient {
|
|
|
381
434
|
aasIdentifier: string;
|
|
382
435
|
submodelIdentifier: string;
|
|
383
436
|
submodelMetadata: AasRepositoryService.SubmodelMetadata;
|
|
437
|
+
ifMatch?: string;
|
|
384
438
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
385
439
|
/**
|
|
386
440
|
* Returns the Submodel's ValueOnly representation
|
|
@@ -391,16 +445,18 @@ export declare class AasRepositoryClient {
|
|
|
391
445
|
* - submodelIdentifier: The Submodel’s unique id
|
|
392
446
|
* - level?: Determines the structural depth of the respective resource content
|
|
393
447
|
* - extent?: Determines to which extent the resource is being serialized
|
|
448
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
394
449
|
*
|
|
395
450
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
396
451
|
*/
|
|
397
|
-
getSubmodelByIdValueOnlyAasRepository(options: {
|
|
452
|
+
getSubmodelByIdValueOnlyAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
398
453
|
configuration: Configuration;
|
|
399
454
|
aasIdentifier: string;
|
|
400
455
|
submodelIdentifier: string;
|
|
401
456
|
level?: AasRepositoryService.GetSubmodelByIdValueOnlyAasRepositoryLevelEnum;
|
|
402
457
|
extent?: AasRepositoryService.GetSubmodelByIdValueOnlyAasRepositoryExtentEnum;
|
|
403
|
-
|
|
458
|
+
ifNoneMatch?: IfNoneMatch;
|
|
459
|
+
}): Promise<ConditionalApiResult<object, AasRepositoryService.Result, IfNoneMatch>>;
|
|
404
460
|
/**
|
|
405
461
|
* Updates the values of the Submodel
|
|
406
462
|
*
|
|
@@ -409,6 +465,7 @@ export declare class AasRepositoryClient {
|
|
|
409
465
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
410
466
|
* - submodelIdentifier: The Submodel’s unique id
|
|
411
467
|
* - level?: Determines the structural depth of the respective resource content
|
|
468
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
412
469
|
*
|
|
413
470
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
414
471
|
*/
|
|
@@ -418,6 +475,7 @@ export declare class AasRepositoryClient {
|
|
|
418
475
|
submodelIdentifier: string;
|
|
419
476
|
body: object;
|
|
420
477
|
level?: AasRepositoryService.PatchSubmodelByIdValueOnlyAasRepositoryLevelEnum;
|
|
478
|
+
ifMatch?: string;
|
|
421
479
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
422
480
|
/**
|
|
423
481
|
* Returns the Submodel as a Reference
|
|
@@ -426,14 +484,16 @@ export declare class AasRepositoryClient {
|
|
|
426
484
|
* - configuration: The http request options
|
|
427
485
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
428
486
|
* - submodelIdentifier: The submodel's unique ID
|
|
487
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
429
488
|
*
|
|
430
489
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
431
490
|
*/
|
|
432
|
-
getSubmodelByIdReferenceAasRepository(options: {
|
|
491
|
+
getSubmodelByIdReferenceAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
433
492
|
configuration: Configuration;
|
|
434
493
|
aasIdentifier: string;
|
|
435
494
|
submodelIdentifier: string;
|
|
436
|
-
|
|
495
|
+
ifNoneMatch?: IfNoneMatch;
|
|
496
|
+
}): Promise<ConditionalApiResult<Reference, AasRepositoryService.Result, IfNoneMatch>>;
|
|
437
497
|
/**
|
|
438
498
|
* Returns the elements of this submodel in path notation.
|
|
439
499
|
*
|
|
@@ -442,15 +502,17 @@ export declare class AasRepositoryClient {
|
|
|
442
502
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
443
503
|
* - submodelIdentifier: The submodel's unique ID
|
|
444
504
|
* - level?: Determines the structural depth of the respective resource content
|
|
505
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
445
506
|
*
|
|
446
507
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
447
508
|
*/
|
|
448
|
-
getSubmodelByIdPathAasRepository(options: {
|
|
509
|
+
getSubmodelByIdPathAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
449
510
|
configuration: Configuration;
|
|
450
511
|
aasIdentifier: string;
|
|
451
512
|
submodelIdentifier: string;
|
|
452
513
|
level?: AasRepositoryService.GetSubmodelByIdPathAasRepositoryLevelEnum;
|
|
453
|
-
|
|
514
|
+
ifNoneMatch?: IfNoneMatch;
|
|
515
|
+
}): Promise<ConditionalApiResult<Array<string>, AasRepositoryService.Result, IfNoneMatch>>;
|
|
454
516
|
/**
|
|
455
517
|
* Returns all submodel elements including their hierarchy
|
|
456
518
|
*
|
|
@@ -462,10 +524,11 @@ export declare class AasRepositoryClient {
|
|
|
462
524
|
* - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
|
|
463
525
|
* - level?: Determines the structural depth of the respective resource content
|
|
464
526
|
* - extent?: Determines to which extent the resource is being serialized
|
|
527
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
465
528
|
*
|
|
466
529
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
467
530
|
*/
|
|
468
|
-
getAllSubmodelElementsAasRepository(options: {
|
|
531
|
+
getAllSubmodelElementsAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
469
532
|
configuration: Configuration;
|
|
470
533
|
aasIdentifier: string;
|
|
471
534
|
submodelIdentifier: string;
|
|
@@ -473,10 +536,11 @@ export declare class AasRepositoryClient {
|
|
|
473
536
|
cursor?: string;
|
|
474
537
|
level?: AasRepositoryService.GetAllSubmodelElementsAasRepositoryLevelEnum;
|
|
475
538
|
extent?: AasRepositoryService.GetAllSubmodelElementsAasRepositoryExtentEnum;
|
|
476
|
-
|
|
539
|
+
ifNoneMatch?: IfNoneMatch;
|
|
540
|
+
}): Promise<ConditionalApiResult<{
|
|
477
541
|
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
478
542
|
result: ISubmodelElement[];
|
|
479
|
-
}, AasRepositoryService.Result>>;
|
|
543
|
+
}, AasRepositoryService.Result, IfNoneMatch>>;
|
|
480
544
|
/**
|
|
481
545
|
* Creates a new submodel element
|
|
482
546
|
*
|
|
@@ -485,6 +549,7 @@ export declare class AasRepositoryClient {
|
|
|
485
549
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
486
550
|
* - submodelIdentifier: The Submodel’s unique id
|
|
487
551
|
* - submodelElement: The Submodel Element object
|
|
552
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
488
553
|
*
|
|
489
554
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
490
555
|
*/
|
|
@@ -493,6 +558,7 @@ export declare class AasRepositoryClient {
|
|
|
493
558
|
aasIdentifier: string;
|
|
494
559
|
submodelIdentifier: string;
|
|
495
560
|
submodelElement: ISubmodelElement;
|
|
561
|
+
ifMatch?: string;
|
|
496
562
|
}): Promise<ApiResult<ISubmodelElement, AasRepositoryService.Result>>;
|
|
497
563
|
/**
|
|
498
564
|
* Returns all submodel elements including their hierarchy
|
|
@@ -503,19 +569,21 @@ export declare class AasRepositoryClient {
|
|
|
503
569
|
* - submodelIdentifier: The Submodel’s unique id
|
|
504
570
|
* - limit?: The maximum number of elements in the response array
|
|
505
571
|
* - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
|
|
572
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
506
573
|
*
|
|
507
574
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
508
575
|
*/
|
|
509
|
-
getAllSubmodelElementsMetadataAasRepository(options: {
|
|
576
|
+
getAllSubmodelElementsMetadataAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
510
577
|
configuration: Configuration;
|
|
511
578
|
aasIdentifier: string;
|
|
512
579
|
submodelIdentifier: string;
|
|
513
580
|
limit?: number;
|
|
514
581
|
cursor?: string;
|
|
515
|
-
|
|
582
|
+
ifNoneMatch?: IfNoneMatch;
|
|
583
|
+
}): Promise<ConditionalApiResult<{
|
|
516
584
|
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
517
585
|
result: AasRepositoryService.SubmodelElementMetadata[];
|
|
518
|
-
}, AasRepositoryService.Result>>;
|
|
586
|
+
}, AasRepositoryService.Result, IfNoneMatch>>;
|
|
519
587
|
/**
|
|
520
588
|
* Returns all submodel elements including their hierarchy in the ValueOnly representation
|
|
521
589
|
*
|
|
@@ -526,20 +594,22 @@ export declare class AasRepositoryClient {
|
|
|
526
594
|
* - limit?: The maximum number of elements in the response array
|
|
527
595
|
* - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
|
|
528
596
|
* - level?: Determines the structural depth of the respective resource content
|
|
597
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
529
598
|
*
|
|
530
599
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
531
600
|
*/
|
|
532
|
-
getAllSubmodelElementsValueOnlyAasRepository(options: {
|
|
601
|
+
getAllSubmodelElementsValueOnlyAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
533
602
|
configuration: Configuration;
|
|
534
603
|
aasIdentifier: string;
|
|
535
604
|
submodelIdentifier: string;
|
|
536
605
|
limit?: number;
|
|
537
606
|
cursor?: string;
|
|
538
607
|
level?: AasRepositoryService.GetAllSubmodelElementsValueOnlyAasRepositoryLevelEnum;
|
|
539
|
-
|
|
608
|
+
ifNoneMatch?: IfNoneMatch;
|
|
609
|
+
}): Promise<ConditionalApiResult<{
|
|
540
610
|
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
541
611
|
result: object;
|
|
542
|
-
}, AasRepositoryService.Result>>;
|
|
612
|
+
}, AasRepositoryService.Result, IfNoneMatch>>;
|
|
543
613
|
/**
|
|
544
614
|
* Returns all submodel elements as a list of References
|
|
545
615
|
*
|
|
@@ -550,20 +620,22 @@ export declare class AasRepositoryClient {
|
|
|
550
620
|
* - limit?: The maximum number of elements in the response array
|
|
551
621
|
* - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
|
|
552
622
|
* - level?: Determines the structural depth of the respective resource content
|
|
623
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
553
624
|
*
|
|
554
625
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
555
626
|
*/
|
|
556
|
-
getAllSubmodelElementsReferenceAasRepository(options: {
|
|
627
|
+
getAllSubmodelElementsReferenceAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
557
628
|
configuration: Configuration;
|
|
558
629
|
aasIdentifier: string;
|
|
559
630
|
submodelIdentifier: string;
|
|
560
631
|
limit?: number;
|
|
561
632
|
cursor?: string;
|
|
562
633
|
level?: AasRepositoryService.GetAllSubmodelElementsReferenceAasRepositoryLevelEnum;
|
|
563
|
-
|
|
634
|
+
ifNoneMatch?: IfNoneMatch;
|
|
635
|
+
}): Promise<ConditionalApiResult<{
|
|
564
636
|
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
565
637
|
result: Reference[];
|
|
566
|
-
}, AasRepositoryService.Result>>;
|
|
638
|
+
}, AasRepositoryService.Result, IfNoneMatch>>;
|
|
567
639
|
/**
|
|
568
640
|
* Returns all submodel elements including their hierarchy
|
|
569
641
|
*
|
|
@@ -575,10 +647,11 @@ export declare class AasRepositoryClient {
|
|
|
575
647
|
* - cursor?: A server-generated identifier retrieved from paging_metadata that specifies from which position the result listing should continue
|
|
576
648
|
* - level?: Determines the structural depth of the respective resource content
|
|
577
649
|
* - extent?: Determines to which extent the resource is being serialized
|
|
650
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
578
651
|
*
|
|
579
652
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
580
653
|
*/
|
|
581
|
-
getAllSubmodelElementsPathAasRepository(options: {
|
|
654
|
+
getAllSubmodelElementsPathAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
582
655
|
configuration: Configuration;
|
|
583
656
|
aasIdentifier: string;
|
|
584
657
|
submodelIdentifier: string;
|
|
@@ -586,10 +659,11 @@ export declare class AasRepositoryClient {
|
|
|
586
659
|
cursor?: string;
|
|
587
660
|
level?: AasRepositoryService.GetAllSubmodelElementsPathAasRepositoryLevelEnum;
|
|
588
661
|
extent?: AasRepositoryService.GetAllSubmodelElementsPathAasRepositoryExtentEnum;
|
|
589
|
-
|
|
662
|
+
ifNoneMatch?: IfNoneMatch;
|
|
663
|
+
}): Promise<ConditionalApiResult<{
|
|
590
664
|
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
591
665
|
result: string[];
|
|
592
|
-
}, AasRepositoryService.Result>>;
|
|
666
|
+
}, AasRepositoryService.Result, IfNoneMatch>>;
|
|
593
667
|
/**
|
|
594
668
|
* Returns a specific submodel element from the Submodel at a specified path
|
|
595
669
|
*
|
|
@@ -600,17 +674,19 @@ export declare class AasRepositoryClient {
|
|
|
600
674
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
601
675
|
* - level?: Determines the structural depth of the respective resource content
|
|
602
676
|
* - extent?: Determines to which extent the resource is being serialized
|
|
677
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
603
678
|
*
|
|
604
679
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
605
680
|
*/
|
|
606
|
-
getSubmodelElementByPathAasRepository(options: {
|
|
681
|
+
getSubmodelElementByPathAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
607
682
|
configuration: Configuration;
|
|
608
683
|
aasIdentifier: string;
|
|
609
684
|
submodelIdentifier: string;
|
|
610
685
|
idShortPath: string;
|
|
611
686
|
level?: AasRepositoryService.GetSubmodelElementByPathAasRepositoryLevelEnum;
|
|
612
687
|
extent?: AasRepositoryService.GetSubmodelElementByPathAasRepositoryExtentEnum;
|
|
613
|
-
|
|
688
|
+
ifNoneMatch?: IfNoneMatch;
|
|
689
|
+
}): Promise<ConditionalApiResult<ISubmodelElement, AasRepositoryService.Result, IfNoneMatch>>;
|
|
614
690
|
/**
|
|
615
691
|
* Creates a new submodel element at a specified path within submodel elements hierarchy
|
|
616
692
|
*
|
|
@@ -620,6 +696,7 @@ export declare class AasRepositoryClient {
|
|
|
620
696
|
* - submodelIdentifier: The Submodel’s unique id
|
|
621
697
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
622
698
|
* - submodelElement: SubmodelElement object
|
|
699
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
623
700
|
*
|
|
624
701
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
625
702
|
*/
|
|
@@ -629,6 +706,7 @@ export declare class AasRepositoryClient {
|
|
|
629
706
|
submodelIdentifier: string;
|
|
630
707
|
idShortPath: string;
|
|
631
708
|
submodelElement: ISubmodelElement;
|
|
709
|
+
ifMatch?: string;
|
|
632
710
|
}): Promise<ApiResult<ISubmodelElement, AasRepositoryService.Result>>;
|
|
633
711
|
/**
|
|
634
712
|
* Deletes a submodel element at a specified path within the submodel elements hierarchy
|
|
@@ -638,6 +716,7 @@ export declare class AasRepositoryClient {
|
|
|
638
716
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
639
717
|
* - submodelIdentifier: The Submodel’s unique id
|
|
640
718
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
719
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
641
720
|
*
|
|
642
721
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
643
722
|
*/
|
|
@@ -646,6 +725,7 @@ export declare class AasRepositoryClient {
|
|
|
646
725
|
aasIdentifier: string;
|
|
647
726
|
submodelIdentifier: string;
|
|
648
727
|
idShortPath: string;
|
|
728
|
+
ifMatch?: string;
|
|
649
729
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
650
730
|
/**
|
|
651
731
|
* Updates an existing submodel element at a specified path within submodel elements hierarchy
|
|
@@ -656,6 +736,8 @@ export declare class AasRepositoryClient {
|
|
|
656
736
|
* - submodelIdentifier: The Submodel’s unique id
|
|
657
737
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
658
738
|
* - submodelElement: SubmodelElement object
|
|
739
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
740
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
|
|
659
741
|
*
|
|
660
742
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
661
743
|
*/
|
|
@@ -665,6 +747,8 @@ export declare class AasRepositoryClient {
|
|
|
665
747
|
submodelIdentifier: string;
|
|
666
748
|
idShortPath: string;
|
|
667
749
|
submodelElement: ISubmodelElement;
|
|
750
|
+
ifMatch?: string;
|
|
751
|
+
ifNoneMatch?: string;
|
|
668
752
|
}): Promise<ApiResult<ISubmodelElement | void, AasRepositoryService.Result>>;
|
|
669
753
|
/**
|
|
670
754
|
* Updates an existing submodel element value at a specified path within submodel elements hierarchy
|
|
@@ -676,6 +760,7 @@ export declare class AasRepositoryClient {
|
|
|
676
760
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
677
761
|
* - submodelElement: SubmodelElement object
|
|
678
762
|
* - level?: Determines the structural depth of the respective resource content
|
|
763
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
679
764
|
*
|
|
680
765
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
681
766
|
*/
|
|
@@ -686,6 +771,7 @@ export declare class AasRepositoryClient {
|
|
|
686
771
|
idShortPath: string;
|
|
687
772
|
submodelElement: ISubmodelElement;
|
|
688
773
|
level?: AasRepositoryService.PatchSubmodelElementValueByPathAasRepositoryLevelEnum;
|
|
774
|
+
ifMatch?: string;
|
|
689
775
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
690
776
|
/**
|
|
691
777
|
* Returns the metadata attributes of a specific submodel element from the Submodel at a specified path
|
|
@@ -695,15 +781,17 @@ export declare class AasRepositoryClient {
|
|
|
695
781
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
696
782
|
* - submodelIdentifier: The Submodel’s unique id
|
|
697
783
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
784
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
698
785
|
*
|
|
699
786
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
700
787
|
*/
|
|
701
|
-
getSubmodelElementByPathMetadataAasRepository(options: {
|
|
788
|
+
getSubmodelElementByPathMetadataAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
702
789
|
configuration: Configuration;
|
|
703
790
|
aasIdentifier: string;
|
|
704
791
|
submodelIdentifier: string;
|
|
705
792
|
idShortPath: string;
|
|
706
|
-
|
|
793
|
+
ifNoneMatch?: IfNoneMatch;
|
|
794
|
+
}): Promise<ConditionalApiResult<AasRepositoryService.SubmodelElementMetadata, AasRepositoryService.Result, IfNoneMatch>>;
|
|
707
795
|
/**
|
|
708
796
|
* Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy
|
|
709
797
|
*
|
|
@@ -713,6 +801,7 @@ export declare class AasRepositoryClient {
|
|
|
713
801
|
* - submodelIdentifier: The Submodel’s unique id
|
|
714
802
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
715
803
|
* - submodelElementMetadata: The Submodel Element Metadata object
|
|
804
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
716
805
|
*
|
|
717
806
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
718
807
|
*/
|
|
@@ -722,6 +811,7 @@ export declare class AasRepositoryClient {
|
|
|
722
811
|
submodelIdentifier: string;
|
|
723
812
|
idShortPath: string;
|
|
724
813
|
submodelElementMetadata: AasRepositoryService.SubmodelElementMetadata;
|
|
814
|
+
ifMatch?: string;
|
|
725
815
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
726
816
|
/**
|
|
727
817
|
* Returns a specific submodel element from the Submodel at a specified path in the ValueOnly representation
|
|
@@ -733,17 +823,19 @@ export declare class AasRepositoryClient {
|
|
|
733
823
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
734
824
|
* - level?: Determines the structural depth of the respective resource content
|
|
735
825
|
* - extent?: Determines to which extent the resource is being serialized
|
|
826
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
736
827
|
*
|
|
737
828
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
738
829
|
*/
|
|
739
|
-
getSubmodelElementByPathValueOnlyAasRepository(options: {
|
|
830
|
+
getSubmodelElementByPathValueOnlyAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
740
831
|
configuration: Configuration;
|
|
741
832
|
aasIdentifier: string;
|
|
742
833
|
submodelIdentifier: string;
|
|
743
834
|
idShortPath: string;
|
|
744
835
|
level?: AasRepositoryService.GetSubmodelElementByPathValueOnlyAasRepositoryLevelEnum;
|
|
745
836
|
extent?: AasRepositoryService.GetSubmodelElementByPathValueOnlyAasRepositoryExtentEnum;
|
|
746
|
-
|
|
837
|
+
ifNoneMatch?: IfNoneMatch;
|
|
838
|
+
}): Promise<ConditionalApiResult<AasRepositoryService.SubmodelElementValue, AasRepositoryService.Result, IfNoneMatch>>;
|
|
747
839
|
/**
|
|
748
840
|
* Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy
|
|
749
841
|
*
|
|
@@ -754,6 +846,7 @@ export declare class AasRepositoryClient {
|
|
|
754
846
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
755
847
|
* - SubmodelElementValue: SubmodelElementValue object
|
|
756
848
|
* - level?: Determines the structural depth of the respective resource content
|
|
849
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
757
850
|
*
|
|
758
851
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
759
852
|
*/
|
|
@@ -764,6 +857,7 @@ export declare class AasRepositoryClient {
|
|
|
764
857
|
idShortPath: string;
|
|
765
858
|
submodelElementValue: AasRepositoryService.SubmodelElementValue;
|
|
766
859
|
level?: AasRepositoryService.PatchSubmodelElementValueByPathValueOnlyLevelEnum;
|
|
860
|
+
ifMatch?: string;
|
|
767
861
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
768
862
|
/**
|
|
769
863
|
* Returns the Reference of a specific submodel element from the Submodel at a specified path
|
|
@@ -774,16 +868,18 @@ export declare class AasRepositoryClient {
|
|
|
774
868
|
* - submodelIdentifier: The Submodel’s unique id
|
|
775
869
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
776
870
|
* - level?: Determines the structural depth of the respective resource content
|
|
871
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
777
872
|
*
|
|
778
873
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
779
874
|
*/
|
|
780
|
-
getSubmodelElementByPathReferenceAasRepository(options: {
|
|
875
|
+
getSubmodelElementByPathReferenceAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
781
876
|
configuration: Configuration;
|
|
782
877
|
aasIdentifier: string;
|
|
783
878
|
submodelIdentifier: string;
|
|
784
879
|
idShortPath: string;
|
|
785
880
|
level?: AasRepositoryService.GetSubmodelElementByPathReferenceAasRepositoryLevelEnum;
|
|
786
|
-
|
|
881
|
+
ifNoneMatch?: IfNoneMatch;
|
|
882
|
+
}): Promise<ConditionalApiResult<Reference, AasRepositoryService.Result, IfNoneMatch>>;
|
|
787
883
|
/**
|
|
788
884
|
* Returns a specific submodel element from the Submodel at a specified path in the Path notation
|
|
789
885
|
*
|
|
@@ -793,16 +889,18 @@ export declare class AasRepositoryClient {
|
|
|
793
889
|
* - submodelIdentifier: The Submodel’s unique id
|
|
794
890
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
795
891
|
* - level?: Determines the structural depth of the respective resource content
|
|
892
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
796
893
|
*
|
|
797
894
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
798
895
|
*/
|
|
799
|
-
getSubmodelElementByPathPathAasRepository(options: {
|
|
896
|
+
getSubmodelElementByPathPathAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
800
897
|
configuration: Configuration;
|
|
801
898
|
aasIdentifier: string;
|
|
802
899
|
submodelIdentifier: string;
|
|
803
900
|
idShortPath: string;
|
|
804
901
|
level?: AasRepositoryService.GetSubmodelElementByPathPathAasRepositoryLevelEnum;
|
|
805
|
-
|
|
902
|
+
ifNoneMatch?: IfNoneMatch;
|
|
903
|
+
}): Promise<ConditionalApiResult<Array<string>, AasRepositoryService.Result, IfNoneMatch>>;
|
|
806
904
|
/**
|
|
807
905
|
* Downloads file content from a specific submodel element from the Submodel at a specified path
|
|
808
906
|
*
|
|
@@ -811,15 +909,17 @@ export declare class AasRepositoryClient {
|
|
|
811
909
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
812
910
|
* - submodelIdentifier: The Submodel’s unique id
|
|
813
911
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
912
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; returns `{ success: true; notModified: true }` without data if the representation still has this `etag`
|
|
814
913
|
*
|
|
815
914
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
816
915
|
*/
|
|
817
|
-
getFileByPathAasRepository(options: {
|
|
916
|
+
getFileByPathAasRepository<IfNoneMatch extends string | undefined = undefined>(options: {
|
|
818
917
|
configuration: Configuration;
|
|
819
918
|
aasIdentifier: string;
|
|
820
919
|
submodelIdentifier: string;
|
|
821
920
|
idShortPath: string;
|
|
822
|
-
|
|
921
|
+
ifNoneMatch?: IfNoneMatch;
|
|
922
|
+
}): Promise<ConditionalApiResult<Blob, AasRepositoryService.Result, IfNoneMatch>>;
|
|
823
923
|
/**
|
|
824
924
|
* Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy
|
|
825
925
|
*
|
|
@@ -830,6 +930,8 @@ export declare class AasRepositoryClient {
|
|
|
830
930
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
831
931
|
* - fileName: The name of the file
|
|
832
932
|
* - file: The file to upload
|
|
933
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
934
|
+
* - ifNoneMatch?: Sent as `If-None-Match` header; use `*` to only create the resource (fails with `preconditionFailed` if it exists)
|
|
833
935
|
*
|
|
834
936
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
835
937
|
*/
|
|
@@ -840,6 +942,8 @@ export declare class AasRepositoryClient {
|
|
|
840
942
|
idShortPath: string;
|
|
841
943
|
fileName: string;
|
|
842
944
|
file: Blob;
|
|
945
|
+
ifMatch?: string;
|
|
946
|
+
ifNoneMatch?: string;
|
|
843
947
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
844
948
|
/**
|
|
845
949
|
* Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy
|
|
@@ -849,6 +953,7 @@ export declare class AasRepositoryClient {
|
|
|
849
953
|
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
850
954
|
* - submodelIdentifier: The Submodel’s unique id
|
|
851
955
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
956
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
852
957
|
*
|
|
853
958
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
854
959
|
*/
|
|
@@ -857,6 +962,7 @@ export declare class AasRepositoryClient {
|
|
|
857
962
|
aasIdentifier: string;
|
|
858
963
|
submodelIdentifier: string;
|
|
859
964
|
idShortPath: string;
|
|
965
|
+
ifMatch?: string;
|
|
860
966
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
861
967
|
/**
|
|
862
968
|
* Synchronously invokes an Operation at a specified path
|
|
@@ -867,6 +973,7 @@ export declare class AasRepositoryClient {
|
|
|
867
973
|
* - submodelIdentifier: The Submodel’s unique id
|
|
868
974
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
869
975
|
* - operationRequest: Operation request object
|
|
976
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
870
977
|
*
|
|
871
978
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
872
979
|
*/
|
|
@@ -876,6 +983,7 @@ export declare class AasRepositoryClient {
|
|
|
876
983
|
submodelIdentifier: string;
|
|
877
984
|
idShortPath: string;
|
|
878
985
|
operationRequest: AasRepositoryService.OperationRequest;
|
|
986
|
+
ifMatch?: string;
|
|
879
987
|
}): Promise<ApiResult<AasRepositoryService.OperationResult, AasRepositoryService.Result>>;
|
|
880
988
|
/**
|
|
881
989
|
* Synchronously invokes an Operation at a specified path
|
|
@@ -886,6 +994,7 @@ export declare class AasRepositoryClient {
|
|
|
886
994
|
* - submodelIdentifier: The Submodel’s unique id
|
|
887
995
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
888
996
|
* - operationRequestValueOnly: OperationRequestValueOnly object
|
|
997
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
889
998
|
*
|
|
890
999
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
891
1000
|
*/
|
|
@@ -895,6 +1004,7 @@ export declare class AasRepositoryClient {
|
|
|
895
1004
|
submodelIdentifier: string;
|
|
896
1005
|
idShortPath: string;
|
|
897
1006
|
operationRequestValueOnly: AasRepositoryService.OperationRequestValueOnly;
|
|
1007
|
+
ifMatch?: string;
|
|
898
1008
|
}): Promise<ApiResult<AasRepositoryService.OperationResultValueOnly, AasRepositoryService.Result>>;
|
|
899
1009
|
/**
|
|
900
1010
|
* Asynchronously invokes an Operation at a specified path
|
|
@@ -905,6 +1015,7 @@ export declare class AasRepositoryClient {
|
|
|
905
1015
|
* - submodelIdentifier: The Submodel’s unique id
|
|
906
1016
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
907
1017
|
* - operationRequest: OperationRequest object
|
|
1018
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
908
1019
|
*
|
|
909
1020
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
910
1021
|
*/
|
|
@@ -914,6 +1025,7 @@ export declare class AasRepositoryClient {
|
|
|
914
1025
|
submodelIdentifier: string;
|
|
915
1026
|
idShortPath: string;
|
|
916
1027
|
operationRequest: AasRepositoryService.OperationRequest;
|
|
1028
|
+
ifMatch?: string;
|
|
917
1029
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
918
1030
|
/**
|
|
919
1031
|
* Asynchronously invokes an Operation at a specified path
|
|
@@ -924,6 +1036,7 @@ export declare class AasRepositoryClient {
|
|
|
924
1036
|
* - submodelIdentifier: The Submodel’s unique id
|
|
925
1037
|
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
926
1038
|
* - operationRequestValueOnly: Operation request object
|
|
1039
|
+
* - ifMatch?: Sent as `If-Match` header; the request fails with `preconditionFailed` if the resource has changed since the `etag` was issued
|
|
927
1040
|
*
|
|
928
1041
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
929
1042
|
*/
|
|
@@ -933,6 +1046,7 @@ export declare class AasRepositoryClient {
|
|
|
933
1046
|
submodelIdentifier: string;
|
|
934
1047
|
idShortPath: string;
|
|
935
1048
|
operationRequestValueOnly: AasRepositoryService.OperationRequestValueOnly;
|
|
1049
|
+
ifMatch?: string;
|
|
936
1050
|
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
937
1051
|
/**
|
|
938
1052
|
* Returns the Operation status of an asynchronous invoked Operation
|