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
package/dist/generated/AasDiscoveryService/apis/AssetAdministrationShellBasicDiscoveryAPIApi.js
ADDED
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* DotAAS Part 2 | HTTP/REST | Discovery Service Specification
|
|
5
|
+
* The entire Full Profile of the Discovery Service Specification as part of the [Specification of the Asset Administration Shell - Part 2: API](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 AssetAdministrationShellBasicDiscoveryAPIApi extends runtime.BaseAPI {
|
|
19
|
+
/**
|
|
20
|
+
* Deletes specified specific asset identifiers linked to an Asset Administration Shell: discovery via these specific asset IDs shall not be supported any longer
|
|
21
|
+
*/
|
|
22
|
+
async deleteAllAssetLinksByIdRaw(requestParameters, initOverrides) {
|
|
23
|
+
if (requestParameters['aasIdentifier'] == null) {
|
|
24
|
+
throw new runtime.RequiredError('aasIdentifier', 'Required parameter "aasIdentifier" was null or undefined when calling deleteAllAssetLinksById().');
|
|
25
|
+
}
|
|
26
|
+
const queryParameters = {};
|
|
27
|
+
const headerParameters = {};
|
|
28
|
+
const response = await this.request({
|
|
29
|
+
path: `/lookup/shells/{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 specified specific asset identifiers linked to an Asset Administration Shell: discovery via these specific asset IDs shall not be supported any longer
|
|
38
|
+
*/
|
|
39
|
+
async deleteAllAssetLinksById(requestParameters, initOverrides) {
|
|
40
|
+
await this.deleteAllAssetLinksByIdRaw(requestParameters, initOverrides);
|
|
41
|
+
}
|
|
42
|
+
/**
|
|
43
|
+
* Returns a list of Asset Administration Shell IDs linked to specific asset identifiers or the global asset ID
|
|
44
|
+
* @deprecated
|
|
45
|
+
*/
|
|
46
|
+
async getAllAssetAdministrationShellIdsByAssetLinkRaw(requestParameters, initOverrides) {
|
|
47
|
+
const queryParameters = {};
|
|
48
|
+
if (requestParameters['assetIds'] != null) {
|
|
49
|
+
queryParameters['assetIds'] = requestParameters['assetIds'];
|
|
50
|
+
}
|
|
51
|
+
if (requestParameters['limit'] != null) {
|
|
52
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
53
|
+
}
|
|
54
|
+
if (requestParameters['cursor'] != null) {
|
|
55
|
+
queryParameters['cursor'] = requestParameters['cursor'];
|
|
56
|
+
}
|
|
57
|
+
const headerParameters = {};
|
|
58
|
+
const response = await this.request({
|
|
59
|
+
path: `/lookup/shells`,
|
|
60
|
+
method: 'GET',
|
|
61
|
+
headers: headerParameters,
|
|
62
|
+
query: queryParameters,
|
|
63
|
+
}, initOverrides);
|
|
64
|
+
return new runtime.JSONApiResponse(response);
|
|
65
|
+
}
|
|
66
|
+
/**
|
|
67
|
+
* Returns a list of Asset Administration Shell IDs linked to specific asset identifiers or the global asset ID
|
|
68
|
+
* @deprecated
|
|
69
|
+
*/
|
|
70
|
+
async getAllAssetAdministrationShellIdsByAssetLink(requestParameters = {}, initOverrides) {
|
|
71
|
+
const response = await this.getAllAssetAdministrationShellIdsByAssetLinkRaw(requestParameters, initOverrides);
|
|
72
|
+
return await response.value();
|
|
73
|
+
}
|
|
74
|
+
/**
|
|
75
|
+
* Returns a list of specific asset identifiers based on an Asset Administration Shell ID to edit discoverable content. The global asset ID is returned as specific asset ID with \"name\" equal to \"globalAssetId\" (see Constraint AASd-116).
|
|
76
|
+
*/
|
|
77
|
+
async getAllAssetLinksByIdRaw(requestParameters, initOverrides) {
|
|
78
|
+
if (requestParameters['aasIdentifier'] == null) {
|
|
79
|
+
throw new runtime.RequiredError('aasIdentifier', 'Required parameter "aasIdentifier" was null or undefined when calling getAllAssetLinksById().');
|
|
80
|
+
}
|
|
81
|
+
const queryParameters = {};
|
|
82
|
+
const headerParameters = {};
|
|
83
|
+
const response = await this.request({
|
|
84
|
+
path: `/lookup/shells/{aasIdentifier}`.replace(`{${"aasIdentifier"}}`, encodeURIComponent(String(requestParameters['aasIdentifier']))),
|
|
85
|
+
method: 'GET',
|
|
86
|
+
headers: headerParameters,
|
|
87
|
+
query: queryParameters,
|
|
88
|
+
}, initOverrides);
|
|
89
|
+
return new runtime.JSONApiResponse(response);
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Returns a list of specific asset identifiers based on an Asset Administration Shell ID to edit discoverable content. The global asset ID is returned as specific asset ID with \"name\" equal to \"globalAssetId\" (see Constraint AASd-116).
|
|
93
|
+
*/
|
|
94
|
+
async getAllAssetLinksById(requestParameters, initOverrides) {
|
|
95
|
+
const response = await this.getAllAssetLinksByIdRaw(requestParameters, initOverrides);
|
|
96
|
+
return await response.value();
|
|
97
|
+
}
|
|
98
|
+
/**
|
|
99
|
+
* Creates specific asset identifiers linked to an Asset Administration Shell to edit discoverable content
|
|
100
|
+
*/
|
|
101
|
+
async postAllAssetLinksByIdRaw(requestParameters, initOverrides) {
|
|
102
|
+
if (requestParameters['aasIdentifier'] == null) {
|
|
103
|
+
throw new runtime.RequiredError('aasIdentifier', 'Required parameter "aasIdentifier" was null or undefined when calling postAllAssetLinksById().');
|
|
104
|
+
}
|
|
105
|
+
if (requestParameters['specificAssetId'] == null) {
|
|
106
|
+
throw new runtime.RequiredError('specificAssetId', 'Required parameter "specificAssetId" was null or undefined when calling postAllAssetLinksById().');
|
|
107
|
+
}
|
|
108
|
+
const queryParameters = {};
|
|
109
|
+
const headerParameters = {};
|
|
110
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
111
|
+
const response = await this.request({
|
|
112
|
+
path: `/lookup/shells/{aasIdentifier}`.replace(`{${"aasIdentifier"}}`, encodeURIComponent(String(requestParameters['aasIdentifier']))),
|
|
113
|
+
method: 'POST',
|
|
114
|
+
headers: headerParameters,
|
|
115
|
+
query: queryParameters,
|
|
116
|
+
body: requestParameters['specificAssetId'],
|
|
117
|
+
}, initOverrides);
|
|
118
|
+
return new runtime.JSONApiResponse(response);
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* Creates specific asset identifiers linked to an Asset Administration Shell to edit discoverable content
|
|
122
|
+
*/
|
|
123
|
+
async postAllAssetLinksById(requestParameters, initOverrides) {
|
|
124
|
+
const response = await this.postAllAssetLinksByIdRaw(requestParameters, initOverrides);
|
|
125
|
+
return await response.value();
|
|
126
|
+
}
|
|
127
|
+
/**
|
|
128
|
+
* Returns a list of Asset Administration Shell IDs linked to specific asset identifiers or the global asset ID
|
|
129
|
+
*/
|
|
130
|
+
async searchAllAssetAdministrationShellIdsByAssetLinkRaw(requestParameters, initOverrides) {
|
|
131
|
+
const queryParameters = {};
|
|
132
|
+
if (requestParameters['limit'] != null) {
|
|
133
|
+
queryParameters['limit'] = requestParameters['limit'];
|
|
134
|
+
}
|
|
135
|
+
if (requestParameters['cursor'] != null) {
|
|
136
|
+
queryParameters['cursor'] = requestParameters['cursor'];
|
|
137
|
+
}
|
|
138
|
+
const headerParameters = {};
|
|
139
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
140
|
+
const response = await this.request({
|
|
141
|
+
path: `/lookup/shellsByAssetLink`,
|
|
142
|
+
method: 'POST',
|
|
143
|
+
headers: headerParameters,
|
|
144
|
+
query: queryParameters,
|
|
145
|
+
body: requestParameters['assetLink'],
|
|
146
|
+
}, initOverrides);
|
|
147
|
+
return new runtime.JSONApiResponse(response);
|
|
148
|
+
}
|
|
149
|
+
/**
|
|
150
|
+
* Returns a list of Asset Administration Shell IDs linked to specific asset identifiers or the global asset ID
|
|
151
|
+
*/
|
|
152
|
+
async searchAllAssetAdministrationShellIdsByAssetLink(requestParameters = {}, initOverrides) {
|
|
153
|
+
const response = await this.searchAllAssetAdministrationShellIdsByAssetLinkRaw(requestParameters, initOverrides);
|
|
154
|
+
return await response.value();
|
|
155
|
+
}
|
|
156
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DotAAS Part 2 | HTTP/REST | Discovery Service Specification
|
|
3
|
+
* The entire Full Profile of the Discovery Service Specification as part of the [Specification of the Asset Administration Shell - Part 2: API](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 | Discovery Service Specification
|
|
5
|
+
* The entire Full Profile of the Discovery Service Specification as part of the [Specification of the Asset Administration Shell - Part 2: API](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
|
+
}
|
|
@@ -0,0 +1,297 @@
|
|
|
1
|
+
/**
|
|
2
|
+
*
|
|
3
|
+
* @export
|
|
4
|
+
* @interface AssetLink
|
|
5
|
+
*/
|
|
6
|
+
export interface AssetLink {
|
|
7
|
+
/**
|
|
8
|
+
*
|
|
9
|
+
* @type {string}
|
|
10
|
+
* @memberof AssetLink
|
|
11
|
+
*/
|
|
12
|
+
name?: string;
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @type {string}
|
|
16
|
+
* @memberof AssetLink
|
|
17
|
+
*/
|
|
18
|
+
value?: string;
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @export
|
|
23
|
+
* @interface HasSemantics
|
|
24
|
+
*/
|
|
25
|
+
export interface HasSemantics {
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {Reference}
|
|
29
|
+
* @memberof HasSemantics
|
|
30
|
+
*/
|
|
31
|
+
semanticId?: Reference;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {Array<Reference>}
|
|
35
|
+
* @memberof HasSemantics
|
|
36
|
+
*/
|
|
37
|
+
supplementalSemanticIds?: Array<Reference>;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @export
|
|
42
|
+
* @interface InlineResponse200
|
|
43
|
+
*/
|
|
44
|
+
export interface InlineResponse200 {
|
|
45
|
+
/**
|
|
46
|
+
*
|
|
47
|
+
* @type {PagedResultPagingMetadata}
|
|
48
|
+
* @memberof InlineResponse200
|
|
49
|
+
*/
|
|
50
|
+
pagingMetadata: PagedResultPagingMetadata;
|
|
51
|
+
/**
|
|
52
|
+
*
|
|
53
|
+
* @type {Array<string>}
|
|
54
|
+
* @memberof InlineResponse200
|
|
55
|
+
*/
|
|
56
|
+
result?: Array<string>;
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
*
|
|
60
|
+
* @export
|
|
61
|
+
* @interface Key
|
|
62
|
+
*/
|
|
63
|
+
export interface Key {
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @type {KeyTypes}
|
|
67
|
+
* @memberof Key
|
|
68
|
+
*/
|
|
69
|
+
type: KeyTypes;
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @type {string}
|
|
73
|
+
* @memberof Key
|
|
74
|
+
*/
|
|
75
|
+
value: string;
|
|
76
|
+
}
|
|
77
|
+
/**
|
|
78
|
+
*
|
|
79
|
+
* @export
|
|
80
|
+
*/
|
|
81
|
+
export declare const KeyTypes: {
|
|
82
|
+
readonly AnnotatedRelationshipElement: "AnnotatedRelationshipElement";
|
|
83
|
+
readonly AssetAdministrationShell: "AssetAdministrationShell";
|
|
84
|
+
readonly BasicEventElement: "BasicEventElement";
|
|
85
|
+
readonly Blob: "Blob";
|
|
86
|
+
readonly Capability: "Capability";
|
|
87
|
+
readonly ConceptDescription: "ConceptDescription";
|
|
88
|
+
readonly DataElement: "DataElement";
|
|
89
|
+
readonly Entity: "Entity";
|
|
90
|
+
readonly EventElement: "EventElement";
|
|
91
|
+
readonly File: "File";
|
|
92
|
+
readonly FragmentReference: "FragmentReference";
|
|
93
|
+
readonly GlobalReference: "GlobalReference";
|
|
94
|
+
readonly Identifiable: "Identifiable";
|
|
95
|
+
readonly MultiLanguageProperty: "MultiLanguageProperty";
|
|
96
|
+
readonly Operation: "Operation";
|
|
97
|
+
readonly Property: "Property";
|
|
98
|
+
readonly Range: "Range";
|
|
99
|
+
readonly Referable: "Referable";
|
|
100
|
+
readonly ReferenceElement: "ReferenceElement";
|
|
101
|
+
readonly RelationshipElement: "RelationshipElement";
|
|
102
|
+
readonly Submodel: "Submodel";
|
|
103
|
+
readonly SubmodelElement: "SubmodelElement";
|
|
104
|
+
readonly SubmodelElementCollection: "SubmodelElementCollection";
|
|
105
|
+
readonly SubmodelElementList: "SubmodelElementList";
|
|
106
|
+
};
|
|
107
|
+
export type KeyTypes = typeof KeyTypes[keyof typeof KeyTypes];
|
|
108
|
+
/**
|
|
109
|
+
*
|
|
110
|
+
* @export
|
|
111
|
+
* @interface Message
|
|
112
|
+
*/
|
|
113
|
+
export interface Message {
|
|
114
|
+
/**
|
|
115
|
+
*
|
|
116
|
+
* @type {string}
|
|
117
|
+
* @memberof Message
|
|
118
|
+
*/
|
|
119
|
+
code?: string;
|
|
120
|
+
/**
|
|
121
|
+
*
|
|
122
|
+
* @type {string}
|
|
123
|
+
* @memberof Message
|
|
124
|
+
*/
|
|
125
|
+
correlationId?: string;
|
|
126
|
+
/**
|
|
127
|
+
*
|
|
128
|
+
* @type {string}
|
|
129
|
+
* @memberof Message
|
|
130
|
+
*/
|
|
131
|
+
messageType?: MessageMessageTypeEnum;
|
|
132
|
+
/**
|
|
133
|
+
*
|
|
134
|
+
* @type {string}
|
|
135
|
+
* @memberof Message
|
|
136
|
+
*/
|
|
137
|
+
text?: string;
|
|
138
|
+
/**
|
|
139
|
+
*
|
|
140
|
+
* @type {string}
|
|
141
|
+
* @memberof Message
|
|
142
|
+
*/
|
|
143
|
+
timestamp?: string;
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* @export
|
|
147
|
+
*/
|
|
148
|
+
export declare const MessageMessageTypeEnum: {
|
|
149
|
+
readonly Undefined: "Undefined";
|
|
150
|
+
readonly Info: "Info";
|
|
151
|
+
readonly Warning: "Warning";
|
|
152
|
+
readonly Error: "Error";
|
|
153
|
+
readonly Exception: "Exception";
|
|
154
|
+
};
|
|
155
|
+
export type MessageMessageTypeEnum = typeof MessageMessageTypeEnum[keyof typeof MessageMessageTypeEnum];
|
|
156
|
+
/**
|
|
157
|
+
*
|
|
158
|
+
* @export
|
|
159
|
+
* @interface PagedResult
|
|
160
|
+
*/
|
|
161
|
+
export interface PagedResult {
|
|
162
|
+
/**
|
|
163
|
+
*
|
|
164
|
+
* @type {PagedResultPagingMetadata}
|
|
165
|
+
* @memberof PagedResult
|
|
166
|
+
*/
|
|
167
|
+
pagingMetadata: PagedResultPagingMetadata;
|
|
168
|
+
}
|
|
169
|
+
/**
|
|
170
|
+
*
|
|
171
|
+
* @export
|
|
172
|
+
* @interface PagedResultPagingMetadata
|
|
173
|
+
*/
|
|
174
|
+
export interface PagedResultPagingMetadata {
|
|
175
|
+
/**
|
|
176
|
+
*
|
|
177
|
+
* @type {string}
|
|
178
|
+
* @memberof PagedResultPagingMetadata
|
|
179
|
+
*/
|
|
180
|
+
cursor?: string;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
*
|
|
184
|
+
* @export
|
|
185
|
+
* @interface Reference
|
|
186
|
+
*/
|
|
187
|
+
export interface Reference {
|
|
188
|
+
/**
|
|
189
|
+
*
|
|
190
|
+
* @type {ReferenceTypes}
|
|
191
|
+
* @memberof Reference
|
|
192
|
+
*/
|
|
193
|
+
type: ReferenceTypes;
|
|
194
|
+
/**
|
|
195
|
+
*
|
|
196
|
+
* @type {Array<Key>}
|
|
197
|
+
* @memberof Reference
|
|
198
|
+
*/
|
|
199
|
+
keys: Array<Key>;
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @type {ReferenceParent}
|
|
203
|
+
* @memberof Reference
|
|
204
|
+
*/
|
|
205
|
+
referredSemanticId?: ReferenceParent;
|
|
206
|
+
}
|
|
207
|
+
/**
|
|
208
|
+
*
|
|
209
|
+
* @export
|
|
210
|
+
* @interface ReferenceParent
|
|
211
|
+
*/
|
|
212
|
+
export interface ReferenceParent {
|
|
213
|
+
/**
|
|
214
|
+
*
|
|
215
|
+
* @type {ReferenceTypes}
|
|
216
|
+
* @memberof ReferenceParent
|
|
217
|
+
*/
|
|
218
|
+
type: ReferenceTypes;
|
|
219
|
+
/**
|
|
220
|
+
*
|
|
221
|
+
* @type {Array<Key>}
|
|
222
|
+
* @memberof ReferenceParent
|
|
223
|
+
*/
|
|
224
|
+
keys: Array<Key>;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
*
|
|
228
|
+
* @export
|
|
229
|
+
*/
|
|
230
|
+
export declare const ReferenceTypes: {
|
|
231
|
+
readonly ExternalReference: "ExternalReference";
|
|
232
|
+
readonly ModelReference: "ModelReference";
|
|
233
|
+
};
|
|
234
|
+
export type ReferenceTypes = typeof ReferenceTypes[keyof typeof ReferenceTypes];
|
|
235
|
+
/**
|
|
236
|
+
*
|
|
237
|
+
* @export
|
|
238
|
+
* @interface Result
|
|
239
|
+
*/
|
|
240
|
+
export interface Result {
|
|
241
|
+
/**
|
|
242
|
+
*
|
|
243
|
+
* @type {Array<Message>}
|
|
244
|
+
* @memberof Result
|
|
245
|
+
*/
|
|
246
|
+
messages?: Array<Message>;
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* The Description object enables servers to present their capabilities to the clients, in particular which profiles they implement. At least one defined profile is required. Additional, proprietary attributes might be included. Nevertheless, the server must not expect that a regular client understands them.
|
|
250
|
+
* @export
|
|
251
|
+
* @interface ServiceDescription
|
|
252
|
+
*/
|
|
253
|
+
export interface ServiceDescription {
|
|
254
|
+
/**
|
|
255
|
+
*
|
|
256
|
+
* @type {Array<string>}
|
|
257
|
+
* @memberof ServiceDescription
|
|
258
|
+
*/
|
|
259
|
+
profiles?: Array<string>;
|
|
260
|
+
}
|
|
261
|
+
/**
|
|
262
|
+
*
|
|
263
|
+
* @export
|
|
264
|
+
* @interface SpecificAssetId
|
|
265
|
+
*/
|
|
266
|
+
export interface SpecificAssetId {
|
|
267
|
+
/**
|
|
268
|
+
*
|
|
269
|
+
* @type {Reference}
|
|
270
|
+
* @memberof SpecificAssetId
|
|
271
|
+
*/
|
|
272
|
+
semanticId?: Reference;
|
|
273
|
+
/**
|
|
274
|
+
*
|
|
275
|
+
* @type {Array<Reference>}
|
|
276
|
+
* @memberof SpecificAssetId
|
|
277
|
+
*/
|
|
278
|
+
supplementalSemanticIds?: Array<Reference>;
|
|
279
|
+
/**
|
|
280
|
+
*
|
|
281
|
+
* @type {string}
|
|
282
|
+
* @memberof SpecificAssetId
|
|
283
|
+
*/
|
|
284
|
+
name: string;
|
|
285
|
+
/**
|
|
286
|
+
*
|
|
287
|
+
* @type {string}
|
|
288
|
+
* @memberof SpecificAssetId
|
|
289
|
+
*/
|
|
290
|
+
value: string;
|
|
291
|
+
/**
|
|
292
|
+
*
|
|
293
|
+
* @type {Reference}
|
|
294
|
+
* @memberof SpecificAssetId
|
|
295
|
+
*/
|
|
296
|
+
externalSubjectId?: Reference;
|
|
297
|
+
}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
/**
|
|
2
|
+
*
|
|
3
|
+
* @export
|
|
4
|
+
*/
|
|
5
|
+
export const KeyTypes = {
|
|
6
|
+
AnnotatedRelationshipElement: 'AnnotatedRelationshipElement',
|
|
7
|
+
AssetAdministrationShell: 'AssetAdministrationShell',
|
|
8
|
+
BasicEventElement: 'BasicEventElement',
|
|
9
|
+
Blob: 'Blob',
|
|
10
|
+
Capability: 'Capability',
|
|
11
|
+
ConceptDescription: 'ConceptDescription',
|
|
12
|
+
DataElement: 'DataElement',
|
|
13
|
+
Entity: 'Entity',
|
|
14
|
+
EventElement: 'EventElement',
|
|
15
|
+
File: 'File',
|
|
16
|
+
FragmentReference: 'FragmentReference',
|
|
17
|
+
GlobalReference: 'GlobalReference',
|
|
18
|
+
Identifiable: 'Identifiable',
|
|
19
|
+
MultiLanguageProperty: 'MultiLanguageProperty',
|
|
20
|
+
Operation: 'Operation',
|
|
21
|
+
Property: 'Property',
|
|
22
|
+
Range: 'Range',
|
|
23
|
+
Referable: 'Referable',
|
|
24
|
+
ReferenceElement: 'ReferenceElement',
|
|
25
|
+
RelationshipElement: 'RelationshipElement',
|
|
26
|
+
Submodel: 'Submodel',
|
|
27
|
+
SubmodelElement: 'SubmodelElement',
|
|
28
|
+
SubmodelElementCollection: 'SubmodelElementCollection',
|
|
29
|
+
SubmodelElementList: 'SubmodelElementList'
|
|
30
|
+
};
|
|
31
|
+
/**
|
|
32
|
+
* @export
|
|
33
|
+
*/
|
|
34
|
+
export const MessageMessageTypeEnum = {
|
|
35
|
+
Undefined: 'Undefined',
|
|
36
|
+
Info: 'Info',
|
|
37
|
+
Warning: 'Warning',
|
|
38
|
+
Error: 'Error',
|
|
39
|
+
Exception: 'Exception'
|
|
40
|
+
};
|
|
41
|
+
/**
|
|
42
|
+
*
|
|
43
|
+
* @export
|
|
44
|
+
*/
|
|
45
|
+
export const ReferenceTypes = {
|
|
46
|
+
ExternalReference: 'ExternalReference',
|
|
47
|
+
ModelReference: 'ModelReference'
|
|
48
|
+
};
|