basyx-typescript-sdk 0.2.1 → 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 +17522 -841
- 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 -211
- 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
|
@@ -0,0 +1,354 @@
|
|
|
1
|
+
import type { ISubmodelElement, Submodel } from '@aas-core-works/aas-core3.0-typescript/types';
|
|
2
|
+
import type { ApiResult } from '../models/api';
|
|
3
|
+
import { SubmodelRepositoryService } from '../generated';
|
|
4
|
+
export declare class SubmodelRepositoryClient {
|
|
5
|
+
/**
|
|
6
|
+
* Returns all Submodels
|
|
7
|
+
*
|
|
8
|
+
* @param options Object containing:
|
|
9
|
+
* - configuration: The http request options
|
|
10
|
+
* - semanticId?: The value of the semantic id reference
|
|
11
|
+
* - idShort?: The Asset Administration Shell's IdShort
|
|
12
|
+
* - limit?: The maximum number of elements in the response array
|
|
13
|
+
* - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
|
|
14
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
15
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
16
|
+
*
|
|
17
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
18
|
+
*/
|
|
19
|
+
getAllSubmodels(options: {
|
|
20
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
21
|
+
semanticId?: string;
|
|
22
|
+
idShort?: string;
|
|
23
|
+
limit?: number;
|
|
24
|
+
cursor?: string;
|
|
25
|
+
level?: SubmodelRepositoryService.GetAllSubmodelsLevelEnum;
|
|
26
|
+
extent?: SubmodelRepositoryService.GetAllSubmodelsExtentEnum;
|
|
27
|
+
}): Promise<ApiResult<{
|
|
28
|
+
pagedResult: SubmodelRepositoryService.PagedResultPagingMetadata | undefined;
|
|
29
|
+
result: Submodel[];
|
|
30
|
+
}, SubmodelRepositoryService.Result>>;
|
|
31
|
+
/**
|
|
32
|
+
* Creates a new Submodel
|
|
33
|
+
*
|
|
34
|
+
* @param options Object containing:
|
|
35
|
+
* - configuration: The http request options.
|
|
36
|
+
* - submodel: Submodel object
|
|
37
|
+
*
|
|
38
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
39
|
+
*/
|
|
40
|
+
postSubmodel(options: {
|
|
41
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
42
|
+
submodel: Submodel;
|
|
43
|
+
}): Promise<ApiResult<Submodel, SubmodelRepositoryService.Result>>;
|
|
44
|
+
/**
|
|
45
|
+
* Deletes a Submodel
|
|
46
|
+
*
|
|
47
|
+
* @param options Object containing:
|
|
48
|
+
* - configuration: The http request options
|
|
49
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
50
|
+
*
|
|
51
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
52
|
+
*/
|
|
53
|
+
deleteSubmodelById(options: {
|
|
54
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
55
|
+
submodelIdentifier: string;
|
|
56
|
+
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
57
|
+
/**
|
|
58
|
+
* Returns a specific Submodel
|
|
59
|
+
*
|
|
60
|
+
* @param options Object containing:
|
|
61
|
+
* - configuration: The http request options
|
|
62
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
63
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
64
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
65
|
+
*
|
|
66
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
67
|
+
*/
|
|
68
|
+
getSubmodelById(options: {
|
|
69
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
70
|
+
submodelIdentifier: string;
|
|
71
|
+
level?: SubmodelRepositoryService.GetSubmodelByIdLevelEnum;
|
|
72
|
+
extent?: SubmodelRepositoryService.GetSubmodelByIdExtentEnum;
|
|
73
|
+
}): Promise<ApiResult<Submodel, SubmodelRepositoryService.Result>>;
|
|
74
|
+
/**
|
|
75
|
+
* Updates an existing Submodel
|
|
76
|
+
*
|
|
77
|
+
* @param options Object containing:
|
|
78
|
+
* - configuration: The http request options
|
|
79
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
80
|
+
* - submodel: Submodel object
|
|
81
|
+
*
|
|
82
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
83
|
+
*/
|
|
84
|
+
putSubmodelById(options: {
|
|
85
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
86
|
+
submodelIdentifier: string;
|
|
87
|
+
submodel: Submodel;
|
|
88
|
+
}): Promise<ApiResult<Submodel | void, SubmodelRepositoryService.Result>>;
|
|
89
|
+
/**
|
|
90
|
+
* Returns all submodel elements including their hierarchy
|
|
91
|
+
*
|
|
92
|
+
* @param options Object containing:
|
|
93
|
+
* - configuration: The http request options
|
|
94
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
95
|
+
* - limit?: The maximum number of elements in the response array
|
|
96
|
+
* - cursor?: A server-generated identifier retrieved from pagingMetadata that specifies from which position the result listing should continue
|
|
97
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
98
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
99
|
+
*
|
|
100
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
101
|
+
*/
|
|
102
|
+
getAllSubmodelElements(options: {
|
|
103
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
104
|
+
submodelIdentifier: string;
|
|
105
|
+
limit?: number;
|
|
106
|
+
cursor?: string;
|
|
107
|
+
level?: SubmodelRepositoryService.GetAllSubmodelElementsLevelEnum;
|
|
108
|
+
extent?: SubmodelRepositoryService.GetAllSubmodelElementsExtentEnum;
|
|
109
|
+
}): Promise<ApiResult<{
|
|
110
|
+
pagedResult: SubmodelRepositoryService.PagedResultPagingMetadata | undefined;
|
|
111
|
+
result: ISubmodelElement[];
|
|
112
|
+
}, SubmodelRepositoryService.Result>>;
|
|
113
|
+
/**
|
|
114
|
+
* Creates a new submodel element
|
|
115
|
+
*
|
|
116
|
+
* @param options Object containing:
|
|
117
|
+
* - configuration: The http request options
|
|
118
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
119
|
+
*
|
|
120
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
121
|
+
*/
|
|
122
|
+
postSubmodelElement(options: {
|
|
123
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
124
|
+
submodelIdentifier: string;
|
|
125
|
+
submodelElement: ISubmodelElement;
|
|
126
|
+
}): Promise<ApiResult<ISubmodelElement, SubmodelRepositoryService.Result>>;
|
|
127
|
+
/**
|
|
128
|
+
* Returns a specific submodel element from the Submodel at a specified path
|
|
129
|
+
*
|
|
130
|
+
* @param options Object containing:
|
|
131
|
+
* - configuration: The http request options
|
|
132
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
133
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
134
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
135
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
136
|
+
*
|
|
137
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
138
|
+
*/
|
|
139
|
+
getSubmodelElementByPath(options: {
|
|
140
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
141
|
+
submodelIdentifier: string;
|
|
142
|
+
idShortPath: string;
|
|
143
|
+
level?: SubmodelRepositoryService.GetSubmodelElementByPathSubmodelRepoLevelEnum;
|
|
144
|
+
extent?: SubmodelRepositoryService.GetSubmodelElementByPathSubmodelRepoExtentEnum;
|
|
145
|
+
}): Promise<ApiResult<ISubmodelElement, SubmodelRepositoryService.Result>>;
|
|
146
|
+
/**
|
|
147
|
+
* Creates a new submodel element at a specified path within submodel elements hierarchy
|
|
148
|
+
*
|
|
149
|
+
* @param options Object containing:
|
|
150
|
+
* - configuration: The http request options.
|
|
151
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
152
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
153
|
+
* - submodelElement: SubmodelElement object
|
|
154
|
+
*
|
|
155
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
156
|
+
*/
|
|
157
|
+
postSubmodelElementByPath(options: {
|
|
158
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
159
|
+
submodelIdentifier: string;
|
|
160
|
+
idShortPath: string;
|
|
161
|
+
submodelElement: ISubmodelElement;
|
|
162
|
+
}): Promise<ApiResult<ISubmodelElement, SubmodelRepositoryService.Result>>;
|
|
163
|
+
/**
|
|
164
|
+
* Deletes a submodel element at a specified path within the submodel elements hierarchy
|
|
165
|
+
*
|
|
166
|
+
* @param options Object containing:
|
|
167
|
+
* - configuration: The http request options.
|
|
168
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
169
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
170
|
+
*
|
|
171
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
172
|
+
*/
|
|
173
|
+
deleteSubmodelElementByPath(options: {
|
|
174
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
175
|
+
submodelIdentifier: string;
|
|
176
|
+
idShortPath: string;
|
|
177
|
+
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
178
|
+
/**
|
|
179
|
+
* Updates an existing submodel element at a specified path within submodel elements hierarchy
|
|
180
|
+
*
|
|
181
|
+
* @param options Object containing:
|
|
182
|
+
* - configuration: The http request options
|
|
183
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
184
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
185
|
+
* - submodelElement: SubmodelElement object
|
|
186
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
187
|
+
*
|
|
188
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
189
|
+
*/
|
|
190
|
+
putSubmodelElementByPath(options: {
|
|
191
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
192
|
+
submodelIdentifier: string;
|
|
193
|
+
idShortPath: string;
|
|
194
|
+
submodelElement: ISubmodelElement;
|
|
195
|
+
level?: SubmodelRepositoryService.PutSubmodelElementByPathSubmodelRepoLevelEnum;
|
|
196
|
+
}): Promise<ApiResult<ISubmodelElement | void, SubmodelRepositoryService.Result>>;
|
|
197
|
+
/**
|
|
198
|
+
* Returns the metadata attributes of a specific Submodel
|
|
199
|
+
*
|
|
200
|
+
* @param options Object containing:
|
|
201
|
+
* - configuration: The http request options
|
|
202
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
203
|
+
*
|
|
204
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
205
|
+
*/
|
|
206
|
+
getSubmodelByIdMetadata(options: {
|
|
207
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
208
|
+
submodelIdentifier: string;
|
|
209
|
+
}): Promise<ApiResult<SubmodelRepositoryService.SubmodelMetadata, SubmodelRepositoryService.Result>>;
|
|
210
|
+
/**
|
|
211
|
+
* Returns a specific Submodel in the ValueOnly representation
|
|
212
|
+
*
|
|
213
|
+
* @param options Object containing:
|
|
214
|
+
* - configuration: The http request options
|
|
215
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
216
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
217
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
218
|
+
*
|
|
219
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
220
|
+
*/
|
|
221
|
+
getSubmodelByIdValueOnly(options: {
|
|
222
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
223
|
+
submodelIdentifier: string;
|
|
224
|
+
level?: SubmodelRepositoryService.GetSubmodelByIdValueOnlyLevelEnum;
|
|
225
|
+
extent?: SubmodelRepositoryService.GetSubmodelByIdValueOnlyExtentEnum;
|
|
226
|
+
}): Promise<ApiResult<object, SubmodelRepositoryService.Result>>;
|
|
227
|
+
/**
|
|
228
|
+
// * Updates the values of an existing Submodel
|
|
229
|
+
// *
|
|
230
|
+
// * @param options Object containing:
|
|
231
|
+
// * - configuration: The http request options
|
|
232
|
+
// * - submodelIdentifier: The Submodel’s unique id
|
|
233
|
+
// * - level?: Determines the structural depth of the respective resource content
|
|
234
|
+
// *
|
|
235
|
+
// * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
236
|
+
// */
|
|
237
|
+
patchSubmodelByIdValueOnly(options: {
|
|
238
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
239
|
+
submodelIdentifier: string;
|
|
240
|
+
body: object;
|
|
241
|
+
level?: SubmodelRepositoryService.PatchSubmodelByIdValueOnlyLevelEnum;
|
|
242
|
+
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
243
|
+
/**
|
|
244
|
+
* Returns a specific submodel element from the Submodel at a specified path in the ValueOnly representation
|
|
245
|
+
*
|
|
246
|
+
* @param options Object containing:
|
|
247
|
+
* - configuration: The http request options
|
|
248
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
249
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
250
|
+
* - level?: Determines the structural depth of the respective resource content
|
|
251
|
+
* - extent?: Determines to which extent the resource is being serialized
|
|
252
|
+
*
|
|
253
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
254
|
+
*/
|
|
255
|
+
getSubmodelElementByPathValueOnly(options: {
|
|
256
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
257
|
+
submodelIdentifier: string;
|
|
258
|
+
idShortPath: string;
|
|
259
|
+
level?: SubmodelRepositoryService.GetSubmodelElementByPathValueOnlySubmodelRepoLevelEnum;
|
|
260
|
+
extent?: SubmodelRepositoryService.GetSubmodelElementByPathValueOnlySubmodelRepoExtentEnum;
|
|
261
|
+
}): Promise<ApiResult<SubmodelRepositoryService.SubmodelElementValue, SubmodelRepositoryService.Result>>;
|
|
262
|
+
/**
|
|
263
|
+
// * Updates the value of an existing SubmodelElement
|
|
264
|
+
// *
|
|
265
|
+
// * @param options Object containing:
|
|
266
|
+
// * - configuration: The http request options
|
|
267
|
+
// * - submodelIdentifier: The Submodel’s unique id
|
|
268
|
+
// * - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
269
|
+
// * - submodelElementValue: SubmodelElementValue object
|
|
270
|
+
// * - level?: Determines the structural depth of the respective resource content
|
|
271
|
+
// *
|
|
272
|
+
// * @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
273
|
+
// */
|
|
274
|
+
patchSubmodelElementByPathValueOnly(options: {
|
|
275
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
276
|
+
submodelIdentifier: string;
|
|
277
|
+
idShortPath: string;
|
|
278
|
+
submodelElementValue: SubmodelRepositoryService.SubmodelElementValue;
|
|
279
|
+
level?: SubmodelRepositoryService.PatchSubmodelElementByPathValueOnlySubmodelRepoLevelEnum;
|
|
280
|
+
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
281
|
+
/**
|
|
282
|
+
* Synchronously invokes an Operation at a specified path
|
|
283
|
+
*
|
|
284
|
+
* @param options Object containing:
|
|
285
|
+
* - configuration: The http request options.
|
|
286
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
287
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
288
|
+
* - operationRequest: Operation request object
|
|
289
|
+
* - async?: Determines whether an operation invocation is performed asynchronously or synchronously
|
|
290
|
+
*
|
|
291
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
292
|
+
*/
|
|
293
|
+
postInvokeOperationSubmodelRepo(options: {
|
|
294
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
295
|
+
submodelIdentifier: string;
|
|
296
|
+
idShortPath: string;
|
|
297
|
+
operationRequest: SubmodelRepositoryService.OperationRequest;
|
|
298
|
+
}): Promise<ApiResult<SubmodelRepositoryService.OperationResult, SubmodelRepositoryService.Result>>;
|
|
299
|
+
/**
|
|
300
|
+
* Synchronously invokes an Operation at a specified path
|
|
301
|
+
*
|
|
302
|
+
* @param options Object containing:
|
|
303
|
+
* - configuration: The http request options.
|
|
304
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
|
|
305
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
306
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
307
|
+
* - operationRequestValueOnly: Operation request object
|
|
308
|
+
*
|
|
309
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
310
|
+
*/
|
|
311
|
+
postInvokeOperationValueOnly(options: {
|
|
312
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
313
|
+
aasIdentifier: string;
|
|
314
|
+
submodelIdentifier: string;
|
|
315
|
+
idShortPath: string;
|
|
316
|
+
operationRequestValueOnly: SubmodelRepositoryService.OperationRequestValueOnly;
|
|
317
|
+
}): Promise<ApiResult<SubmodelRepositoryService.OperationResultValueOnly, SubmodelRepositoryService.Result>>;
|
|
318
|
+
/**
|
|
319
|
+
* Asynchronously invokes an Operation at a specified path
|
|
320
|
+
*
|
|
321
|
+
* @param options Object containing:
|
|
322
|
+
* - configuration: The http request options.
|
|
323
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
324
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
325
|
+
* - operationRequest: Operation request object
|
|
326
|
+
*
|
|
327
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
328
|
+
*/
|
|
329
|
+
postInvokeOperationAsync(options: {
|
|
330
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
331
|
+
submodelIdentifier: string;
|
|
332
|
+
idShortPath: string;
|
|
333
|
+
operationRequest: SubmodelRepositoryService.OperationRequest;
|
|
334
|
+
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
335
|
+
/**
|
|
336
|
+
* Asynchronously invokes an Operation at a specified path
|
|
337
|
+
*
|
|
338
|
+
* @param options Object containing:
|
|
339
|
+
* - configuration: The http request options.
|
|
340
|
+
* - aasIdentifier: The Asset Administration Shell’s unique id (UTF8-BASE64-URL-encoded)
|
|
341
|
+
* - submodelIdentifier: The Submodel’s unique id
|
|
342
|
+
* - idShortPath: IdShort path to the submodel element (dot-separated)
|
|
343
|
+
* - operationRequestValueOnly: Operation request object
|
|
344
|
+
*
|
|
345
|
+
* @returns Either `{ success: true; data: ... }` or `{ success: false; error: ... }`.
|
|
346
|
+
*/
|
|
347
|
+
postInvokeOperationAsyncValueOnly(options: {
|
|
348
|
+
configuration: SubmodelRepositoryService.Configuration;
|
|
349
|
+
aasIdentifier: string;
|
|
350
|
+
submodelIdentifier: string;
|
|
351
|
+
idShortPath: string;
|
|
352
|
+
operationRequestValueOnly: SubmodelRepositoryService.OperationRequestValueOnly;
|
|
353
|
+
}): Promise<ApiResult<void, SubmodelRepositoryService.Result>>;
|
|
354
|
+
}
|