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,312 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* DotAAS Part 2 | HTTP/REST | Asset Administration Shell Registry Service Specification
|
|
5
|
+
* The Full Profile of the Asset Administration Shell Registry Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). Copyright: Industrial Digital Twin Association (IDTA) 2025
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: V3.1.0_SSP-001
|
|
8
|
+
* Contact: info@idtwin.org
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import * as runtime from '../runtime';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
*/
|
|
18
|
+
export class AssetAdministrationShellRegistryAPIApi extends runtime.BaseAPI {
|
|
19
|
+
/**
|
|
20
|
+
* Deletes an Asset Administration Shell Descriptor, i.e. de-registers an AAS
|
|
21
|
+
*/
|
|
22
|
+
async deleteAssetAdministrationShellDescriptorByIdRaw(requestParameters, initOverrides) {
|
|
23
|
+
if (requestParameters['aasIdentifier'] == null) {
|
|
24
|
+
throw new runtime.RequiredError('aasIdentifier', 'Required parameter "aasIdentifier" was null or undefined when calling deleteAssetAdministrationShellDescriptorById().');
|
|
25
|
+
}
|
|
26
|
+
const queryParameters = {};
|
|
27
|
+
const headerParameters = {};
|
|
28
|
+
const response = await this.request({
|
|
29
|
+
path: `/shell-descriptors/{aasIdentifier}`.replace(`{${"aasIdentifier"}}`, encodeURIComponent(String(requestParameters['aasIdentifier']))),
|
|
30
|
+
method: 'DELETE',
|
|
31
|
+
headers: headerParameters,
|
|
32
|
+
query: queryParameters,
|
|
33
|
+
}, initOverrides);
|
|
34
|
+
return new runtime.VoidApiResponse(response);
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* Deletes an Asset Administration Shell Descriptor, i.e. de-registers an AAS
|
|
38
|
+
*/
|
|
39
|
+
async deleteAssetAdministrationShellDescriptorById(requestParameters, initOverrides) {
|
|
40
|
+
await this.deleteAssetAdministrationShellDescriptorByIdRaw(requestParameters, initOverrides);
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Deletes a Submodel Descriptor, i.e. de-registers a submodel
|
|
44
|
+
*/
|
|
45
|
+
async deleteSubmodelDescriptorByIdThroughSuperpathRaw(requestParameters, initOverrides) {
|
|
46
|
+
if (requestParameters['aasIdentifier'] == null) {
|
|
47
|
+
throw new runtime.RequiredError('aasIdentifier', 'Required parameter "aasIdentifier" was null or undefined when calling deleteSubmodelDescriptorByIdThroughSuperpath().');
|
|
48
|
+
}
|
|
49
|
+
if (requestParameters['submodelIdentifier'] == null) {
|
|
50
|
+
throw new runtime.RequiredError('submodelIdentifier', 'Required parameter "submodelIdentifier" was null or undefined when calling deleteSubmodelDescriptorByIdThroughSuperpath().');
|
|
51
|
+
}
|
|
52
|
+
const queryParameters = {};
|
|
53
|
+
const headerParameters = {};
|
|
54
|
+
const response = await this.request({
|
|
55
|
+
path: `/shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}`.replace(`{${"aasIdentifier"}}`, encodeURIComponent(String(requestParameters['aasIdentifier']))).replace(`{${"submodelIdentifier"}}`, encodeURIComponent(String(requestParameters['submodelIdentifier']))),
|
|
56
|
+
method: 'DELETE',
|
|
57
|
+
headers: headerParameters,
|
|
58
|
+
query: queryParameters,
|
|
59
|
+
}, initOverrides);
|
|
60
|
+
return new runtime.VoidApiResponse(response);
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Deletes a Submodel Descriptor, i.e. de-registers a submodel
|
|
64
|
+
*/
|
|
65
|
+
async deleteSubmodelDescriptorByIdThroughSuperpath(requestParameters, initOverrides) {
|
|
66
|
+
await this.deleteSubmodelDescriptorByIdThroughSuperpathRaw(requestParameters, initOverrides);
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Returns all Asset Administration Shell Descriptors
|
|
70
|
+
*/
|
|
71
|
+
async getAllAssetAdministrationShellDescriptorsRaw(requestParameters, initOverrides) {
|
|
72
|
+
const queryParameters = {};
|
|
73
|
+
if (requestParameters['limit'] != null) {
|
|
74
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
75
|
+
}
|
|
76
|
+
if (requestParameters['cursor'] != null) {
|
|
77
|
+
queryParameters['cursor'] = requestParameters['cursor'];
|
|
78
|
+
}
|
|
79
|
+
if (requestParameters['assetKind'] != null) {
|
|
80
|
+
queryParameters['assetKind'] = requestParameters['assetKind'];
|
|
81
|
+
}
|
|
82
|
+
if (requestParameters['assetType'] != null) {
|
|
83
|
+
queryParameters['assetType'] = requestParameters['assetType'];
|
|
84
|
+
}
|
|
85
|
+
const headerParameters = {};
|
|
86
|
+
const response = await this.request({
|
|
87
|
+
path: `/shell-descriptors`,
|
|
88
|
+
method: 'GET',
|
|
89
|
+
headers: headerParameters,
|
|
90
|
+
query: queryParameters,
|
|
91
|
+
}, initOverrides);
|
|
92
|
+
return new runtime.JSONApiResponse(response);
|
|
93
|
+
}
|
|
94
|
+
/**
|
|
95
|
+
* Returns all Asset Administration Shell Descriptors
|
|
96
|
+
*/
|
|
97
|
+
async getAllAssetAdministrationShellDescriptors(requestParameters = {}, initOverrides) {
|
|
98
|
+
const response = await this.getAllAssetAdministrationShellDescriptorsRaw(requestParameters, initOverrides);
|
|
99
|
+
return await response.value();
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Returns all Submodel Descriptors
|
|
103
|
+
*/
|
|
104
|
+
async getAllSubmodelDescriptorsThroughSuperpathRaw(requestParameters, initOverrides) {
|
|
105
|
+
if (requestParameters['aasIdentifier'] == null) {
|
|
106
|
+
throw new runtime.RequiredError('aasIdentifier', 'Required parameter "aasIdentifier" was null or undefined when calling getAllSubmodelDescriptorsThroughSuperpath().');
|
|
107
|
+
}
|
|
108
|
+
const queryParameters = {};
|
|
109
|
+
if (requestParameters['limit'] != null) {
|
|
110
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
111
|
+
}
|
|
112
|
+
if (requestParameters['cursor'] != null) {
|
|
113
|
+
queryParameters['cursor'] = requestParameters['cursor'];
|
|
114
|
+
}
|
|
115
|
+
const headerParameters = {};
|
|
116
|
+
const response = await this.request({
|
|
117
|
+
path: `/shell-descriptors/{aasIdentifier}/submodel-descriptors`.replace(`{${"aasIdentifier"}}`, encodeURIComponent(String(requestParameters['aasIdentifier']))),
|
|
118
|
+
method: 'GET',
|
|
119
|
+
headers: headerParameters,
|
|
120
|
+
query: queryParameters,
|
|
121
|
+
}, initOverrides);
|
|
122
|
+
return new runtime.JSONApiResponse(response);
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Returns all Submodel Descriptors
|
|
126
|
+
*/
|
|
127
|
+
async getAllSubmodelDescriptorsThroughSuperpath(requestParameters, initOverrides) {
|
|
128
|
+
const response = await this.getAllSubmodelDescriptorsThroughSuperpathRaw(requestParameters, initOverrides);
|
|
129
|
+
return await response.value();
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* Returns a specific Asset Administration Shell Descriptor
|
|
133
|
+
*/
|
|
134
|
+
async getAssetAdministrationShellDescriptorByIdRaw(requestParameters, initOverrides) {
|
|
135
|
+
if (requestParameters['aasIdentifier'] == null) {
|
|
136
|
+
throw new runtime.RequiredError('aasIdentifier', 'Required parameter "aasIdentifier" was null or undefined when calling getAssetAdministrationShellDescriptorById().');
|
|
137
|
+
}
|
|
138
|
+
const queryParameters = {};
|
|
139
|
+
const headerParameters = {};
|
|
140
|
+
const response = await this.request({
|
|
141
|
+
path: `/shell-descriptors/{aasIdentifier}`.replace(`{${"aasIdentifier"}}`, encodeURIComponent(String(requestParameters['aasIdentifier']))),
|
|
142
|
+
method: 'GET',
|
|
143
|
+
headers: headerParameters,
|
|
144
|
+
query: queryParameters,
|
|
145
|
+
}, initOverrides);
|
|
146
|
+
return new runtime.JSONApiResponse(response);
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Returns a specific Asset Administration Shell Descriptor
|
|
150
|
+
*/
|
|
151
|
+
async getAssetAdministrationShellDescriptorById(requestParameters, initOverrides) {
|
|
152
|
+
const response = await this.getAssetAdministrationShellDescriptorByIdRaw(requestParameters, initOverrides);
|
|
153
|
+
return await response.value();
|
|
154
|
+
}
|
|
155
|
+
/**
|
|
156
|
+
* Returns a specific Submodel Descriptor
|
|
157
|
+
*/
|
|
158
|
+
async getSubmodelDescriptorByIdThroughSuperpathRaw(requestParameters, initOverrides) {
|
|
159
|
+
if (requestParameters['aasIdentifier'] == null) {
|
|
160
|
+
throw new runtime.RequiredError('aasIdentifier', 'Required parameter "aasIdentifier" was null or undefined when calling getSubmodelDescriptorByIdThroughSuperpath().');
|
|
161
|
+
}
|
|
162
|
+
if (requestParameters['submodelIdentifier'] == null) {
|
|
163
|
+
throw new runtime.RequiredError('submodelIdentifier', 'Required parameter "submodelIdentifier" was null or undefined when calling getSubmodelDescriptorByIdThroughSuperpath().');
|
|
164
|
+
}
|
|
165
|
+
const queryParameters = {};
|
|
166
|
+
const headerParameters = {};
|
|
167
|
+
const response = await this.request({
|
|
168
|
+
path: `/shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}`.replace(`{${"aasIdentifier"}}`, encodeURIComponent(String(requestParameters['aasIdentifier']))).replace(`{${"submodelIdentifier"}}`, encodeURIComponent(String(requestParameters['submodelIdentifier']))),
|
|
169
|
+
method: 'GET',
|
|
170
|
+
headers: headerParameters,
|
|
171
|
+
query: queryParameters,
|
|
172
|
+
}, initOverrides);
|
|
173
|
+
return new runtime.JSONApiResponse(response);
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Returns a specific Submodel Descriptor
|
|
177
|
+
*/
|
|
178
|
+
async getSubmodelDescriptorByIdThroughSuperpath(requestParameters, initOverrides) {
|
|
179
|
+
const response = await this.getSubmodelDescriptorByIdThroughSuperpathRaw(requestParameters, initOverrides);
|
|
180
|
+
return await response.value();
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS
|
|
184
|
+
*/
|
|
185
|
+
async postAssetAdministrationShellDescriptorRaw(requestParameters, initOverrides) {
|
|
186
|
+
if (requestParameters['assetAdministrationShellDescriptor'] == null) {
|
|
187
|
+
throw new runtime.RequiredError('assetAdministrationShellDescriptor', 'Required parameter "assetAdministrationShellDescriptor" was null or undefined when calling postAssetAdministrationShellDescriptor().');
|
|
188
|
+
}
|
|
189
|
+
const queryParameters = {};
|
|
190
|
+
const headerParameters = {};
|
|
191
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
192
|
+
const response = await this.request({
|
|
193
|
+
path: `/shell-descriptors`,
|
|
194
|
+
method: 'POST',
|
|
195
|
+
headers: headerParameters,
|
|
196
|
+
query: queryParameters,
|
|
197
|
+
body: requestParameters['assetAdministrationShellDescriptor'],
|
|
198
|
+
}, initOverrides);
|
|
199
|
+
return new runtime.JSONApiResponse(response);
|
|
200
|
+
}
|
|
201
|
+
/**
|
|
202
|
+
* Creates a new Asset Administration Shell Descriptor, i.e. registers an AAS
|
|
203
|
+
*/
|
|
204
|
+
async postAssetAdministrationShellDescriptor(requestParameters, initOverrides) {
|
|
205
|
+
const response = await this.postAssetAdministrationShellDescriptorRaw(requestParameters, initOverrides);
|
|
206
|
+
return await response.value();
|
|
207
|
+
}
|
|
208
|
+
/**
|
|
209
|
+
* Creates a new Submodel Descriptor, i.e. registers a submodel
|
|
210
|
+
*/
|
|
211
|
+
async postSubmodelDescriptorThroughSuperpathRaw(requestParameters, initOverrides) {
|
|
212
|
+
if (requestParameters['aasIdentifier'] == null) {
|
|
213
|
+
throw new runtime.RequiredError('aasIdentifier', 'Required parameter "aasIdentifier" was null or undefined when calling postSubmodelDescriptorThroughSuperpath().');
|
|
214
|
+
}
|
|
215
|
+
if (requestParameters['submodelDescriptor'] == null) {
|
|
216
|
+
throw new runtime.RequiredError('submodelDescriptor', 'Required parameter "submodelDescriptor" was null or undefined when calling postSubmodelDescriptorThroughSuperpath().');
|
|
217
|
+
}
|
|
218
|
+
const queryParameters = {};
|
|
219
|
+
const headerParameters = {};
|
|
220
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
221
|
+
const response = await this.request({
|
|
222
|
+
path: `/shell-descriptors/{aasIdentifier}/submodel-descriptors`.replace(`{${"aasIdentifier"}}`, encodeURIComponent(String(requestParameters['aasIdentifier']))),
|
|
223
|
+
method: 'POST',
|
|
224
|
+
headers: headerParameters,
|
|
225
|
+
query: queryParameters,
|
|
226
|
+
body: requestParameters['submodelDescriptor'],
|
|
227
|
+
}, initOverrides);
|
|
228
|
+
return new runtime.JSONApiResponse(response);
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* Creates a new Submodel Descriptor, i.e. registers a submodel
|
|
232
|
+
*/
|
|
233
|
+
async postSubmodelDescriptorThroughSuperpath(requestParameters, initOverrides) {
|
|
234
|
+
const response = await this.postSubmodelDescriptorThroughSuperpathRaw(requestParameters, initOverrides);
|
|
235
|
+
return await response.value();
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* Creates or updates an existing Asset Administration Shell Descriptor
|
|
239
|
+
*/
|
|
240
|
+
async putAssetAdministrationShellDescriptorByIdRaw(requestParameters, initOverrides) {
|
|
241
|
+
if (requestParameters['aasIdentifier'] == null) {
|
|
242
|
+
throw new runtime.RequiredError('aasIdentifier', 'Required parameter "aasIdentifier" was null or undefined when calling putAssetAdministrationShellDescriptorById().');
|
|
243
|
+
}
|
|
244
|
+
if (requestParameters['assetAdministrationShellDescriptor'] == null) {
|
|
245
|
+
throw new runtime.RequiredError('assetAdministrationShellDescriptor', 'Required parameter "assetAdministrationShellDescriptor" was null or undefined when calling putAssetAdministrationShellDescriptorById().');
|
|
246
|
+
}
|
|
247
|
+
const queryParameters = {};
|
|
248
|
+
const headerParameters = {};
|
|
249
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
250
|
+
const response = await this.request({
|
|
251
|
+
path: `/shell-descriptors/{aasIdentifier}`.replace(`{${"aasIdentifier"}}`, encodeURIComponent(String(requestParameters['aasIdentifier']))),
|
|
252
|
+
method: 'PUT',
|
|
253
|
+
headers: headerParameters,
|
|
254
|
+
query: queryParameters,
|
|
255
|
+
body: requestParameters['assetAdministrationShellDescriptor'],
|
|
256
|
+
}, initOverrides);
|
|
257
|
+
return new runtime.JSONApiResponse(response);
|
|
258
|
+
}
|
|
259
|
+
/**
|
|
260
|
+
* Creates or updates an existing Asset Administration Shell Descriptor
|
|
261
|
+
*/
|
|
262
|
+
async putAssetAdministrationShellDescriptorById(requestParameters, initOverrides) {
|
|
263
|
+
const response = await this.putAssetAdministrationShellDescriptorByIdRaw(requestParameters, initOverrides);
|
|
264
|
+
switch (response.raw.status) {
|
|
265
|
+
case 201:
|
|
266
|
+
return await response.value();
|
|
267
|
+
case 204:
|
|
268
|
+
return null;
|
|
269
|
+
default:
|
|
270
|
+
return await response.value();
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
/**
|
|
274
|
+
* Creates or updates an existing Submodel Descriptor
|
|
275
|
+
*/
|
|
276
|
+
async putSubmodelDescriptorByIdThroughSuperpathRaw(requestParameters, initOverrides) {
|
|
277
|
+
if (requestParameters['aasIdentifier'] == null) {
|
|
278
|
+
throw new runtime.RequiredError('aasIdentifier', 'Required parameter "aasIdentifier" was null or undefined when calling putSubmodelDescriptorByIdThroughSuperpath().');
|
|
279
|
+
}
|
|
280
|
+
if (requestParameters['submodelIdentifier'] == null) {
|
|
281
|
+
throw new runtime.RequiredError('submodelIdentifier', 'Required parameter "submodelIdentifier" was null or undefined when calling putSubmodelDescriptorByIdThroughSuperpath().');
|
|
282
|
+
}
|
|
283
|
+
if (requestParameters['submodelDescriptor'] == null) {
|
|
284
|
+
throw new runtime.RequiredError('submodelDescriptor', 'Required parameter "submodelDescriptor" was null or undefined when calling putSubmodelDescriptorByIdThroughSuperpath().');
|
|
285
|
+
}
|
|
286
|
+
const queryParameters = {};
|
|
287
|
+
const headerParameters = {};
|
|
288
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
289
|
+
const response = await this.request({
|
|
290
|
+
path: `/shell-descriptors/{aasIdentifier}/submodel-descriptors/{submodelIdentifier}`.replace(`{${"aasIdentifier"}}`, encodeURIComponent(String(requestParameters['aasIdentifier']))).replace(`{${"submodelIdentifier"}}`, encodeURIComponent(String(requestParameters['submodelIdentifier']))),
|
|
291
|
+
method: 'PUT',
|
|
292
|
+
headers: headerParameters,
|
|
293
|
+
query: queryParameters,
|
|
294
|
+
body: requestParameters['submodelDescriptor'],
|
|
295
|
+
}, initOverrides);
|
|
296
|
+
return new runtime.JSONApiResponse(response);
|
|
297
|
+
}
|
|
298
|
+
/**
|
|
299
|
+
* Creates or updates an existing Submodel Descriptor
|
|
300
|
+
*/
|
|
301
|
+
async putSubmodelDescriptorByIdThroughSuperpath(requestParameters, initOverrides) {
|
|
302
|
+
const response = await this.putSubmodelDescriptorByIdThroughSuperpathRaw(requestParameters, initOverrides);
|
|
303
|
+
switch (response.raw.status) {
|
|
304
|
+
case 201:
|
|
305
|
+
return await response.value();
|
|
306
|
+
case 204:
|
|
307
|
+
return null;
|
|
308
|
+
default:
|
|
309
|
+
return await response.value();
|
|
310
|
+
}
|
|
311
|
+
}
|
|
312
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DotAAS Part 2 | HTTP/REST | Asset Administration Shell Registry Service Specification
|
|
3
|
+
* The Full Profile of the Asset Administration Shell Registry Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). Copyright: Industrial Digital Twin Association (IDTA) 2025
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: V3.1.0_SSP-001
|
|
6
|
+
* Contact: info@idtwin.org
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import * as runtime from '../runtime';
|
|
13
|
+
import type { ServiceDescription } from '../models/index';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
*/
|
|
17
|
+
export declare class DescriptionAPIApi extends runtime.BaseAPI {
|
|
18
|
+
/**
|
|
19
|
+
* Returns the self-describing information of a network resource (ServiceDescription)
|
|
20
|
+
*/
|
|
21
|
+
getSelfDescriptionRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ServiceDescription>>;
|
|
22
|
+
/**
|
|
23
|
+
* Returns the self-describing information of a network resource (ServiceDescription)
|
|
24
|
+
*/
|
|
25
|
+
getSelfDescription(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ServiceDescription>;
|
|
26
|
+
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* DotAAS Part 2 | HTTP/REST | Asset Administration Shell Registry Service Specification
|
|
5
|
+
* The Full Profile of the Asset Administration Shell Registry Service Specification as part of the [Specification of the Asset Administration Shell: Part 2](https://industrialdigitaltwin.org/en/content-hub/aasspecifications). Copyright: Industrial Digital Twin Association (IDTA) 2025
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: V3.1.0_SSP-001
|
|
8
|
+
* Contact: info@idtwin.org
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
import * as runtime from '../runtime';
|
|
15
|
+
/**
|
|
16
|
+
*
|
|
17
|
+
*/
|
|
18
|
+
export class DescriptionAPIApi extends runtime.BaseAPI {
|
|
19
|
+
/**
|
|
20
|
+
* Returns the self-describing information of a network resource (ServiceDescription)
|
|
21
|
+
*/
|
|
22
|
+
async getSelfDescriptionRaw(initOverrides) {
|
|
23
|
+
const queryParameters = {};
|
|
24
|
+
const headerParameters = {};
|
|
25
|
+
const response = await this.request({
|
|
26
|
+
path: `/description`,
|
|
27
|
+
method: 'GET',
|
|
28
|
+
headers: headerParameters,
|
|
29
|
+
query: queryParameters,
|
|
30
|
+
}, initOverrides);
|
|
31
|
+
return new runtime.JSONApiResponse(response);
|
|
32
|
+
}
|
|
33
|
+
/**
|
|
34
|
+
* Returns the self-describing information of a network resource (ServiceDescription)
|
|
35
|
+
*/
|
|
36
|
+
async getSelfDescription(initOverrides) {
|
|
37
|
+
const response = await this.getSelfDescriptionRaw(initOverrides);
|
|
38
|
+
return await response.value();
|
|
39
|
+
}
|
|
40
|
+
}
|