basyx-typescript-sdk 0.2.2 → 0.9.0
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 +5 -3
- package/bundle/index.js +17534 -857
- package/bundle/index.js.map +1 -1
- package/dist/clients/AasDiscoveryClient.d.ts +67 -0
- package/dist/clients/AasDiscoveryClient.js +115 -0
- package/dist/clients/AasRegistryClient.d.ts +163 -0
- package/dist/clients/AasRegistryClient.js +287 -0
- package/dist/clients/AasRepositoryClient.d.ts +790 -103
- package/dist/clients/AasRepositoryClient.js +1323 -215
- package/dist/clients/AasxFileClient.d.ts +81 -0
- package/dist/clients/AasxFileClient.js +148 -0
- package/dist/clients/ConceptDescriptionRepositoryClient.d.ts +83 -0
- package/dist/clients/ConceptDescriptionRepositoryClient.js +143 -0
- package/dist/clients/SubmodelRegistryClient.d.ts +77 -0
- package/dist/clients/SubmodelRegistryClient.js +138 -0
- package/dist/clients/SubmodelRepositoryClient.d.ts +354 -0
- package/dist/clients/SubmodelRepositoryClient.js +585 -0
- package/dist/clients/index.d.ts +6 -0
- package/dist/clients/index.js +6 -0
- package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.d.ts +80 -0
- package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.js +156 -0
- package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/AasDiscoveryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/AasDiscoveryService/apis/index.d.ts +2 -0
- package/dist/generated/AasDiscoveryService/apis/index.js +4 -0
- package/dist/generated/AasDiscoveryService/index.d.ts +3 -0
- package/dist/generated/AasDiscoveryService/index.js +5 -0
- package/dist/generated/AasDiscoveryService/models/index.d.ts +297 -0
- package/dist/generated/AasDiscoveryService/models/index.js +48 -0
- package/dist/generated/AasDiscoveryService/runtime.d.ts +181 -0
- package/dist/generated/AasDiscoveryService/runtime.js +326 -0
- package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.d.ts +139 -0
- package/dist/generated/AasRegistryService/apis/AssetAdministrationShellRegistryAPIApi.js +312 -0
- package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/AasRegistryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/AasRegistryService/apis/index.d.ts +2 -0
- package/dist/generated/AasRegistryService/apis/index.js +4 -0
- package/dist/generated/AasRegistryService/index.d.ts +3 -0
- package/dist/generated/AasRegistryService/index.js +5 -0
- package/dist/generated/AasRegistryService/models/index.d.ts +1070 -0
- package/dist/generated/AasRegistryService/models/index.js +151 -0
- 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 +870 -0
- package/dist/generated/AasRepositoryService/apis/AssetAdministrationShellRepositoryAPIApi.js +1842 -0
- package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/AasRepositoryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
- package/dist/generated/AasRepositoryService/apis/SerializationAPIApi.js +49 -0
- package/dist/generated/AasRepositoryService/apis/index.d.ts +3 -0
- package/dist/generated/AasRepositoryService/apis/index.js +5 -0
- package/dist/generated/AasRepositoryService/index.d.ts +3 -0
- package/dist/generated/AasRepositoryService/index.js +5 -0
- package/dist/generated/AasRepositoryService/models/index.d.ts +4585 -0
- package/dist/generated/AasRepositoryService/models/index.js +221 -0
- package/dist/generated/AasRepositoryService/runtime.d.ts +181 -0
- package/dist/generated/AasRepositoryService/runtime.js +326 -0
- package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.d.ts +78 -0
- package/dist/generated/AasxFileService/apis/AASXFileServerAPIApi.js +184 -0
- package/dist/generated/AasxFileService/apis/index.d.ts +1 -0
- package/dist/generated/AasxFileService/apis/index.js +3 -0
- package/dist/generated/AasxFileService/index.d.ts +3 -0
- package/dist/generated/AasxFileService/index.js +5 -0
- package/dist/generated/AasxFileService/models/index.d.ts +80 -0
- package/dist/generated/AasxFileService/models/index.js +10 -0
- package/dist/generated/AasxFileService/runtime.d.ts +181 -0
- package/dist/generated/AasxFileService/runtime.js +326 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.d.ts +78 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/ConceptDescriptionRepositoryAPIApi.js +164 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/SerializationAPIApi.js +49 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/index.d.ts +3 -0
- package/dist/generated/ConceptDescriptionRepositoryService/apis/index.js +5 -0
- package/dist/generated/ConceptDescriptionRepositoryService/index.d.ts +3 -0
- package/dist/generated/ConceptDescriptionRepositoryService/index.js +5 -0
- package/dist/generated/ConceptDescriptionRepositoryService/models/index.d.ts +2869 -0
- package/dist/generated/ConceptDescriptionRepositoryService/models/index.js +209 -0
- package/dist/generated/ConceptDescriptionRepositoryService/runtime.d.ts +181 -0
- package/dist/generated/ConceptDescriptionRepositoryService/runtime.js +326 -0
- package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/SubmodelRegistryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.d.ts +75 -0
- package/dist/generated/SubmodelRegistryService/apis/SubmodelRegistryAPIApi.js +155 -0
- package/dist/generated/SubmodelRegistryService/apis/index.d.ts +2 -0
- package/dist/generated/SubmodelRegistryService/apis/index.js +4 -0
- package/dist/generated/SubmodelRegistryService/index.d.ts +3 -0
- package/dist/generated/SubmodelRegistryService/index.js +5 -0
- package/dist/generated/SubmodelRegistryService/models/index.d.ts +924 -0
- package/dist/generated/SubmodelRegistryService/models/index.js +141 -0
- package/dist/generated/SubmodelRegistryService/runtime.d.ts +181 -0
- package/dist/generated/SubmodelRegistryService/runtime.js +326 -0
- package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.d.ts +26 -0
- package/dist/generated/SubmodelRepositoryService/apis/DescriptionAPIApi.js +40 -0
- package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.d.ts +30 -0
- package/dist/generated/SubmodelRepositoryService/apis/SerializationAPIApi.js +49 -0
- package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.d.ts +802 -0
- package/dist/generated/SubmodelRepositoryService/apis/SubmodelRepositoryAPIApi.js +1572 -0
- package/dist/generated/SubmodelRepositoryService/apis/index.d.ts +3 -0
- package/dist/generated/SubmodelRepositoryService/apis/index.js +5 -0
- package/dist/generated/SubmodelRepositoryService/index.d.ts +3 -0
- package/dist/generated/SubmodelRepositoryService/index.js +5 -0
- package/dist/generated/SubmodelRepositoryService/models/index.d.ts +4623 -0
- package/dist/generated/SubmodelRepositoryService/models/index.js +221 -0
- package/dist/generated/SubmodelRepositoryService/runtime.d.ts +181 -0
- package/dist/generated/SubmodelRepositoryService/runtime.js +326 -0
- package/dist/generated/index.d.ts +8 -2
- package/dist/generated/index.js +8 -3
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/lib/apiConfig.d.ts +2 -0
- package/dist/lib/apiConfig.js +41 -0
- package/dist/lib/base64Url.js +4 -0
- package/dist/lib/convertAasDescriptorTypes.d.ts +34 -0
- package/dist/lib/convertAasDescriptorTypes.js +76 -0
- package/dist/lib/convertAasDiscoveryTypes.d.ts +18 -0
- package/dist/lib/convertAasDiscoveryTypes.js +39 -0
- package/dist/lib/convertAasTypes.d.ts +7 -7
- package/dist/lib/convertAasTypes.js +5 -0
- package/dist/lib/convertConceptDescriptionTypes.d.ts +18 -0
- package/dist/lib/convertConceptDescriptionTypes.js +39 -0
- package/dist/lib/convertSubmodelTypes.d.ts +34 -0
- package/dist/lib/convertSubmodelTypes.js +69 -0
- package/dist/lib/descriptorJsonization.d.ts +12 -0
- package/dist/lib/descriptorJsonization.js +172 -0
- package/dist/lib/errorHandler.d.ts +9 -0
- package/dist/lib/errorHandler.js +113 -0
- package/dist/models/Descriptors.d.ts +51 -0
- package/dist/models/Descriptors.js +56 -0
- package/dist/models/index.d.ts +0 -1
- package/dist/models/index.js +0 -1
- package/dist/utils/DescriptorUtils.d.ts +9 -0
- package/dist/utils/DescriptorUtils.js +37 -0
- package/dist/utils/KeyTypesUtil.d.ts +24 -0
- package/dist/utils/KeyTypesUtil.js +55 -0
- package/dist/utils/MultiLanguagePropertyUtils.d.ts +24 -0
- package/dist/utils/MultiLanguagePropertyUtils.js +46 -0
- package/dist/utils/ReferableUtils.d.ts +69 -0
- package/dist/utils/ReferableUtils.js +220 -0
- package/dist/utils/ReferenceUtil.d.ts +9 -0
- package/dist/utils/ReferenceUtil.js +22 -0
- package/dist/utils/SemanticIdUtils.d.ts +119 -0
- package/dist/utils/SemanticIdUtils.js +363 -0
- package/package.json +14 -11
- package/dist/generated/schemas.gen.d.ts +0 -2357
- package/dist/generated/schemas.gen.js +0 -2789
- package/dist/generated/sdk.gen.d.ts +0 -822
- package/dist/generated/sdk.gen.js +0 -2225
- package/dist/generated/types.gen.d.ts +0 -10829
- package/dist/generated/types.gen.js +0 -2
- package/dist/lib/createAasRepoClient.d.ts +0 -9
- package/dist/lib/createAasRepoClient.js +0 -15
- package/dist/models/aas-repository.d.ts +0 -65
- package/dist/models/aas-repository.js +0 -1
|
@@ -1,227 +1,914 @@
|
|
|
1
|
-
import type { AssetAdministrationShell, AssetInformation, Reference } from '@aas-core-works/aas-core3.0-typescript/types';
|
|
1
|
+
import type { AssetAdministrationShell, AssetInformation, ISubmodelElement, Reference, Submodel } from '@aas-core-works/aas-core3.0-typescript/types';
|
|
2
2
|
import type { ApiResult } from '../models/api';
|
|
3
3
|
import type { AssetId } from '../models/AssetId';
|
|
4
|
-
import
|
|
4
|
+
import { AasRepositoryService } from '../generated';
|
|
5
5
|
export declare class AasRepositoryClient {
|
|
6
6
|
/**
|
|
7
|
-
* Returns all Asset Administration Shells
|
|
7
|
+
* Returns all Asset Administration Shells
|
|
8
8
|
*
|
|
9
9
|
* @param options Object containing:
|
|
10
|
-
* -
|
|
11
|
-
* -
|
|
12
|
-
* -
|
|
13
|
-
* -
|
|
14
|
-
* -
|
|
15
|
-
* - cursor?: A paging cursor from previous responses
|
|
10
|
+
* - configuration: The http request options
|
|
11
|
+
* - assetIds?: A list of specific Asset identifiers
|
|
12
|
+
* - idShort?: The Asset Administration Shell’s IdShort
|
|
13
|
+
* - limit?: The maximum number of elements in the response array
|
|
14
|
+
* - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
|
|
16
15
|
*
|
|
17
16
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
18
17
|
*/
|
|
19
18
|
getAllAssetAdministrationShells(options: {
|
|
20
|
-
|
|
21
|
-
headers?: Headers;
|
|
19
|
+
configuration: AasRepositoryService.Configuration;
|
|
22
20
|
assetIds?: AssetId[];
|
|
23
21
|
idShort?: string;
|
|
24
22
|
limit?: number;
|
|
25
23
|
cursor?: string;
|
|
26
24
|
}): Promise<ApiResult<{
|
|
27
|
-
pagedResult:
|
|
25
|
+
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
28
26
|
result: AssetAdministrationShell[];
|
|
29
|
-
},
|
|
27
|
+
}, AasRepositoryService.Result>>;
|
|
30
28
|
/**
|
|
31
|
-
* Creates a new Asset Administration Shell
|
|
29
|
+
* Creates a new Asset Administration Shell
|
|
32
30
|
*
|
|
33
31
|
* @param options Object containing:
|
|
34
|
-
* -
|
|
35
|
-
* - assetAdministrationShell:
|
|
36
|
-
* - headers?: Optional request headers
|
|
32
|
+
* - configuration: The http request options.
|
|
33
|
+
* - assetAdministrationShell: Asset Administration Shell object
|
|
37
34
|
*
|
|
38
35
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
39
36
|
*/
|
|
40
37
|
postAssetAdministrationShell(options: {
|
|
41
|
-
|
|
42
|
-
headers?: Headers;
|
|
38
|
+
configuration: AasRepositoryService.Configuration;
|
|
43
39
|
assetAdministrationShell: AssetAdministrationShell;
|
|
44
|
-
}): Promise<ApiResult<AssetAdministrationShell,
|
|
40
|
+
}): Promise<ApiResult<AssetAdministrationShell, AasRepositoryService.Result>>;
|
|
45
41
|
/**
|
|
46
|
-
* Deletes an Asset Administration Shell
|
|
42
|
+
* Deletes an Asset Administration Shell
|
|
47
43
|
*
|
|
48
44
|
* @param options Object containing:
|
|
49
|
-
* -
|
|
50
|
-
* - aasIdentifier: The
|
|
51
|
-
* - headers?: Optional request headers
|
|
45
|
+
* - configuration: The http request options
|
|
46
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
52
47
|
*
|
|
53
48
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
54
49
|
*/
|
|
55
50
|
deleteAssetAdministrationShellById(options: {
|
|
56
|
-
|
|
51
|
+
configuration: AasRepositoryService.Configuration;
|
|
57
52
|
aasIdentifier: string;
|
|
58
|
-
|
|
59
|
-
}): Promise<ApiResult<AasRepository.DeleteAssetAdministrationShellByIdResponse, AasRepository.DeleteAssetAdministrationShellByIdError | Error>>;
|
|
53
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
60
54
|
/**
|
|
61
|
-
* Returns a specific Asset Administration Shell
|
|
55
|
+
* Returns a specific Asset Administration Shell
|
|
62
56
|
*
|
|
63
57
|
* @param options Object containing:
|
|
64
|
-
* -
|
|
65
|
-
* - aasIdentifier: The unique
|
|
66
|
-
* - headers?: Optional request headers
|
|
58
|
+
* - configuration: The http request options
|
|
59
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
67
60
|
*
|
|
68
61
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
69
62
|
*/
|
|
70
63
|
getAssetAdministrationShellById(options: {
|
|
71
|
-
|
|
64
|
+
configuration: AasRepositoryService.Configuration;
|
|
72
65
|
aasIdentifier: string;
|
|
73
|
-
|
|
74
|
-
}): Promise<ApiResult<AssetAdministrationShell, AasRepository.GetAssetAdministrationShellByIdError | Error>>;
|
|
66
|
+
}): Promise<ApiResult<AssetAdministrationShell, AasRepositoryService.Result>>;
|
|
75
67
|
/**
|
|
76
|
-
* Updates an existing Asset Administration Shell
|
|
68
|
+
* Updates an existing Asset Administration Shell
|
|
77
69
|
*
|
|
78
70
|
* @param options Object containing:
|
|
79
|
-
* -
|
|
80
|
-
* - aasIdentifier: The unique
|
|
81
|
-
* - assetAdministrationShell:
|
|
82
|
-
* - headers?: Optional request headers
|
|
71
|
+
* - configuration: The http request options
|
|
72
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
73
|
+
* - assetAdministrationShell: Asset Administration Shell object
|
|
83
74
|
*
|
|
84
75
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
85
76
|
*/
|
|
86
77
|
putAssetAdministrationShellById(options: {
|
|
87
|
-
|
|
78
|
+
configuration: AasRepositoryService.Configuration;
|
|
88
79
|
aasIdentifier: string;
|
|
89
80
|
assetAdministrationShell: AssetAdministrationShell;
|
|
90
|
-
|
|
91
|
-
}): Promise<ApiResult<AasRepository.PutAssetAdministrationShellByIdResponse, AasRepository.PutAssetAdministrationShellByIdError | Error>>;
|
|
81
|
+
}): Promise<ApiResult<AssetAdministrationShell | void, AasRepositoryService.Result>>;
|
|
92
82
|
/**
|
|
93
|
-
* Returns the
|
|
83
|
+
* Returns the Asset Information
|
|
94
84
|
*
|
|
95
85
|
* @param options Object containing:
|
|
96
|
-
* -
|
|
97
|
-
* - aasIdentifier: The unique
|
|
98
|
-
* - headers?: Optional request headers
|
|
86
|
+
* - configuration: The http request options
|
|
87
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
99
88
|
*
|
|
100
89
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
101
90
|
*/
|
|
102
91
|
getAssetInformation(options: {
|
|
103
|
-
|
|
92
|
+
configuration: AasRepositoryService.Configuration;
|
|
104
93
|
aasIdentifier: string;
|
|
105
|
-
|
|
106
|
-
}): Promise<ApiResult<AssetInformation, AasRepository.GetAssetInformationAasRepositoryError | Error>>;
|
|
94
|
+
}): Promise<ApiResult<AssetInformation, AasRepositoryService.Result>>;
|
|
107
95
|
/**
|
|
108
|
-
* Updates the
|
|
96
|
+
* Updates the Asset Information
|
|
109
97
|
*
|
|
110
98
|
* @param options Object containing:
|
|
111
|
-
* -
|
|
112
|
-
* - aasIdentifier: The unique
|
|
113
|
-
* - assetInformation:
|
|
114
|
-
* - headers?: Optional request headers
|
|
99
|
+
* - configuration: The http request options
|
|
100
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
101
|
+
* - assetInformation: Asset Information object
|
|
115
102
|
*
|
|
116
103
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
117
104
|
*/
|
|
118
105
|
putAssetInformation(options: {
|
|
119
|
-
|
|
106
|
+
configuration: AasRepositoryService.Configuration;
|
|
120
107
|
aasIdentifier: string;
|
|
121
108
|
assetInformation: AssetInformation;
|
|
122
|
-
|
|
123
|
-
}): Promise<ApiResult<AasRepository.PutAssetInformationAasRepositoryResponse, AasRepository.PutAssetInformationAasRepositoryError | Error>>;
|
|
109
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
124
110
|
/**
|
|
125
|
-
* Deletes the Thumbnail associated with the given AAS
|
|
111
|
+
* Deletes the Thumbnail associated with the given AAS
|
|
126
112
|
*
|
|
127
113
|
* @param options Object containing:
|
|
128
|
-
* -
|
|
129
|
-
* - aasIdentifier: The unique
|
|
130
|
-
* - headers?: Optional request headers
|
|
114
|
+
* - configuration: The http request options
|
|
115
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
131
116
|
*
|
|
132
117
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
133
118
|
*/
|
|
134
119
|
deleteThumbnail(options: {
|
|
135
|
-
|
|
120
|
+
configuration: AasRepositoryService.Configuration;
|
|
136
121
|
aasIdentifier: string;
|
|
137
|
-
|
|
138
|
-
}): Promise<ApiResult<AasRepository.DeleteThumbnailAasRepositoryResponses, AasRepository.DeleteThumbnailAasRepositoryError | Error>>;
|
|
122
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
139
123
|
/**
|
|
140
|
-
* Returns the Thumbnail associated with an AAS, if any
|
|
124
|
+
* Returns the Thumbnail associated with an AAS, if any
|
|
141
125
|
*
|
|
142
126
|
* @param options Object containing:
|
|
143
|
-
* -
|
|
144
|
-
* - aasIdentifier: The unique
|
|
145
|
-
* - headers?: Optional request headers
|
|
127
|
+
* - configuration: The http request options
|
|
128
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
146
129
|
*
|
|
147
130
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
148
131
|
*/
|
|
149
132
|
getThumbnail(options: {
|
|
150
|
-
|
|
133
|
+
configuration: AasRepositoryService.Configuration;
|
|
151
134
|
aasIdentifier: string;
|
|
152
|
-
|
|
153
|
-
}): Promise<ApiResult<Blob | File, AasRepository.GetThumbnailAasRepositoryError | Error>>;
|
|
135
|
+
}): Promise<ApiResult<Blob, AasRepositoryService.Result>>;
|
|
154
136
|
/**
|
|
155
|
-
* Updates (or creates) the Thumbnail for the given AAS
|
|
137
|
+
* Updates (or creates) the Thumbnail for the given AAS
|
|
156
138
|
*
|
|
157
139
|
* @param options Object containing:
|
|
158
|
-
* -
|
|
159
|
-
* - aasIdentifier: The unique
|
|
160
|
-
* -
|
|
161
|
-
* -
|
|
140
|
+
* - configuration: The http request options
|
|
141
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
142
|
+
* - fileName: The name of the file
|
|
143
|
+
* - file: The file to upload
|
|
162
144
|
*
|
|
163
145
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
164
146
|
*/
|
|
165
147
|
putThumbnail(options: {
|
|
166
|
-
|
|
148
|
+
configuration: AasRepositoryService.Configuration;
|
|
167
149
|
aasIdentifier: string;
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
}): Promise<ApiResult<
|
|
150
|
+
fileName: string;
|
|
151
|
+
file: Blob;
|
|
152
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
171
153
|
/**
|
|
172
|
-
* Returns all submodel references
|
|
154
|
+
* Returns all submodel references
|
|
173
155
|
*
|
|
174
156
|
* @param options Object containing:
|
|
175
|
-
* -
|
|
176
|
-
* - aasIdentifier: The unique
|
|
177
|
-
* -
|
|
178
|
-
* -
|
|
179
|
-
* - cursor?: Paging cursor
|
|
157
|
+
* - configuration: The http request options
|
|
158
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
159
|
+
* - limit?: The maximum number of elements in the response array
|
|
160
|
+
* - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
|
|
180
161
|
*
|
|
181
162
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
182
163
|
*/
|
|
183
164
|
getAllSubmodelReferences(options: {
|
|
184
|
-
|
|
165
|
+
configuration: AasRepositoryService.Configuration;
|
|
185
166
|
aasIdentifier: string;
|
|
186
|
-
headers?: Headers;
|
|
187
167
|
limit?: number;
|
|
188
168
|
cursor?: string;
|
|
189
169
|
}): Promise<ApiResult<{
|
|
190
|
-
pagedResult:
|
|
170
|
+
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
191
171
|
result: Reference[];
|
|
192
|
-
},
|
|
172
|
+
}, AasRepositoryService.Result>>;
|
|
193
173
|
/**
|
|
194
|
-
* Creates a submodel reference at the
|
|
174
|
+
* Creates a submodel reference at the Asset Administration Shell
|
|
195
175
|
*
|
|
196
176
|
* @param options Object containing:
|
|
197
|
-
* -
|
|
198
|
-
* - aasIdentifier: The
|
|
199
|
-
* - submodelReference:
|
|
200
|
-
* - headers?: Optional request headers
|
|
177
|
+
* - configuration: The http request options
|
|
178
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
179
|
+
* - submodelReference: Reference to the Submodel
|
|
201
180
|
*
|
|
202
181
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
203
182
|
*/
|
|
204
183
|
postSubmodelReference(options: {
|
|
205
|
-
|
|
184
|
+
configuration: AasRepositoryService.Configuration;
|
|
206
185
|
aasIdentifier: string;
|
|
207
186
|
submodelReference: Reference;
|
|
208
|
-
|
|
209
|
-
}): Promise<ApiResult<Reference, AasRepository.PostSubmodelReferenceAasRepositoryError | Error>>;
|
|
187
|
+
}): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
|
|
210
188
|
/**
|
|
211
189
|
* Deletes a submodel reference from the given AAS (does not delete the submodel itself).
|
|
212
190
|
*
|
|
213
191
|
* @param options Object containing:
|
|
214
|
-
* -
|
|
192
|
+
* - configuration: The http request options
|
|
215
193
|
* - aasIdentifier: Unique ID of the AAS
|
|
216
194
|
* - submodelIdentifier: The submodel's unique ID
|
|
217
|
-
* - headers?: Optional request headers
|
|
218
195
|
*
|
|
219
196
|
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
220
197
|
*/
|
|
221
198
|
deleteSubmodelReferenceById(options: {
|
|
222
|
-
|
|
199
|
+
configuration: AasRepositoryService.Configuration;
|
|
223
200
|
aasIdentifier: string;
|
|
224
201
|
submodelIdentifier: string;
|
|
225
|
-
|
|
226
|
-
|
|
202
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
203
|
+
/**
|
|
204
|
+
* Returns the Submodel
|
|
205
|
+
*
|
|
206
|
+
* @param options Object containing:
|
|
207
|
+
* - configuration: The http request options
|
|
208
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
209
|
+
* - submodelIdentifier: The submodel's unique ID
|
|
210
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
211
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
212
|
+
*
|
|
213
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
214
|
+
*/
|
|
215
|
+
getSubmodelByIdAasRepository(options: {
|
|
216
|
+
configuration: AasRepositoryService.Configuration;
|
|
217
|
+
aasIdentifier: string;
|
|
218
|
+
submodelIdentifier: string;
|
|
219
|
+
level?: AasRepositoryService.GetSubmodelByIdAasRepositoryLevelEnum;
|
|
220
|
+
extent?: AasRepositoryService.GetSubmodelByIdAasRepositoryExtentEnum;
|
|
221
|
+
}): Promise<ApiResult<Submodel, AasRepositoryService.Result>>;
|
|
222
|
+
/**
|
|
223
|
+
* Creates or updates the Submodel
|
|
224
|
+
*
|
|
225
|
+
* @param options Object containing:
|
|
226
|
+
* - configuration: The http request options
|
|
227
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
228
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
229
|
+
* - submodel: Submodel object
|
|
230
|
+
*
|
|
231
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
232
|
+
*/
|
|
233
|
+
putSubmodelByIdAasRepository(options: {
|
|
234
|
+
configuration: AasRepositoryService.Configuration;
|
|
235
|
+
aasIdentifier: string;
|
|
236
|
+
submodelIdentifier: string;
|
|
237
|
+
submodel: Submodel;
|
|
238
|
+
}): Promise<ApiResult<Reference | void, AasRepositoryService.Result>>;
|
|
239
|
+
/**
|
|
240
|
+
* Deletes the submodel from the Asset Administration Shell and the Repository.
|
|
241
|
+
*
|
|
242
|
+
* @param options Object containing:
|
|
243
|
+
* - configuration: The http request options
|
|
244
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
245
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
246
|
+
*
|
|
247
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
248
|
+
*/
|
|
249
|
+
deleteSubmodelByIdAasRepository(options: {
|
|
250
|
+
configuration: AasRepositoryService.Configuration;
|
|
251
|
+
aasIdentifier: string;
|
|
252
|
+
submodelIdentifier: string;
|
|
253
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
254
|
+
/**
|
|
255
|
+
* Updates the Submodel
|
|
256
|
+
*
|
|
257
|
+
* @param options Object containing:
|
|
258
|
+
* - configuration: The http request options
|
|
259
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
260
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
261
|
+
* - submodel: Submodel object
|
|
262
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
263
|
+
*
|
|
264
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
265
|
+
*/
|
|
266
|
+
patchSubmodelAasRepository(options: {
|
|
267
|
+
configuration: AasRepositoryService.Configuration;
|
|
268
|
+
aasIdentifier: string;
|
|
269
|
+
submodelIdentifier: string;
|
|
270
|
+
submodel: Submodel;
|
|
271
|
+
level?: AasRepositoryService.PatchSubmodelAasRepositoryLevelEnum;
|
|
272
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
273
|
+
/**
|
|
274
|
+
* Returns the Submodel's metadata elements
|
|
275
|
+
*
|
|
276
|
+
* @param options Object containing:
|
|
277
|
+
* - configuration: The http request options
|
|
278
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
279
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
280
|
+
*
|
|
281
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
282
|
+
*/
|
|
283
|
+
getSubmodelByIdMetadataAasRepository(options: {
|
|
284
|
+
configuration: AasRepositoryService.Configuration;
|
|
285
|
+
aasIdentifier: string;
|
|
286
|
+
submodelIdentifier: string;
|
|
287
|
+
}): Promise<ApiResult<AasRepositoryService.SubmodelMetadata, AasRepositoryService.Result>>;
|
|
288
|
+
/**
|
|
289
|
+
* Updates the metadata attributes of the Submodel
|
|
290
|
+
*
|
|
291
|
+
* @param options Object containing:
|
|
292
|
+
* - configuration: The http request options
|
|
293
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
294
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
295
|
+
* - submodelMetadata: The Submodel Metadata object
|
|
296
|
+
*
|
|
297
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
298
|
+
*/
|
|
299
|
+
patchSubmodelByIdMetadataAasRepository(options: {
|
|
300
|
+
configuration: AasRepositoryService.Configuration;
|
|
301
|
+
aasIdentifier: string;
|
|
302
|
+
submodelIdentifier: string;
|
|
303
|
+
submodelMetadata: AasRepositoryService.SubmodelMetadata;
|
|
304
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
305
|
+
/**
|
|
306
|
+
* Returns the Submodel's ValueOnly representation
|
|
307
|
+
*
|
|
308
|
+
* @param options Object containing:
|
|
309
|
+
* - configuration: The http request options
|
|
310
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
311
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
312
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
313
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
314
|
+
*
|
|
315
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
316
|
+
*/
|
|
317
|
+
getSubmodelByIdValueOnlyAasRepository(options: {
|
|
318
|
+
configuration: AasRepositoryService.Configuration;
|
|
319
|
+
aasIdentifier: string;
|
|
320
|
+
submodelIdentifier: string;
|
|
321
|
+
level?: AasRepositoryService.GetSubmodelByIdValueOnlyAasRepositoryLevelEnum;
|
|
322
|
+
extent?: AasRepositoryService.GetSubmodelByIdValueOnlyAasRepositoryExtentEnum;
|
|
323
|
+
}): Promise<ApiResult<object, AasRepositoryService.Result>>;
|
|
324
|
+
/**
|
|
325
|
+
* Updates the values of the Submodel
|
|
326
|
+
*
|
|
327
|
+
* @param options Object containing:
|
|
328
|
+
* - configuration: The http request options
|
|
329
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
330
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
331
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
332
|
+
*
|
|
333
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
334
|
+
*/
|
|
335
|
+
patchSubmodelByIdValueOnlyAasRepository(options: {
|
|
336
|
+
configuration: AasRepositoryService.Configuration;
|
|
337
|
+
aasIdentifier: string;
|
|
338
|
+
submodelIdentifier: string;
|
|
339
|
+
body: object;
|
|
340
|
+
level?: AasRepositoryService.PatchSubmodelByIdValueOnlyAasRepositoryLevelEnum;
|
|
341
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
342
|
+
/**
|
|
343
|
+
* Returns the Submodel as a Reference
|
|
344
|
+
*
|
|
345
|
+
* @param options Object containing:
|
|
346
|
+
* - configuration: The http request options
|
|
347
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
348
|
+
* - submodelIdentifier: The submodel's unique ID
|
|
349
|
+
*
|
|
350
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
351
|
+
*/
|
|
352
|
+
getSubmodelByIdReferenceAasRepository(options: {
|
|
353
|
+
configuration: AasRepositoryService.Configuration;
|
|
354
|
+
aasIdentifier: string;
|
|
355
|
+
submodelIdentifier: string;
|
|
356
|
+
}): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
|
|
357
|
+
/**
|
|
358
|
+
* Returns the elements of this submodel in path notation.
|
|
359
|
+
*
|
|
360
|
+
* @param options Object containing:
|
|
361
|
+
* - configuration: The http request options
|
|
362
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
363
|
+
* - submodelIdentifier: The submodel's unique ID
|
|
364
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
365
|
+
*
|
|
366
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
367
|
+
*/
|
|
368
|
+
getSubmodelByIdPathAasRepository(options: {
|
|
369
|
+
configuration: AasRepositoryService.Configuration;
|
|
370
|
+
aasIdentifier: string;
|
|
371
|
+
submodelIdentifier: string;
|
|
372
|
+
level?: AasRepositoryService.GetSubmodelByIdPathAasRepositoryLevelEnum;
|
|
373
|
+
}): Promise<ApiResult<Array<string>, AasRepositoryService.Result>>;
|
|
374
|
+
/**
|
|
375
|
+
* Returns all submodel elements including their hierarchy
|
|
376
|
+
*
|
|
377
|
+
* @param options Object containing:
|
|
378
|
+
* - configuration: The http request options
|
|
379
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
380
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
381
|
+
* - limit?: The maximum number of elements in the response array
|
|
382
|
+
* - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
|
|
383
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
384
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
385
|
+
*
|
|
386
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
387
|
+
*/
|
|
388
|
+
getAllSubmodelElementsAasRepository(options: {
|
|
389
|
+
configuration: AasRepositoryService.Configuration;
|
|
390
|
+
aasIdentifier: string;
|
|
391
|
+
submodelIdentifier: string;
|
|
392
|
+
limit?: number;
|
|
393
|
+
cursor?: string;
|
|
394
|
+
level?: AasRepositoryService.GetAllSubmodelElementsAasRepositoryLevelEnum;
|
|
395
|
+
extent?: AasRepositoryService.GetAllSubmodelElementsAasRepositoryExtentEnum;
|
|
396
|
+
}): Promise<ApiResult<{
|
|
397
|
+
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
398
|
+
result: ISubmodelElement[];
|
|
399
|
+
}, AasRepositoryService.Result>>;
|
|
400
|
+
/**
|
|
401
|
+
* Creates a new submodel element
|
|
402
|
+
*
|
|
403
|
+
* @param options Object containing:
|
|
404
|
+
* - configuration: The http request options
|
|
405
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
406
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
407
|
+
* - submodelElement: The Submodel Element object
|
|
408
|
+
*
|
|
409
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
410
|
+
*/
|
|
411
|
+
postSubmodelElementAasRepository(options: {
|
|
412
|
+
configuration: AasRepositoryService.Configuration;
|
|
413
|
+
aasIdentifier: string;
|
|
414
|
+
submodelIdentifier: string;
|
|
415
|
+
submodelElement: ISubmodelElement;
|
|
416
|
+
}): Promise<ApiResult<ISubmodelElement, AasRepositoryService.Result>>;
|
|
417
|
+
/**
|
|
418
|
+
* Returns all submodel elements including their hierarchy
|
|
419
|
+
*
|
|
420
|
+
* @param options Object containing:
|
|
421
|
+
* - configuration: The http request options
|
|
422
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
423
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
424
|
+
* - limit?: The maximum number of elements in the response array
|
|
425
|
+
* - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
|
|
426
|
+
*
|
|
427
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
428
|
+
*/
|
|
429
|
+
getAllSubmodelElementsMetadataAasRepository(options: {
|
|
430
|
+
configuration: AasRepositoryService.Configuration;
|
|
431
|
+
aasIdentifier: string;
|
|
432
|
+
submodelIdentifier: string;
|
|
433
|
+
limit?: number;
|
|
434
|
+
cursor?: string;
|
|
435
|
+
}): Promise<ApiResult<{
|
|
436
|
+
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
437
|
+
result: AasRepositoryService.SubmodelElementMetadata[];
|
|
438
|
+
}, AasRepositoryService.Result>>;
|
|
439
|
+
/**
|
|
440
|
+
* Returns all submodel elements including their hierarchy in the ValueOnly representation
|
|
441
|
+
*
|
|
442
|
+
* @param options Object containing:
|
|
443
|
+
* - configuration: The http request options
|
|
444
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
445
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
446
|
+
* - limit?: The maximum number of elements in the response array
|
|
447
|
+
* - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
|
|
448
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
449
|
+
*
|
|
450
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
451
|
+
*/
|
|
452
|
+
getAllSubmodelElementsValueOnlyAasRepository(options: {
|
|
453
|
+
configuration: AasRepositoryService.Configuration;
|
|
454
|
+
aasIdentifier: string;
|
|
455
|
+
submodelIdentifier: string;
|
|
456
|
+
limit?: number;
|
|
457
|
+
cursor?: string;
|
|
458
|
+
level?: AasRepositoryService.GetAllSubmodelElementsValueOnlyAasRepositoryLevelEnum;
|
|
459
|
+
}): Promise<ApiResult<{
|
|
460
|
+
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
461
|
+
result: object;
|
|
462
|
+
}, AasRepositoryService.Result>>;
|
|
463
|
+
/**
|
|
464
|
+
* Returns all submodel elements as a list of References
|
|
465
|
+
*
|
|
466
|
+
* @param options Object containing:
|
|
467
|
+
* - configuration: The http request options
|
|
468
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
469
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
470
|
+
* - limit?: The maximum number of elements in the response array
|
|
471
|
+
* - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
|
|
472
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
473
|
+
*
|
|
474
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
475
|
+
*/
|
|
476
|
+
getAllSubmodelElementsReferenceAasRepository(options: {
|
|
477
|
+
configuration: AasRepositoryService.Configuration;
|
|
478
|
+
aasIdentifier: string;
|
|
479
|
+
submodelIdentifier: string;
|
|
480
|
+
limit?: number;
|
|
481
|
+
cursor?: string;
|
|
482
|
+
level?: AasRepositoryService.GetAllSubmodelElementsReferenceAasRepositoryLevelEnum;
|
|
483
|
+
}): Promise<ApiResult<{
|
|
484
|
+
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
485
|
+
result: Reference[];
|
|
486
|
+
}, AasRepositoryService.Result>>;
|
|
487
|
+
/**
|
|
488
|
+
* Returns all submodel elements including their hierarchy
|
|
489
|
+
*
|
|
490
|
+
* @param options Object containing:
|
|
491
|
+
* - configuration: The http request options
|
|
492
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
493
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
494
|
+
* - limit?: The maximum number of elements in the response array
|
|
495
|
+
* - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
|
|
496
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
497
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
498
|
+
*
|
|
499
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
500
|
+
*/
|
|
501
|
+
getAllSubmodelElementsPathAasRepository(options: {
|
|
502
|
+
configuration: AasRepositoryService.Configuration;
|
|
503
|
+
aasIdentifier: string;
|
|
504
|
+
submodelIdentifier: string;
|
|
505
|
+
limit?: number;
|
|
506
|
+
cursor?: string;
|
|
507
|
+
level?: AasRepositoryService.GetAllSubmodelElementsPathAasRepositoryLevelEnum;
|
|
508
|
+
extent?: AasRepositoryService.GetAllSubmodelElementsPathAasRepositoryExtentEnum;
|
|
509
|
+
}): Promise<ApiResult<{
|
|
510
|
+
pagedResult: AasRepositoryService.PagedResultPagingMetadata | undefined;
|
|
511
|
+
result: string[];
|
|
512
|
+
}, AasRepositoryService.Result>>;
|
|
513
|
+
/**
|
|
514
|
+
* Returns a specific submodel element from the Submodel at a specified path
|
|
515
|
+
*
|
|
516
|
+
* @param options Object containing:
|
|
517
|
+
* - configuration: The http request options
|
|
518
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
519
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
520
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
521
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
522
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
523
|
+
*
|
|
524
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
525
|
+
*/
|
|
526
|
+
getSubmodelElementByPathAasRepository(options: {
|
|
527
|
+
configuration: AasRepositoryService.Configuration;
|
|
528
|
+
aasIdentifier: string;
|
|
529
|
+
submodelIdentifier: string;
|
|
530
|
+
idShortPath: string;
|
|
531
|
+
level?: AasRepositoryService.GetSubmodelElementByPathAasRepositoryLevelEnum;
|
|
532
|
+
extent?: AasRepositoryService.GetSubmodelElementByPathAasRepositoryExtentEnum;
|
|
533
|
+
}): Promise<ApiResult<ISubmodelElement, AasRepositoryService.Result>>;
|
|
534
|
+
/**
|
|
535
|
+
* Creates a new submodel element at a specified path within submodel elements hierarchy
|
|
536
|
+
*
|
|
537
|
+
* @param options Object containing:
|
|
538
|
+
* - configuration: The http request options.
|
|
539
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
540
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
541
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
542
|
+
* - submodelElement: SubmodelElement object
|
|
543
|
+
*
|
|
544
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
545
|
+
*/
|
|
546
|
+
postSubmodelElementByPathAasRepository(options: {
|
|
547
|
+
configuration: AasRepositoryService.Configuration;
|
|
548
|
+
aasIdentifier: string;
|
|
549
|
+
submodelIdentifier: string;
|
|
550
|
+
idShortPath: string;
|
|
551
|
+
submodelElement: ISubmodelElement;
|
|
552
|
+
}): Promise<ApiResult<ISubmodelElement, AasRepositoryService.Result>>;
|
|
553
|
+
/**
|
|
554
|
+
* Deletes a submodel element at a specified path within the submodel elements hierarchy
|
|
555
|
+
*
|
|
556
|
+
* @param options Object containing:
|
|
557
|
+
* - configuration: The http request options.
|
|
558
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
559
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
560
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
561
|
+
*
|
|
562
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
563
|
+
*/
|
|
564
|
+
deleteSubmodelElementByPathAasRepository(options: {
|
|
565
|
+
configuration: AasRepositoryService.Configuration;
|
|
566
|
+
aasIdentifier: string;
|
|
567
|
+
submodelIdentifier: string;
|
|
568
|
+
idShortPath: string;
|
|
569
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
570
|
+
/**
|
|
571
|
+
* Updates an existing submodel element at a specified path within submodel elements hierarchy
|
|
572
|
+
*
|
|
573
|
+
* @param options Object containing:
|
|
574
|
+
* - configuration: The http request options
|
|
575
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
576
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
577
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
578
|
+
* - submodelElement: SubmodelElement object
|
|
579
|
+
*
|
|
580
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
581
|
+
*/
|
|
582
|
+
putSubmodelElementByPathAasRepository(options: {
|
|
583
|
+
configuration: AasRepositoryService.Configuration;
|
|
584
|
+
aasIdentifier: string;
|
|
585
|
+
submodelIdentifier: string;
|
|
586
|
+
idShortPath: string;
|
|
587
|
+
submodelElement: ISubmodelElement;
|
|
588
|
+
}): Promise<ApiResult<ISubmodelElement | void, AasRepositoryService.Result>>;
|
|
589
|
+
/**
|
|
590
|
+
* Updates an existing submodel element value at a specified path within submodel elements hierarchy
|
|
591
|
+
*
|
|
592
|
+
* @param options Object containing:
|
|
593
|
+
* - configuration: The http request options
|
|
594
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
595
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
596
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
597
|
+
* - submodelElement: SubmodelElement object
|
|
598
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
599
|
+
*
|
|
600
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
601
|
+
*/
|
|
602
|
+
patchSubmodelElementValueByPathAasRepository(options: {
|
|
603
|
+
configuration: AasRepositoryService.Configuration;
|
|
604
|
+
aasIdentifier: string;
|
|
605
|
+
submodelIdentifier: string;
|
|
606
|
+
idShortPath: string;
|
|
607
|
+
submodelElement: ISubmodelElement;
|
|
608
|
+
level?: AasRepositoryService.PatchSubmodelElementValueByPathAasRepositoryLevelEnum;
|
|
609
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
610
|
+
/**
|
|
611
|
+
* Returns the metadata attributes of a specific submodel element from the Submodel at a specified path
|
|
612
|
+
*
|
|
613
|
+
* @param options Object containing:
|
|
614
|
+
* - configuration: The http request options
|
|
615
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
616
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
617
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
618
|
+
*
|
|
619
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
620
|
+
*/
|
|
621
|
+
getSubmodelElementByPathMetadataAasRepository(options: {
|
|
622
|
+
configuration: AasRepositoryService.Configuration;
|
|
623
|
+
aasIdentifier: string;
|
|
624
|
+
submodelIdentifier: string;
|
|
625
|
+
idShortPath: string;
|
|
626
|
+
}): Promise<ApiResult<AasRepositoryService.SubmodelElementMetadata, AasRepositoryService.Result>>;
|
|
627
|
+
/**
|
|
628
|
+
* Updates the metadata attributes of an existing submodel element value at a specified path within submodel elements hierarchy
|
|
629
|
+
*
|
|
630
|
+
* @param options Object containing:
|
|
631
|
+
* - configuration: The http request options
|
|
632
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
633
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
634
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
635
|
+
* - submodelElementMetadata: The Submodel Element Metadata object
|
|
636
|
+
*
|
|
637
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
638
|
+
*/
|
|
639
|
+
patchSubmodelElementValueByPathMetadata(options: {
|
|
640
|
+
configuration: AasRepositoryService.Configuration;
|
|
641
|
+
aasIdentifier: string;
|
|
642
|
+
submodelIdentifier: string;
|
|
643
|
+
idShortPath: string;
|
|
644
|
+
submodelElementMetadata: AasRepositoryService.SubmodelElementMetadata;
|
|
645
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
646
|
+
/**
|
|
647
|
+
* Returns a specific submodel element from the Submodel at a specified path in the ValueOnly representation
|
|
648
|
+
*
|
|
649
|
+
* @param options Object containing:
|
|
650
|
+
* - configuration: The http request options
|
|
651
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
652
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
653
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
654
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
655
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
656
|
+
*
|
|
657
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
658
|
+
*/
|
|
659
|
+
getSubmodelElementByPathValueOnlyAasRepository(options: {
|
|
660
|
+
configuration: AasRepositoryService.Configuration;
|
|
661
|
+
aasIdentifier: string;
|
|
662
|
+
submodelIdentifier: string;
|
|
663
|
+
idShortPath: string;
|
|
664
|
+
level?: AasRepositoryService.GetSubmodelElementByPathValueOnlyAasRepositoryLevelEnum;
|
|
665
|
+
extent?: AasRepositoryService.GetSubmodelElementByPathValueOnlyAasRepositoryExtentEnum;
|
|
666
|
+
}): Promise<ApiResult<AasRepositoryService.SubmodelElementValue, AasRepositoryService.Result>>;
|
|
667
|
+
/**
|
|
668
|
+
* Updates the value of an existing submodel element value at a specified path within submodel elements hierarchy
|
|
669
|
+
*
|
|
670
|
+
* @param options Object containing:
|
|
671
|
+
* - configuration: The http request options
|
|
672
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
673
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
674
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
675
|
+
* - SubmodelElementValue: SubmodelElementValue object
|
|
676
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
677
|
+
*
|
|
678
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
679
|
+
*/
|
|
680
|
+
patchSubmodelElementValueByPathValueOnly(options: {
|
|
681
|
+
configuration: AasRepositoryService.Configuration;
|
|
682
|
+
aasIdentifier: string;
|
|
683
|
+
submodelIdentifier: string;
|
|
684
|
+
idShortPath: string;
|
|
685
|
+
submodelElementValue: AasRepositoryService.SubmodelElementValue;
|
|
686
|
+
level?: AasRepositoryService.PatchSubmodelElementValueByPathValueOnlyLevelEnum;
|
|
687
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
688
|
+
/**
|
|
689
|
+
* Returns the Reference of a specific submodel element from the Submodel at a specified path
|
|
690
|
+
*
|
|
691
|
+
* @param options Object containing:
|
|
692
|
+
* - configuration: The http request options
|
|
693
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
694
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
695
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
696
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
697
|
+
*
|
|
698
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
699
|
+
*/
|
|
700
|
+
getSubmodelElementByPathReferenceAasRepository(options: {
|
|
701
|
+
configuration: AasRepositoryService.Configuration;
|
|
702
|
+
aasIdentifier: string;
|
|
703
|
+
submodelIdentifier: string;
|
|
704
|
+
idShortPath: string;
|
|
705
|
+
level?: AasRepositoryService.GetSubmodelElementByPathReferenceAasRepositoryLevelEnum;
|
|
706
|
+
}): Promise<ApiResult<Reference, AasRepositoryService.Result>>;
|
|
707
|
+
/**
|
|
708
|
+
* Returns a specific submodel element from the Submodel at a specified path in the Path notation
|
|
709
|
+
*
|
|
710
|
+
* @param options Object containing:
|
|
711
|
+
* - configuration: The http request options
|
|
712
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
713
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
714
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
715
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
716
|
+
*
|
|
717
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
718
|
+
*/
|
|
719
|
+
getSubmodelElementByPathPathAasRepository(options: {
|
|
720
|
+
configuration: AasRepositoryService.Configuration;
|
|
721
|
+
aasIdentifier: string;
|
|
722
|
+
submodelIdentifier: string;
|
|
723
|
+
idShortPath: string;
|
|
724
|
+
level?: AasRepositoryService.GetSubmodelElementByPathPathAasRepositoryLevelEnum;
|
|
725
|
+
}): Promise<ApiResult<Array<string>, AasRepositoryService.Result>>;
|
|
726
|
+
/**
|
|
727
|
+
* Downloads file content from a specific submodel element from the Submodel at a specified path
|
|
728
|
+
*
|
|
729
|
+
* @param options Object containing:
|
|
730
|
+
* - configuration: The http request options
|
|
731
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
732
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
733
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
734
|
+
*
|
|
735
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
736
|
+
*/
|
|
737
|
+
getFileByPathAasRepository(options: {
|
|
738
|
+
configuration: AasRepositoryService.Configuration;
|
|
739
|
+
aasIdentifier: string;
|
|
740
|
+
submodelIdentifier: string;
|
|
741
|
+
idShortPath: string;
|
|
742
|
+
}): Promise<ApiResult<Blob, AasRepositoryService.Result>>;
|
|
743
|
+
/**
|
|
744
|
+
* Uploads file content to an existing submodel element at a specified path within submodel elements hierarchy
|
|
745
|
+
*
|
|
746
|
+
* @param options Object containing:
|
|
747
|
+
* - configuration: The http request options
|
|
748
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
749
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
750
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
751
|
+
* - fileName: The name of the file
|
|
752
|
+
* - file: The file to upload
|
|
753
|
+
*
|
|
754
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
755
|
+
*/
|
|
756
|
+
putFileByPathAasRepository(options: {
|
|
757
|
+
configuration: AasRepositoryService.Configuration;
|
|
758
|
+
aasIdentifier: string;
|
|
759
|
+
submodelIdentifier: string;
|
|
760
|
+
idShortPath: string;
|
|
761
|
+
fileName: string;
|
|
762
|
+
file: Blob;
|
|
763
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
764
|
+
/**
|
|
765
|
+
* Deletes file content of an existing submodel element at a specified path within submodel elements hierarchy
|
|
766
|
+
*
|
|
767
|
+
* @param options Object containing:
|
|
768
|
+
* - configuration: The http request options.
|
|
769
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
770
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
771
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
772
|
+
*
|
|
773
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
774
|
+
*/
|
|
775
|
+
deleteFileByPathAasRepository(options: {
|
|
776
|
+
configuration: AasRepositoryService.Configuration;
|
|
777
|
+
aasIdentifier: string;
|
|
778
|
+
submodelIdentifier: string;
|
|
779
|
+
idShortPath: string;
|
|
780
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
781
|
+
/**
|
|
782
|
+
* Synchronously invokes an Operation at a specified path
|
|
783
|
+
*
|
|
784
|
+
* @param options Object containing:
|
|
785
|
+
* - configuration: The http request options.
|
|
786
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
787
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
788
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
789
|
+
* - operationRequest: Operation request object
|
|
790
|
+
*
|
|
791
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
792
|
+
*/
|
|
793
|
+
invokeOperationAasRepository(options: {
|
|
794
|
+
configuration: AasRepositoryService.Configuration;
|
|
795
|
+
aasIdentifier: string;
|
|
796
|
+
submodelIdentifier: string;
|
|
797
|
+
idShortPath: string;
|
|
798
|
+
operationRequest: AasRepositoryService.OperationRequest;
|
|
799
|
+
}): Promise<ApiResult<AasRepositoryService.OperationResult, AasRepositoryService.Result>>;
|
|
800
|
+
/**
|
|
801
|
+
* Synchronously invokes an Operation at a specified path
|
|
802
|
+
*
|
|
803
|
+
* @param options Object containing:
|
|
804
|
+
* - configuration: The http request options.
|
|
805
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
806
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
807
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
808
|
+
* - operationRequestValueOnly: OperationRequestValueOnly object
|
|
809
|
+
*
|
|
810
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
811
|
+
*/
|
|
812
|
+
invokeOperationValueOnlyAasRepository(options: {
|
|
813
|
+
configuration: AasRepositoryService.Configuration;
|
|
814
|
+
aasIdentifier: string;
|
|
815
|
+
submodelIdentifier: string;
|
|
816
|
+
idShortPath: string;
|
|
817
|
+
operationRequestValueOnly: AasRepositoryService.OperationRequestValueOnly;
|
|
818
|
+
}): Promise<ApiResult<AasRepositoryService.OperationResultValueOnly, AasRepositoryService.Result>>;
|
|
819
|
+
/**
|
|
820
|
+
* Asynchronously invokes an Operation at a specified path
|
|
821
|
+
*
|
|
822
|
+
* @param options Object containing:
|
|
823
|
+
* - configuration: The http request options.
|
|
824
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
825
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
826
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
827
|
+
* - operationRequest: OperationRequest object
|
|
828
|
+
*
|
|
829
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
830
|
+
*/
|
|
831
|
+
invokeOperationAsyncAasRepository(options: {
|
|
832
|
+
configuration: AasRepositoryService.Configuration;
|
|
833
|
+
aasIdentifier: string;
|
|
834
|
+
submodelIdentifier: string;
|
|
835
|
+
idShortPath: string;
|
|
836
|
+
operationRequest: AasRepositoryService.OperationRequest;
|
|
837
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
838
|
+
/**
|
|
839
|
+
* Asynchronously invokes an Operation at a specified path
|
|
840
|
+
*
|
|
841
|
+
* @param options Object containing:
|
|
842
|
+
* - configuration: The http request options.
|
|
843
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
|
|
844
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
845
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
846
|
+
* - operationRequestValueOnly: Operation request object
|
|
847
|
+
*
|
|
848
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
849
|
+
*/
|
|
850
|
+
invokeOperationAsyncValueOnlyAasRepository(options: {
|
|
851
|
+
configuration: AasRepositoryService.Configuration;
|
|
852
|
+
aasIdentifier: string;
|
|
853
|
+
submodelIdentifier: string;
|
|
854
|
+
idShortPath: string;
|
|
855
|
+
operationRequestValueOnly: AasRepositoryService.OperationRequestValueOnly;
|
|
856
|
+
}): Promise<ApiResult<void, AasRepositoryService.Result>>;
|
|
857
|
+
/**
|
|
858
|
+
* Returns the Operation status of an asynchronous invoked Operation
|
|
859
|
+
*
|
|
860
|
+
* @param options Object containing:
|
|
861
|
+
* - configuration: The http request options
|
|
862
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
863
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
864
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
865
|
+
* - handleId: 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)
|
|
866
|
+
*
|
|
867
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
868
|
+
*/
|
|
869
|
+
getOperationAsyncStatusAasRepository(options: {
|
|
870
|
+
configuration: AasRepositoryService.Configuration;
|
|
871
|
+
aasIdentifier: string;
|
|
872
|
+
submodelIdentifier: string;
|
|
873
|
+
idShortPath: string;
|
|
874
|
+
handleId: string;
|
|
875
|
+
}): Promise<ApiResult<AasRepositoryService.BaseOperationResult, AasRepositoryService.Result>>;
|
|
876
|
+
/**
|
|
877
|
+
* Returns the Operation result of an asynchronous invoked Operation
|
|
878
|
+
*
|
|
879
|
+
* @param options Object containing:
|
|
880
|
+
* - configuration: The http request options
|
|
881
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
882
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
883
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
884
|
+
* - handleId: 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)
|
|
885
|
+
*
|
|
886
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
887
|
+
*/
|
|
888
|
+
getOperationAsyncResultAasRepository(options: {
|
|
889
|
+
configuration: AasRepositoryService.Configuration;
|
|
890
|
+
aasIdentifier: string;
|
|
891
|
+
submodelIdentifier: string;
|
|
892
|
+
idShortPath: string;
|
|
893
|
+
handleId: string;
|
|
894
|
+
}): Promise<ApiResult<AasRepositoryService.OperationResult, AasRepositoryService.Result>>;
|
|
895
|
+
/**
|
|
896
|
+
* Returns the ValueOnly notation of the Operation result of an asynchronous invoked Operation
|
|
897
|
+
*
|
|
898
|
+
* @param options Object containing:
|
|
899
|
+
* - configuration: The http request options
|
|
900
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id
|
|
901
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
902
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
903
|
+
* - handleId: 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)
|
|
904
|
+
*
|
|
905
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
906
|
+
*/
|
|
907
|
+
getOperationAsyncResultValueOnlyAasRepository(options: {
|
|
908
|
+
configuration: AasRepositoryService.Configuration;
|
|
909
|
+
aasIdentifier: string;
|
|
910
|
+
submodelIdentifier: string;
|
|
911
|
+
idShortPath: string;
|
|
912
|
+
handleId: string;
|
|
913
|
+
}): Promise<ApiResult<AasRepositoryService.OperationResultValueOnly, AasRepositoryService.Result>>;
|
|
227
914
|
}
|