@openremote/rest 1.28.0-snapshot.20260729123656 → 1.28.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/dist/umd/index.bundle.js +1 -1
- package/dist/umd/index.bundle.js.map +1 -1
- package/dist/umd/index.js +1 -1
- package/dist/umd/index.js.map +1 -1
- package/lib/restclient.d.ts +806 -806
- package/lib/restclient.d.ts.map +1 -1
- package/lib/restclient.js +1 -1
- package/lib/restclient.js.map +1 -1
- package/package.json +2 -2
package/lib/restclient.d.ts
CHANGED
|
@@ -9,157 +9,182 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class AssetModelResourceClient<O> {
|
|
13
13
|
protected httpClient: HttpClient<O>;
|
|
14
14
|
constructor(httpClient: HttpClient<O>);
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
17
|
-
* HTTP
|
|
18
|
-
* Java method: org.openremote.model.
|
|
19
|
-
*/
|
|
20
|
-
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
21
|
-
/**
|
|
22
|
-
* Executes a UserQuery. Non-super users are forced into their authenticated realm and cannot see system accounts; callers with read-users but not read-admin receive basic fields only.
|
|
23
|
-
* HTTP POST /user/query
|
|
24
|
-
* Java method: org.openremote.model.security.UserResource.query
|
|
25
|
-
*/
|
|
26
|
-
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
27
|
-
/**
|
|
28
|
-
* Initiates the identity provider's configured password-reset action for the caller's own account.
|
|
29
|
-
* HTTP PUT /user/request-password-reset
|
|
30
|
-
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
16
|
+
* Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
|
|
17
|
+
* HTTP GET /model/assetDescriptors
|
|
18
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
31
19
|
*/
|
|
32
|
-
|
|
20
|
+
getAssetDescriptors(queryParams?: {
|
|
21
|
+
parentId?: string;
|
|
22
|
+
parentType?: string;
|
|
23
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
33
24
|
/**
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
25
|
+
* Returns metadata for one asset type from this Manager or, when parentId is below a gateway, from that gateway's model. An unknown or gateway-provided type that is not locally available returns no content.
|
|
26
|
+
* Response code 204 - No model information is available for the requested asset type
|
|
27
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
28
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
37
29
|
*/
|
|
38
|
-
|
|
30
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
31
|
+
parentId?: string;
|
|
32
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
39
33
|
/**
|
|
40
|
-
*
|
|
41
|
-
* HTTP
|
|
42
|
-
* Java method: org.openremote.model.
|
|
34
|
+
* Returns type metadata from this Manager by default. When parentId identifies an asset below a gateway, the gateway's model is used instead; parentType can provide type context for a new parent that does not yet exist.
|
|
35
|
+
* HTTP GET /model/assetInfos
|
|
36
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
43
37
|
*/
|
|
44
|
-
|
|
38
|
+
getAssetInfos(queryParams?: {
|
|
39
|
+
parentId?: string;
|
|
40
|
+
parentType?: string;
|
|
41
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
45
42
|
/**
|
|
46
|
-
* Returns the
|
|
47
|
-
*
|
|
48
|
-
*
|
|
43
|
+
* Returns the JSON Schema and a weak ETag for the named value descriptor. Send If-None-Match on later requests to receive 304 when the schema has not changed.
|
|
44
|
+
* Response code 200 - The current JSON Schema
|
|
45
|
+
* Response code 304 - The supplied ETag still identifies the current schema
|
|
46
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
47
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
49
48
|
*/
|
|
50
|
-
|
|
49
|
+
getValueDescriptorSchema(queryParams?: {
|
|
50
|
+
name?: string;
|
|
51
|
+
}, options?: O): RestResponse<any>;
|
|
51
52
|
/**
|
|
52
|
-
* Returns
|
|
53
|
-
* HTTP GET /
|
|
54
|
-
* Java method: org.openremote.model.
|
|
53
|
+
* Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
54
|
+
* HTTP GET /model/metaItemDescriptors
|
|
55
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
55
56
|
*/
|
|
56
|
-
|
|
57
|
+
getMetaItemDescriptors(queryParams?: {
|
|
58
|
+
parentId?: string;
|
|
59
|
+
}, options?: O): RestResponse<{
|
|
60
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
61
|
+
}>;
|
|
57
62
|
/**
|
|
58
|
-
* Returns
|
|
59
|
-
* HTTP GET /
|
|
60
|
-
* Java method: org.openremote.model.
|
|
63
|
+
* Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
64
|
+
* HTTP GET /model/valueDescriptors
|
|
65
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
61
66
|
*/
|
|
62
|
-
|
|
67
|
+
getValueDescriptors(queryParams?: {
|
|
68
|
+
parentId?: string;
|
|
69
|
+
}, options?: O): RestResponse<{
|
|
70
|
+
[index: string]: Model.ValueDescriptor;
|
|
71
|
+
}>;
|
|
72
|
+
}
|
|
73
|
+
export declare class AppResourceClient<O> {
|
|
74
|
+
protected httpClient: HttpClient<O>;
|
|
75
|
+
constructor(httpClient: HttpClient<O>);
|
|
63
76
|
/**
|
|
64
|
-
*
|
|
65
|
-
* HTTP GET /
|
|
66
|
-
* Java method: org.openremote.model.
|
|
77
|
+
* Returns the identifiers of applications installed in the Manager web root.
|
|
78
|
+
* HTTP GET /apps
|
|
79
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
67
80
|
*/
|
|
68
|
-
|
|
81
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
69
82
|
/**
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
73
|
-
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
83
|
+
* Loads the public console_config.json document used to configure console clients before sign-in.
|
|
84
|
+
* HTTP GET /apps/consoleConfig
|
|
85
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
74
86
|
*/
|
|
75
|
-
|
|
87
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
76
88
|
/**
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
*
|
|
80
|
-
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
89
|
+
* Loads each installed application's info.json file and returns the documents keyed by application identifier.
|
|
90
|
+
* HTTP GET /apps/info
|
|
91
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
81
92
|
*/
|
|
82
|
-
|
|
93
|
+
getAppInfos(options?: O): RestResponse<{
|
|
94
|
+
[index: string]: any;
|
|
95
|
+
}>;
|
|
96
|
+
}
|
|
97
|
+
export declare class RealmResourceClient<O> {
|
|
98
|
+
protected httpClient: HttpClient<O>;
|
|
99
|
+
constructor(httpClient: HttpClient<O>);
|
|
83
100
|
/**
|
|
84
|
-
*
|
|
85
|
-
* HTTP
|
|
86
|
-
* Java method: org.openremote.model.security.
|
|
101
|
+
* Creates and configures a realm in the identity provider. This operation is restricted to a super user.
|
|
102
|
+
* HTTP POST /realm
|
|
103
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
87
104
|
*/
|
|
88
|
-
|
|
105
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
89
106
|
/**
|
|
90
|
-
*
|
|
91
|
-
* HTTP
|
|
92
|
-
* Java method: org.openremote.model.security.
|
|
107
|
+
* Returns complete realm records from the identity provider. This operation is restricted to a super user.
|
|
108
|
+
* HTTP GET /realm
|
|
109
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
93
110
|
*/
|
|
94
|
-
|
|
111
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
95
112
|
/**
|
|
96
|
-
* Returns realm
|
|
97
|
-
* HTTP GET /
|
|
98
|
-
* Java method: org.openremote.model.security.
|
|
113
|
+
* Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
|
|
114
|
+
* HTTP GET /realm/accessible
|
|
115
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
99
116
|
*/
|
|
100
|
-
|
|
117
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
101
118
|
/**
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
119
|
+
* Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
|
|
120
|
+
* Response code 405 - The master realm cannot be deleted
|
|
121
|
+
* HTTP DELETE /realm/{name}
|
|
122
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
105
123
|
*/
|
|
106
|
-
|
|
124
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
107
125
|
/**
|
|
108
|
-
* Returns
|
|
109
|
-
* HTTP GET /
|
|
110
|
-
* Java method: org.openremote.model.security.
|
|
126
|
+
* Returns complete details for a named active realm when it is accessible to the caller. Regular users cannot use this endpoint to inspect other realms.
|
|
127
|
+
* HTTP GET /realm/{name}
|
|
128
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
111
129
|
*/
|
|
112
|
-
|
|
130
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
113
131
|
/**
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
132
|
+
* Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
|
|
133
|
+
* Response code 405 - The requested mutation is not allowed for the master realm
|
|
134
|
+
* HTTP PUT /realm/{name}
|
|
135
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
117
136
|
*/
|
|
118
|
-
|
|
137
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
138
|
+
}
|
|
139
|
+
export declare class FlowResourceClient<O> {
|
|
140
|
+
protected httpClient: HttpClient<O>;
|
|
141
|
+
constructor(httpClient: HttpClient<O>);
|
|
119
142
|
/**
|
|
120
|
-
* Returns
|
|
121
|
-
* HTTP GET /
|
|
122
|
-
* Java method: org.openremote.model.
|
|
143
|
+
* Returns every supported flow node definition except the internal LOG_OUTPUT node.
|
|
144
|
+
* HTTP GET /flow
|
|
145
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
123
146
|
*/
|
|
124
|
-
|
|
147
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
125
148
|
/**
|
|
126
|
-
*
|
|
127
|
-
* HTTP
|
|
128
|
-
* Java method: org.openremote.model.
|
|
149
|
+
* Resolves one flow node definition by its model name.
|
|
150
|
+
* HTTP GET /flow/{name}
|
|
151
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
129
152
|
*/
|
|
130
|
-
|
|
153
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
131
154
|
/**
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
* Java method: org.openremote.model.security.UserResource.update
|
|
155
|
+
* Returns supported flow node definitions whose category matches the requested node type.
|
|
156
|
+
* HTTP GET /flow/{type}
|
|
157
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
136
158
|
*/
|
|
137
|
-
|
|
159
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
160
|
+
}
|
|
161
|
+
export declare class ProvisioningResourceClient<O> {
|
|
162
|
+
protected httpClient: HttpClient<O>;
|
|
163
|
+
constructor(httpClient: HttpClient<O>);
|
|
138
164
|
/**
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
* Java method: org.openremote.model.security.UserResource.delete
|
|
165
|
+
* Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
|
|
166
|
+
* HTTP POST /provisioning
|
|
167
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
143
168
|
*/
|
|
144
|
-
|
|
169
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
145
170
|
/**
|
|
146
|
-
* Returns
|
|
147
|
-
* HTTP GET /
|
|
148
|
-
* Java method: org.openremote.model.
|
|
171
|
+
* Returns every provisioning configuration. This operation is restricted to a super administrator.
|
|
172
|
+
* HTTP GET /provisioning
|
|
173
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
149
174
|
*/
|
|
150
|
-
|
|
175
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
151
176
|
/**
|
|
152
|
-
*
|
|
153
|
-
* HTTP
|
|
154
|
-
* Java method: org.openremote.model.
|
|
177
|
+
* Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
178
|
+
* HTTP DELETE /provisioning/{id}
|
|
179
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
155
180
|
*/
|
|
156
|
-
|
|
181
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
157
182
|
/**
|
|
158
|
-
*
|
|
159
|
-
* HTTP
|
|
160
|
-
* Java method: org.openremote.model.
|
|
183
|
+
* Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
184
|
+
* HTTP PUT /provisioning/{id}
|
|
185
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
161
186
|
*/
|
|
162
|
-
|
|
187
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
163
188
|
}
|
|
164
189
|
export declare class GatewayClientResourceClient<O> {
|
|
165
190
|
protected httpClient: HttpClient<O>;
|
|
@@ -204,297 +229,361 @@ export declare class GatewayClientResourceClient<O> {
|
|
|
204
229
|
*/
|
|
205
230
|
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
206
231
|
}
|
|
207
|
-
export declare class
|
|
232
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
208
233
|
protected httpClient: HttpClient<O>;
|
|
209
234
|
constructor(httpClient: HttpClient<O>);
|
|
210
235
|
/**
|
|
211
|
-
*
|
|
212
|
-
* Response code
|
|
213
|
-
* HTTP
|
|
214
|
-
* Java method: org.openremote.model.
|
|
236
|
+
* Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
|
|
237
|
+
* Response code 417 - The gateway could not establish the requested tunnel
|
|
238
|
+
* HTTP POST /gateway/tunnel
|
|
239
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
215
240
|
*/
|
|
216
|
-
|
|
217
|
-
attributeRefs?: string;
|
|
218
|
-
fromTimestamp?: number;
|
|
219
|
-
toTimestamp?: number;
|
|
220
|
-
format?: Model.DatapointExportFormat;
|
|
221
|
-
}, options?: O): RestResponse<any>;
|
|
241
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
222
242
|
/**
|
|
223
|
-
*
|
|
224
|
-
* HTTP
|
|
225
|
-
* Java method: org.openremote.model.
|
|
226
|
-
*/
|
|
227
|
-
getDatapointPeriod(queryParams?: {
|
|
228
|
-
assetId?: string;
|
|
229
|
-
attributeName?: string;
|
|
230
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
231
|
-
/**
|
|
232
|
-
* Returns stored historical values for one attribute. A null body returns the available series; a polymorphic query body controls the time range and retrieval or aggregation strategy. Anonymous access requires public-read access on both asset and attribute.
|
|
233
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
234
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
243
|
+
* Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
|
|
244
|
+
* HTTP DELETE /gateway/tunnel
|
|
245
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
235
246
|
*/
|
|
236
|
-
|
|
237
|
-
}
|
|
238
|
-
export declare class RulesResourceClient<O> {
|
|
239
|
-
protected httpClient: HttpClient<O>;
|
|
240
|
-
constructor(httpClient: HttpClient<O>);
|
|
247
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
241
248
|
/**
|
|
242
|
-
*
|
|
243
|
-
* HTTP
|
|
244
|
-
* Java method: org.openremote.model.
|
|
249
|
+
* Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
|
|
250
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
251
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
245
252
|
*/
|
|
246
|
-
|
|
253
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
247
254
|
/**
|
|
248
|
-
* Returns
|
|
249
|
-
* HTTP GET /
|
|
250
|
-
* Java method: org.openremote.model.
|
|
255
|
+
* Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
|
|
256
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
257
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
251
258
|
*/
|
|
252
|
-
|
|
253
|
-
language?: Model.RulesetLang[];
|
|
254
|
-
fullyPopulate?: boolean;
|
|
255
|
-
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
259
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
256
260
|
/**
|
|
257
|
-
*
|
|
258
|
-
*
|
|
259
|
-
*
|
|
261
|
+
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
262
|
+
* Response code 204 - No active tunnel matches the requested endpoint
|
|
263
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
264
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
260
265
|
*/
|
|
261
|
-
|
|
266
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
267
|
+
}
|
|
268
|
+
export declare class ConsoleResourceClient<O> {
|
|
269
|
+
protected httpClient: HttpClient<O>;
|
|
270
|
+
constructor(httpClient: HttpClient<O>);
|
|
262
271
|
/**
|
|
263
|
-
*
|
|
264
|
-
* HTTP
|
|
265
|
-
* Java method: org.openremote.model.
|
|
272
|
+
* Creates an anonymous console registration when id is absent, or updates an existing registration when id is present. Authenticated new registrations are linked to the caller; updates require that link. The returned registration contains the durable asset ID for later calls.
|
|
273
|
+
* HTTP POST /console/register
|
|
274
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
266
275
|
*/
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
276
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
277
|
+
}
|
|
278
|
+
export declare class ConfigurationResourceClient<O> {
|
|
279
|
+
protected httpClient: HttpClient<O>;
|
|
280
|
+
constructor(httpClient: HttpClient<O>);
|
|
271
281
|
/**
|
|
272
|
-
*
|
|
273
|
-
* HTTP
|
|
274
|
-
* Java method: org.openremote.model.
|
|
282
|
+
* Returns the public Manager application configuration used by clients before and after authentication.
|
|
283
|
+
* HTTP GET /configuration/manager
|
|
284
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
275
285
|
*/
|
|
276
|
-
|
|
286
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
277
287
|
/**
|
|
278
|
-
*
|
|
279
|
-
* HTTP
|
|
280
|
-
* Java method: org.openremote.model.
|
|
288
|
+
* Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
|
|
289
|
+
* HTTP PUT /configuration/manager
|
|
290
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
281
291
|
*/
|
|
282
|
-
|
|
292
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
283
293
|
/**
|
|
284
|
-
*
|
|
285
|
-
* HTTP
|
|
286
|
-
* Java method: org.openremote.model.
|
|
294
|
+
* Decodes and stores the supplied FileInfo under the requested relative path, then returns its Manager API path.
|
|
295
|
+
* HTTP POST /configuration/manager/file
|
|
296
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
287
297
|
*/
|
|
288
|
-
|
|
298
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
299
|
+
path?: string;
|
|
300
|
+
}, options?: O): RestResponse<string>;
|
|
289
301
|
/**
|
|
290
|
-
*
|
|
291
|
-
*
|
|
292
|
-
*
|
|
302
|
+
* Streams a previously uploaded configuration image using its detected media type.
|
|
303
|
+
* Response code 200 - The image file
|
|
304
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
305
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
293
306
|
*/
|
|
294
|
-
|
|
307
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
308
|
+
}
|
|
309
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
310
|
+
protected httpClient: HttpClient<O>;
|
|
311
|
+
constructor(httpClient: HttpClient<O>);
|
|
295
312
|
/**
|
|
296
|
-
* Returns
|
|
297
|
-
* Response code
|
|
298
|
-
* HTTP GET /
|
|
299
|
-
* Java method: org.openremote.model.
|
|
313
|
+
* Returns all active realm-scoped service registrations for an active realm accessible to the caller.
|
|
314
|
+
* Response code 200 - List of registered external services
|
|
315
|
+
* HTTP GET /service
|
|
316
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
300
317
|
*/
|
|
301
|
-
|
|
318
|
+
getServices(queryParams?: {
|
|
319
|
+
realm?: string;
|
|
320
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
302
321
|
/**
|
|
303
|
-
*
|
|
304
|
-
* Response code
|
|
305
|
-
*
|
|
306
|
-
*
|
|
322
|
+
* Registers a realm-scoped service instance for the request realm. The caller must be a service account; the returned object contains the assigned instance ID and initial lease state.
|
|
323
|
+
* Response code 200 - Service registered successfully
|
|
324
|
+
* Response code 400 - Invalid external service object
|
|
325
|
+
* Response code 409 - ExternalService instance already registered
|
|
326
|
+
* HTTP POST /service
|
|
327
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
307
328
|
*/
|
|
308
|
-
|
|
329
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
309
330
|
/**
|
|
310
|
-
* Returns
|
|
311
|
-
* Response code
|
|
312
|
-
* HTTP GET /
|
|
313
|
-
* Java method: org.openremote.model.
|
|
331
|
+
* Returns active registrations marked as globally available across realms.
|
|
332
|
+
* Response code 200 - List of registered external services
|
|
333
|
+
* HTTP GET /service/global
|
|
334
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
314
335
|
*/
|
|
315
|
-
|
|
336
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
316
337
|
/**
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
*
|
|
338
|
+
* Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
|
|
339
|
+
* Response code 200 - Service registered successfully
|
|
340
|
+
* Response code 400 - Invalid external service object
|
|
341
|
+
* Response code 409 - ExternalService instance already registered
|
|
342
|
+
* HTTP POST /service/global
|
|
343
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
320
344
|
*/
|
|
321
|
-
|
|
345
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
322
346
|
/**
|
|
323
|
-
*
|
|
324
|
-
*
|
|
325
|
-
*
|
|
347
|
+
* Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
|
|
348
|
+
* Response code 204 - Service deregistered successfully
|
|
349
|
+
* Response code 404 - Service instance not found
|
|
350
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
351
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
326
352
|
*/
|
|
327
|
-
|
|
328
|
-
language?: Model.RulesetLang[];
|
|
329
|
-
fullyPopulate?: boolean;
|
|
330
|
-
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
353
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
331
354
|
/**
|
|
332
|
-
*
|
|
333
|
-
*
|
|
334
|
-
*
|
|
355
|
+
* Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
|
|
356
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
357
|
+
* Response code 404 - ExternalService not found
|
|
358
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
359
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
335
360
|
*/
|
|
336
|
-
|
|
361
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
337
362
|
/**
|
|
338
|
-
*
|
|
339
|
-
*
|
|
340
|
-
*
|
|
363
|
+
* Extends the lease of one service instance. The caller must be the service account that registered it; global-service heartbeats additionally require a super user.
|
|
364
|
+
* Response code 204 - Heartbeat sent successfully
|
|
365
|
+
* Response code 404 - Service instance not found
|
|
366
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
367
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
341
368
|
*/
|
|
342
|
-
|
|
369
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
370
|
+
}
|
|
371
|
+
export declare class SyslogResourceClient<O> {
|
|
372
|
+
protected httpClient: HttpClient<O>;
|
|
373
|
+
constructor(httpClient: HttpClient<O>);
|
|
343
374
|
/**
|
|
344
|
-
*
|
|
345
|
-
* HTTP
|
|
346
|
-
* Java method: org.openremote.model.
|
|
375
|
+
* Returns the current log-storage and retention configuration.
|
|
376
|
+
* HTTP GET /syslog/config
|
|
377
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
347
378
|
*/
|
|
348
|
-
|
|
379
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
349
380
|
/**
|
|
350
|
-
*
|
|
351
|
-
* HTTP
|
|
352
|
-
* Java method: org.openremote.model.
|
|
381
|
+
* Validates and applies log-storage and retention settings.
|
|
382
|
+
* HTTP PUT /syslog/config
|
|
383
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
353
384
|
*/
|
|
354
|
-
|
|
385
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
355
386
|
/**
|
|
356
|
-
*
|
|
357
|
-
* HTTP
|
|
358
|
-
* Java method: org.openremote.model.
|
|
387
|
+
* Permanently removes all events from the configured syslog storage.
|
|
388
|
+
* HTTP DELETE /syslog/event
|
|
389
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
359
390
|
*/
|
|
360
|
-
|
|
391
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
361
392
|
/**
|
|
362
|
-
*
|
|
363
|
-
*
|
|
364
|
-
*
|
|
393
|
+
* Returns a page of log events filtered by severity, Unix-millisecond time range, categories, and subcategories. RFC 8288 Link headers point to the next and last pages.
|
|
394
|
+
* Response code 200 - The requested page of syslog events
|
|
395
|
+
* HTTP GET /syslog/event
|
|
396
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
365
397
|
*/
|
|
366
|
-
|
|
398
|
+
getEvents(queryParams?: {
|
|
399
|
+
level?: Model.SyslogLevel;
|
|
400
|
+
per_page?: number;
|
|
401
|
+
page?: number;
|
|
402
|
+
from?: number;
|
|
403
|
+
to?: number;
|
|
404
|
+
category?: Model.SyslogCategory[];
|
|
405
|
+
subCategory?: string[];
|
|
406
|
+
}, options?: O): RestResponse<any>;
|
|
367
407
|
}
|
|
368
|
-
export declare class
|
|
408
|
+
export declare class DashboardResourceClient<O> {
|
|
369
409
|
protected httpClient: HttpClient<O>;
|
|
370
410
|
constructor(httpClient: HttpClient<O>);
|
|
371
411
|
/**
|
|
372
|
-
* Creates
|
|
373
|
-
* HTTP POST /
|
|
374
|
-
* Java method: org.openremote.model.
|
|
412
|
+
* Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
|
|
413
|
+
* HTTP POST /dashboard
|
|
414
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
375
415
|
*/
|
|
376
|
-
create(
|
|
416
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
377
417
|
/**
|
|
378
|
-
*
|
|
379
|
-
* HTTP
|
|
380
|
-
* Java method: org.openremote.model.
|
|
418
|
+
* Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
|
|
419
|
+
* HTTP PUT /dashboard
|
|
420
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
381
421
|
*/
|
|
382
|
-
|
|
422
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
383
423
|
/**
|
|
384
|
-
* Returns
|
|
385
|
-
* HTTP GET /realm
|
|
386
|
-
* Java method: org.openremote.model.
|
|
424
|
+
* Returns dashboards visible to the caller in the requested realm. Anonymous callers receive public dashboards only; authenticated access also depends on roles, ownership, and linked assets.
|
|
425
|
+
* HTTP GET /dashboard/all/{realm}
|
|
426
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
387
427
|
*/
|
|
388
|
-
|
|
428
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
389
429
|
/**
|
|
390
|
-
*
|
|
391
|
-
*
|
|
392
|
-
*
|
|
393
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
430
|
+
* Executes a dashboard query after constraining it to the caller's realm, roles, ownership, and asset access. A missing body uses the request realm and default visibility rules.
|
|
431
|
+
* HTTP POST /dashboard/query
|
|
432
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
394
433
|
*/
|
|
395
|
-
|
|
434
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
396
435
|
/**
|
|
397
|
-
*
|
|
398
|
-
* HTTP
|
|
399
|
-
* Java method: org.openremote.model.
|
|
436
|
+
* Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
|
|
437
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
438
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
400
439
|
*/
|
|
401
|
-
|
|
440
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
402
441
|
/**
|
|
403
|
-
*
|
|
404
|
-
*
|
|
405
|
-
*
|
|
406
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
442
|
+
* Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
|
|
443
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
444
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
407
445
|
*/
|
|
408
|
-
|
|
446
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
409
447
|
}
|
|
410
|
-
export declare class
|
|
448
|
+
export declare class AssetResourceClient<O> {
|
|
411
449
|
protected httpClient: HttpClient<O>;
|
|
412
450
|
constructor(httpClient: HttpClient<O>);
|
|
413
451
|
/**
|
|
414
|
-
*
|
|
415
|
-
* HTTP
|
|
416
|
-
* Java method: org.openremote.model.
|
|
452
|
+
* Creates an asset in an accessible realm and returns the persisted representation. The server generates an ID when absent; supplied IDs must be globally unique and 22 characters long.
|
|
453
|
+
* HTTP POST /asset
|
|
454
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
417
455
|
*/
|
|
418
|
-
|
|
456
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
419
457
|
/**
|
|
420
|
-
*
|
|
421
|
-
* HTTP
|
|
422
|
-
* Java method: org.openremote.model.
|
|
458
|
+
* Permanently deletes every asset identified by repeated assetId query parameters, subject to realm and restricted-user access rules.
|
|
459
|
+
* HTTP DELETE /asset
|
|
460
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
423
461
|
*/
|
|
424
|
-
|
|
462
|
+
delete(queryParams?: {
|
|
463
|
+
assetId?: string[];
|
|
464
|
+
}, options?: O): RestResponse<void>;
|
|
425
465
|
/**
|
|
426
|
-
*
|
|
427
|
-
* HTTP
|
|
428
|
-
* Java method: org.openremote.model.
|
|
466
|
+
* Submits a batch of attribute states using current server time and returns one result per input item. Authorization and processing failures are encoded in each AttributeWriteResult rather than returned as an HTTP error.
|
|
467
|
+
* HTTP PUT /asset/attributes
|
|
468
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
429
469
|
*/
|
|
430
|
-
|
|
431
|
-
[index: string]: any;
|
|
432
|
-
}>;
|
|
433
|
-
}
|
|
434
|
-
export declare class SyslogResourceClient<O> {
|
|
435
|
-
protected httpClient: HttpClient<O>;
|
|
436
|
-
constructor(httpClient: HttpClient<O>);
|
|
470
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
437
471
|
/**
|
|
438
|
-
*
|
|
439
|
-
* HTTP
|
|
440
|
-
* Java method: org.openremote.model.
|
|
472
|
+
* Submits a batch of complete attribute events and returns one result per input item. Supplied timestamps are preserved; authorization and processing failures are encoded per result rather than returned as an HTTP error.
|
|
473
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
474
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
441
475
|
*/
|
|
442
|
-
|
|
476
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
443
477
|
/**
|
|
444
|
-
*
|
|
445
|
-
* HTTP
|
|
446
|
-
* Java method: org.openremote.model.
|
|
478
|
+
* Returns only the number of assets matching an AssetQuery after applying the caller's realm, public, and linked-asset access constraints.
|
|
479
|
+
* HTTP POST /asset/count
|
|
480
|
+
* Java method: org.openremote.model.asset.AssetResource.queryCount
|
|
447
481
|
*/
|
|
448
|
-
|
|
482
|
+
queryCount(query: Model.AssetQuery, options?: O): RestResponse<number>;
|
|
449
483
|
/**
|
|
450
|
-
*
|
|
451
|
-
* HTTP DELETE /
|
|
452
|
-
* Java method: org.openremote.model.
|
|
484
|
+
* Clears the parent reference of every asset listed in repeated assetIds query parameters.
|
|
485
|
+
* HTTP DELETE /asset/parent
|
|
486
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
453
487
|
*/
|
|
454
|
-
|
|
488
|
+
updateNoneParent(queryParams?: {
|
|
489
|
+
assetIds?: string[];
|
|
490
|
+
}, options?: O): RestResponse<void>;
|
|
455
491
|
/**
|
|
456
|
-
* Returns
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
492
|
+
* Returns the asset identity and properties without loading attributes or path data. The same access rules as getAsset apply.
|
|
493
|
+
* HTTP GET /asset/partial/{assetId}
|
|
494
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
460
495
|
*/
|
|
461
|
-
|
|
462
|
-
level?: Model.SyslogLevel;
|
|
463
|
-
per_page?: number;
|
|
464
|
-
page?: number;
|
|
465
|
-
from?: number;
|
|
466
|
-
to?: number;
|
|
467
|
-
category?: Model.SyslogCategory[];
|
|
468
|
-
subCategory?: string[];
|
|
469
|
-
}, options?: O): RestResponse<any>;
|
|
470
|
-
}
|
|
471
|
-
export declare class ProvisioningResourceClient<O> {
|
|
472
|
-
protected httpClient: HttpClient<O>;
|
|
473
|
-
constructor(httpClient: HttpClient<O>);
|
|
496
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
474
497
|
/**
|
|
475
|
-
*
|
|
476
|
-
* HTTP POST /
|
|
477
|
-
* Java method: org.openremote.model.
|
|
498
|
+
* Executes an AssetQuery after constraining realm and linked-asset access. Anonymous callers receive public-readable assets only; the query select clause controls which fields are populated.
|
|
499
|
+
* HTTP POST /asset/query
|
|
500
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
478
501
|
*/
|
|
479
|
-
|
|
502
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
480
503
|
/**
|
|
481
|
-
*
|
|
482
|
-
* HTTP
|
|
483
|
-
* Java method: org.openremote.model.
|
|
504
|
+
* Applies the same authorization and selection rules as queryAssets, then returns a hierarchy optimized for tree display rather than a flat asset array.
|
|
505
|
+
* HTTP POST /asset/tree
|
|
506
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
484
507
|
*/
|
|
485
|
-
|
|
508
|
+
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
486
509
|
/**
|
|
487
|
-
*
|
|
488
|
-
* HTTP
|
|
489
|
-
* Java method: org.openremote.model.
|
|
510
|
+
* Returns partial linked assets for a restricted user, root assets for an unrestricted realm user, and an empty array for a super user. Attributes and paths are omitted; use getAsset for full details.
|
|
511
|
+
* HTTP GET /asset/user/current
|
|
512
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
490
513
|
*/
|
|
491
|
-
|
|
514
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
492
515
|
/**
|
|
493
|
-
*
|
|
494
|
-
* HTTP
|
|
495
|
-
* Java method: org.openremote.model.
|
|
516
|
+
* Creates all supplied links as one operation. Every item must identify the same realm and user, and every referenced realm, user, and asset must exist.
|
|
517
|
+
* HTTP POST /asset/user/link
|
|
518
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
496
519
|
*/
|
|
497
|
-
|
|
520
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
521
|
+
/**
|
|
522
|
+
* Returns user-asset links in the required realm, optionally filtered by userId and assetId. Missing users or assets produce an empty result; restricted users cannot call this operation.
|
|
523
|
+
* HTTP GET /asset/user/link
|
|
524
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
525
|
+
*/
|
|
526
|
+
getUserAssetLinks(queryParams?: {
|
|
527
|
+
realm?: string;
|
|
528
|
+
userId?: string;
|
|
529
|
+
assetId?: string;
|
|
530
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
531
|
+
/**
|
|
532
|
+
* Removes all supplied links. Every item must identify the same realm and user.
|
|
533
|
+
* HTTP POST /asset/user/link/delete
|
|
534
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
535
|
+
*/
|
|
536
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
537
|
+
/**
|
|
538
|
+
* Removes every asset link belonging to the user in the requested realm.
|
|
539
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
540
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
541
|
+
*/
|
|
542
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
543
|
+
/**
|
|
544
|
+
* Removes the link identified by realm, user, and asset. The caller must be allowed to administer asset links in that realm.
|
|
545
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
546
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
547
|
+
*/
|
|
548
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
549
|
+
/**
|
|
550
|
+
* Returns a fully loaded asset including its path and attributes. Access is constrained to the caller's realm and, for restricted users, linked assets.
|
|
551
|
+
* HTTP GET /asset/{assetId}
|
|
552
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
553
|
+
*/
|
|
554
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
555
|
+
/**
|
|
556
|
+
* Replaces mutable asset data while preserving the path identifier. Realm, parent, restricted-user, and private-metadata rules are validated; disallowed restricted-user fields may be ignored.
|
|
557
|
+
* HTTP PUT /asset/{assetId}
|
|
558
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
559
|
+
*/
|
|
560
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
561
|
+
/**
|
|
562
|
+
* Submits an asynchronous attribute write using the current server time. The result reports whether the event was accepted, not whether downstream processing ultimately succeeded. Anonymous writes require public-write metadata.
|
|
563
|
+
* Response code 400 - The attribute write failed
|
|
564
|
+
* Response code 406 - The supplied value is not valid for the attribute
|
|
565
|
+
* Response code 429 - The attribute event queue is full; retry the write later
|
|
566
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
567
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
568
|
+
*/
|
|
569
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
570
|
+
/**
|
|
571
|
+
* Submits an asynchronous attribute write using the supplied Unix timestamp in milliseconds. The result reports acceptance only; anonymous writes require public-write metadata.
|
|
572
|
+
* Response code 400 - The attribute write failed
|
|
573
|
+
* Response code 406 - The supplied value is not valid for the attribute
|
|
574
|
+
* Response code 429 - The attribute event queue is full; retry the write later
|
|
575
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
576
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
577
|
+
*/
|
|
578
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
579
|
+
/**
|
|
580
|
+
* Sets parentAssetId as the parent of every asset listed in repeated assetIds query parameters. Parent and children must satisfy realm, access, and hierarchy constraints.
|
|
581
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
582
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
583
|
+
*/
|
|
584
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
585
|
+
assetIds?: string[];
|
|
586
|
+
}, options?: O): RestResponse<void>;
|
|
498
587
|
}
|
|
499
588
|
export declare class NotificationResourceClient<O> {
|
|
500
589
|
protected httpClient: HttpClient<O>;
|
|
@@ -575,544 +664,303 @@ export declare class NotificationResourceClient<O> {
|
|
|
575
664
|
targetId?: string;
|
|
576
665
|
}, options?: O): RestResponse<void>;
|
|
577
666
|
}
|
|
578
|
-
export declare class
|
|
667
|
+
export declare class RulesResourceClient<O> {
|
|
579
668
|
protected httpClient: HttpClient<O>;
|
|
580
669
|
constructor(httpClient: HttpClient<O>);
|
|
581
670
|
/**
|
|
582
|
-
* Creates
|
|
583
|
-
* HTTP POST /
|
|
584
|
-
* Java method: org.openremote.model.
|
|
671
|
+
* Creates and deploys a global ruleset and returns its numeric ID. Super-user access is required; legacy JavaScript rulesets cannot be created.
|
|
672
|
+
* HTTP POST /rules
|
|
673
|
+
* Java method: org.openremote.model.rules.RulesResource.createGlobalRuleset
|
|
585
674
|
*/
|
|
586
|
-
|
|
587
|
-
assetIds?: string[];
|
|
588
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
675
|
+
createGlobalRuleset(ruleset: Model.GlobalRuleset, options?: O): RestResponse<number>;
|
|
589
676
|
/**
|
|
590
|
-
* Returns
|
|
591
|
-
* HTTP GET /
|
|
592
|
-
* Java method: org.openremote.model.
|
|
677
|
+
* Returns global rulesets filtered by repeated language parameters. fullyPopulate controls whether rule source and other large fields are loaded; super-user access is required.
|
|
678
|
+
* HTTP GET /rules
|
|
679
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRulesets
|
|
593
680
|
*/
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
assigneeId?: string;
|
|
599
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
681
|
+
getGlobalRulesets(queryParams?: {
|
|
682
|
+
language?: Model.RulesetLang[];
|
|
683
|
+
fullyPopulate?: boolean;
|
|
684
|
+
}, options?: O): RestResponse<Model.GlobalRuleset[]>;
|
|
600
685
|
/**
|
|
601
|
-
*
|
|
602
|
-
* HTTP
|
|
603
|
-
* Java method: org.openremote.model.
|
|
686
|
+
* Creates and deploys a ruleset for an accessible asset and returns its numeric ID. The assetId is taken from the request body.
|
|
687
|
+
* HTTP POST /rules/asset
|
|
688
|
+
* Java method: org.openremote.model.rules.RulesResource.createAssetRuleset
|
|
604
689
|
*/
|
|
605
|
-
|
|
690
|
+
createAssetRuleset(ruleset: Model.AssetRuleset, options?: O): RestResponse<number>;
|
|
606
691
|
/**
|
|
607
|
-
*
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
|
|
611
|
-
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
612
|
-
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
613
|
-
|
|
614
|
-
Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
|
|
615
|
-
This operation does not remove existing links from the alarm.
|
|
616
|
-
|
|
617
|
-
* HTTP PUT /alarm/assets
|
|
618
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
692
|
+
* Returns asset rulesets filtered by language. Callers without full access receive public rulesets only; a nonexistent asset produces an empty array.
|
|
693
|
+
* HTTP GET /rules/asset/for/{assetId}
|
|
694
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRulesets
|
|
619
695
|
*/
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
625
|
-
*/
|
|
626
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
627
|
-
/**
|
|
628
|
-
* Permanently removes one alarm after verifying access to its realm.
|
|
629
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
630
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
631
|
-
*/
|
|
632
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
633
|
-
/**
|
|
634
|
-
* Updates the mutable state of an existing alarm after verifying access to its current realm.
|
|
635
|
-
* HTTP PUT /alarm/{alarmId}
|
|
636
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
637
|
-
*/
|
|
638
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
639
|
-
/**
|
|
640
|
-
* Returns links from the alarm to assets in the explicitly supplied accessible realm.
|
|
641
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
642
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
643
|
-
*/
|
|
644
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
645
|
-
realm?: string;
|
|
646
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
647
|
-
}
|
|
648
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
649
|
-
protected httpClient: HttpClient<O>;
|
|
650
|
-
constructor(httpClient: HttpClient<O>);
|
|
651
|
-
/**
|
|
652
|
-
* Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
|
|
653
|
-
* Response code 417 - The gateway could not establish the requested tunnel
|
|
654
|
-
* HTTP POST /gateway/tunnel
|
|
655
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
656
|
-
*/
|
|
657
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
658
|
-
/**
|
|
659
|
-
* Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
|
|
660
|
-
* HTTP DELETE /gateway/tunnel
|
|
661
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
662
|
-
*/
|
|
663
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
664
|
-
/**
|
|
665
|
-
* Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
|
|
666
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
667
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
668
|
-
*/
|
|
669
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
670
|
-
/**
|
|
671
|
-
* Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
|
|
672
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
673
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
674
|
-
*/
|
|
675
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
676
|
-
/**
|
|
677
|
-
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
678
|
-
* Response code 204 - No active tunnel matches the requested endpoint
|
|
679
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
680
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
681
|
-
*/
|
|
682
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
683
|
-
}
|
|
684
|
-
export declare class StatusResourceClient<O> {
|
|
685
|
-
protected httpClient: HttpClient<O>;
|
|
686
|
-
constructor(httpClient: HttpClient<O>);
|
|
687
|
-
/**
|
|
688
|
-
* Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
|
|
689
|
-
* HTTP GET /health
|
|
690
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
691
|
-
*/
|
|
692
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
693
|
-
[index: string]: any;
|
|
694
|
-
}>;
|
|
695
|
-
/**
|
|
696
|
-
* Returns public bootstrap information, including the Manager version and identity-provider URL.
|
|
697
|
-
* HTTP GET /info
|
|
698
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
699
|
-
*/
|
|
700
|
-
getInfo(options?: O): RestResponse<{
|
|
701
|
-
[index: string]: any;
|
|
702
|
-
}>;
|
|
703
|
-
}
|
|
704
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
705
|
-
protected httpClient: HttpClient<O>;
|
|
706
|
-
constructor(httpClient: HttpClient<O>);
|
|
707
|
-
/**
|
|
708
|
-
* Queries predicted values for one attribute using the supplied time-range and aggregation criteria. Anonymous access requires public-read access on both asset and attribute.
|
|
709
|
-
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
710
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
711
|
-
*/
|
|
712
|
-
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
713
|
-
/**
|
|
714
|
-
* Replaces or adds predicted values for one attribute. Anonymous access is allowed only when the asset and attribute are public-write; authenticated callers require attribute-write access.
|
|
715
|
-
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
716
|
-
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
717
|
-
*/
|
|
718
|
-
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
719
|
-
}
|
|
720
|
-
export declare class ConsoleResourceClient<O> {
|
|
721
|
-
protected httpClient: HttpClient<O>;
|
|
722
|
-
constructor(httpClient: HttpClient<O>);
|
|
723
|
-
/**
|
|
724
|
-
* Creates an anonymous console registration when id is absent, or updates an existing registration when id is present. Authenticated new registrations are linked to the caller; updates require that link. The returned registration contains the durable asset ID for later calls.
|
|
725
|
-
* HTTP POST /console/register
|
|
726
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
727
|
-
*/
|
|
728
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
729
|
-
}
|
|
730
|
-
export declare class AgentResourceClient<O> {
|
|
731
|
-
protected httpClient: HttpClient<O>;
|
|
732
|
-
constructor(httpClient: HttpClient<O>);
|
|
733
|
-
/**
|
|
734
|
-
* Runs the agent protocol's asset discovery, waits up to ten seconds for results, returns the discovered tree, and asynchronously persists discovered assets below the agent.
|
|
735
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
736
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
737
|
-
*/
|
|
738
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
739
|
-
realm?: string;
|
|
740
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
741
|
-
/**
|
|
742
|
-
* Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
|
|
743
|
-
* Response code 405 - The selected agent protocol does not support asset import
|
|
744
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
745
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
746
|
-
*/
|
|
747
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
748
|
-
realm?: string;
|
|
749
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
750
|
-
/**
|
|
751
|
-
* Runs instance discovery for an agent type and returns candidate Agent assets. parentId selects local versus edge-gateway discovery; non-super users are always constrained to their authenticated realm.
|
|
752
|
-
* Response code 415 - The selected agent protocol does not support instance discovery
|
|
753
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
754
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
755
|
-
*/
|
|
756
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
757
|
-
parentId?: string;
|
|
758
|
-
realm?: string;
|
|
759
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
760
|
-
}
|
|
761
|
-
export declare class AssetModelResourceClient<O> {
|
|
762
|
-
protected httpClient: HttpClient<O>;
|
|
763
|
-
constructor(httpClient: HttpClient<O>);
|
|
764
|
-
/**
|
|
765
|
-
* Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
|
|
766
|
-
* HTTP GET /model/assetDescriptors
|
|
767
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
768
|
-
*/
|
|
769
|
-
getAssetDescriptors(queryParams?: {
|
|
770
|
-
parentId?: string;
|
|
771
|
-
parentType?: string;
|
|
772
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
773
|
-
/**
|
|
774
|
-
* Returns metadata for one asset type from this Manager or, when parentId is below a gateway, from that gateway's model. An unknown or gateway-provided type that is not locally available returns no content.
|
|
775
|
-
* Response code 204 - No model information is available for the requested asset type
|
|
776
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
777
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
778
|
-
*/
|
|
779
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
780
|
-
parentId?: string;
|
|
781
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
782
|
-
/**
|
|
783
|
-
* Returns type metadata from this Manager by default. When parentId identifies an asset below a gateway, the gateway's model is used instead; parentType can provide type context for a new parent that does not yet exist.
|
|
784
|
-
* HTTP GET /model/assetInfos
|
|
785
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
786
|
-
*/
|
|
787
|
-
getAssetInfos(queryParams?: {
|
|
788
|
-
parentId?: string;
|
|
789
|
-
parentType?: string;
|
|
790
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
791
|
-
/**
|
|
792
|
-
* Returns the JSON Schema and a weak ETag for the named value descriptor. Send If-None-Match on later requests to receive 304 when the schema has not changed.
|
|
793
|
-
* Response code 200 - The current JSON Schema
|
|
794
|
-
* Response code 304 - The supplied ETag still identifies the current schema
|
|
795
|
-
* HTTP GET /model/getValueDescriptorSchema
|
|
796
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
797
|
-
*/
|
|
798
|
-
getValueDescriptorSchema(queryParams?: {
|
|
799
|
-
name?: string;
|
|
800
|
-
}, options?: O): RestResponse<any>;
|
|
801
|
-
/**
|
|
802
|
-
* Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
803
|
-
* HTTP GET /model/metaItemDescriptors
|
|
804
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
805
|
-
*/
|
|
806
|
-
getMetaItemDescriptors(queryParams?: {
|
|
807
|
-
parentId?: string;
|
|
808
|
-
}, options?: O): RestResponse<{
|
|
809
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
810
|
-
}>;
|
|
696
|
+
getAssetRulesets(assetId: string, queryParams?: {
|
|
697
|
+
language?: Model.RulesetLang[];
|
|
698
|
+
fullyPopulate?: boolean;
|
|
699
|
+
}, options?: O): RestResponse<Model.AssetRuleset[]>;
|
|
811
700
|
/**
|
|
812
|
-
*
|
|
813
|
-
* HTTP
|
|
814
|
-
* Java method: org.openremote.model.
|
|
701
|
+
* Permanently removes and undeploys one ruleset from an accessible asset.
|
|
702
|
+
* HTTP DELETE /rules/asset/{id}
|
|
703
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteAssetRuleset
|
|
815
704
|
*/
|
|
816
|
-
|
|
817
|
-
parentId?: string;
|
|
818
|
-
}, options?: O): RestResponse<{
|
|
819
|
-
[index: string]: Model.ValueDescriptor;
|
|
820
|
-
}>;
|
|
821
|
-
}
|
|
822
|
-
export declare class ExternalServiceResourceClient<O> {
|
|
823
|
-
protected httpClient: HttpClient<O>;
|
|
824
|
-
constructor(httpClient: HttpClient<O>);
|
|
705
|
+
deleteAssetRuleset(id: number, options?: O): RestResponse<void>;
|
|
825
706
|
/**
|
|
826
|
-
* Returns
|
|
827
|
-
*
|
|
828
|
-
*
|
|
829
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
707
|
+
* Returns one fully populated asset ruleset when the caller can access its realm and owning asset.
|
|
708
|
+
* HTTP GET /rules/asset/{id}
|
|
709
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetRuleset
|
|
830
710
|
*/
|
|
831
|
-
|
|
832
|
-
realm?: string;
|
|
833
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
711
|
+
getAssetRuleset(id: number, options?: O): RestResponse<Model.AssetRuleset>;
|
|
834
712
|
/**
|
|
835
|
-
*
|
|
836
|
-
*
|
|
837
|
-
*
|
|
838
|
-
* Response code 409 - ExternalService instance already registered
|
|
839
|
-
* HTTP POST /service
|
|
840
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
713
|
+
* Replaces and redeploys one asset ruleset. The ID must match and an existing ruleset cannot be reassigned to another asset.
|
|
714
|
+
* HTTP PUT /rules/asset/{id}
|
|
715
|
+
* Java method: org.openremote.model.rules.RulesResource.updateAssetRuleset
|
|
841
716
|
*/
|
|
842
|
-
|
|
717
|
+
updateAssetRuleset(id: number, ruleset: Model.AssetRuleset, options?: O): RestResponse<void>;
|
|
843
718
|
/**
|
|
844
|
-
*
|
|
845
|
-
*
|
|
846
|
-
*
|
|
847
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
719
|
+
* Extracts geofence definitions relevant to the asset. Anonymous access requires a public-readable asset; authenticated restricted users require an asset link.
|
|
720
|
+
* HTTP GET /rules/geofences/{assetId}
|
|
721
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetGeofences
|
|
848
722
|
*/
|
|
849
|
-
|
|
723
|
+
getAssetGeofences(assetId: string, options?: O): RestResponse<Model.GeofenceDefinition[]>;
|
|
850
724
|
/**
|
|
851
|
-
*
|
|
852
|
-
* Response code
|
|
853
|
-
*
|
|
854
|
-
*
|
|
855
|
-
* HTTP POST /service/global
|
|
856
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
725
|
+
* Returns runtime status and error counts for an accessible asset engine. Returns null when the asset or its engine does not exist.
|
|
726
|
+
* Response code 204 - The asset or its rules engine does not exist
|
|
727
|
+
* HTTP GET /rules/info/asset/{assetId}
|
|
728
|
+
* Java method: org.openremote.model.rules.RulesResource.getAssetEngineInfo
|
|
857
729
|
*/
|
|
858
|
-
|
|
730
|
+
getAssetEngineInfo(assetId: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
859
731
|
/**
|
|
860
|
-
*
|
|
861
|
-
* Response code 204 -
|
|
862
|
-
*
|
|
863
|
-
*
|
|
864
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
732
|
+
* Returns runtime status and compilation/execution error counts for the global engine, or null when that engine is not running. Super-user access is required.
|
|
733
|
+
* Response code 204 - The global rules engine is not running
|
|
734
|
+
* HTTP GET /rules/info/global
|
|
735
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalEngineInfo
|
|
865
736
|
*/
|
|
866
|
-
|
|
737
|
+
getGlobalEngineInfo(options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
867
738
|
/**
|
|
868
|
-
* Returns
|
|
869
|
-
* Response code
|
|
870
|
-
*
|
|
871
|
-
*
|
|
872
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
739
|
+
* Returns runtime status and error counts for an accessible realm engine, or null when that engine is not running. Restricted users cannot inspect realm engines.
|
|
740
|
+
* Response code 204 - The requested realm rules engine is not running
|
|
741
|
+
* HTTP GET /rules/info/realm/{realm}
|
|
742
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmEngineInfo
|
|
873
743
|
*/
|
|
874
|
-
|
|
744
|
+
getRealmEngineInfo(realm: string, options?: O): RestResponse<Model.RulesEngineInfo>;
|
|
875
745
|
/**
|
|
876
|
-
*
|
|
877
|
-
*
|
|
878
|
-
*
|
|
879
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
880
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
746
|
+
* Creates and deploys a ruleset in its body realm and returns its numeric ID. Restricted users cannot create realm rulesets; legacy JavaScript is not accepted.
|
|
747
|
+
* HTTP POST /rules/realm
|
|
748
|
+
* Java method: org.openremote.model.rules.RulesResource.createRealmRuleset
|
|
881
749
|
*/
|
|
882
|
-
|
|
883
|
-
}
|
|
884
|
-
export declare class ConfigurationResourceClient<O> {
|
|
885
|
-
protected httpClient: HttpClient<O>;
|
|
886
|
-
constructor(httpClient: HttpClient<O>);
|
|
750
|
+
createRealmRuleset(ruleset: Model.RealmRuleset, options?: O): RestResponse<number>;
|
|
887
751
|
/**
|
|
888
|
-
* Returns
|
|
889
|
-
* HTTP GET /
|
|
890
|
-
* Java method: org.openremote.model.
|
|
752
|
+
* Returns realm rulesets filtered by language. Anonymous, restricted, or callers without read-rules permission receive public rulesets only; fullyPopulate controls loading of rule source.
|
|
753
|
+
* HTTP GET /rules/realm/for/{realm}
|
|
754
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRulesets
|
|
891
755
|
*/
|
|
892
|
-
|
|
756
|
+
getRealmRulesets(realm: string, queryParams?: {
|
|
757
|
+
language?: Model.RulesetLang[];
|
|
758
|
+
fullyPopulate?: boolean;
|
|
759
|
+
}, options?: O): RestResponse<Model.RealmRuleset[]>;
|
|
893
760
|
/**
|
|
894
|
-
*
|
|
895
|
-
* HTTP
|
|
896
|
-
* Java method: org.openremote.model.
|
|
761
|
+
* Permanently removes and undeploys one ruleset from an accessible realm.
|
|
762
|
+
* HTTP DELETE /rules/realm/{id}
|
|
763
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteRealmRuleset
|
|
897
764
|
*/
|
|
898
|
-
|
|
765
|
+
deleteRealmRuleset(id: number, options?: O): RestResponse<void>;
|
|
899
766
|
/**
|
|
900
|
-
*
|
|
901
|
-
* HTTP
|
|
902
|
-
* Java method: org.openremote.model.
|
|
767
|
+
* Returns one fully populated realm ruleset when its realm is accessible to the caller.
|
|
768
|
+
* HTTP GET /rules/realm/{id}
|
|
769
|
+
* Java method: org.openremote.model.rules.RulesResource.getRealmRuleset
|
|
903
770
|
*/
|
|
904
|
-
|
|
905
|
-
path?: string;
|
|
906
|
-
}, options?: O): RestResponse<string>;
|
|
771
|
+
getRealmRuleset(id: number, options?: O): RestResponse<Model.RealmRuleset>;
|
|
907
772
|
/**
|
|
908
|
-
*
|
|
909
|
-
*
|
|
910
|
-
*
|
|
911
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
773
|
+
* Replaces and redeploys one realm ruleset. Path and body IDs and the existing realm must match; legacy JavaScript cannot be updated.
|
|
774
|
+
* HTTP PUT /rules/realm/{id}
|
|
775
|
+
* Java method: org.openremote.model.rules.RulesResource.updateRealmRuleset
|
|
912
776
|
*/
|
|
913
|
-
|
|
914
|
-
|
|
915
|
-
|
|
916
|
-
|
|
917
|
-
|
|
918
|
-
/**
|
|
919
|
-
* Returns every supported flow node definition except the internal LOG_OUTPUT node.
|
|
920
|
-
* HTTP GET /flow
|
|
921
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
777
|
+
updateRealmRuleset(id: number, ruleset: Model.RealmRuleset, options?: O): RestResponse<void>;
|
|
778
|
+
/**
|
|
779
|
+
* Permanently removes and undeploys one global ruleset. Super-user access is required.
|
|
780
|
+
* HTTP DELETE /rules/{id}
|
|
781
|
+
* Java method: org.openremote.model.rules.RulesResource.deleteGlobalRuleset
|
|
922
782
|
*/
|
|
923
|
-
|
|
783
|
+
deleteGlobalRuleset(id: number, options?: O): RestResponse<void>;
|
|
924
784
|
/**
|
|
925
|
-
*
|
|
926
|
-
* HTTP GET /
|
|
927
|
-
* Java method: org.openremote.model.rules.
|
|
785
|
+
* Returns one fully populated global ruleset including transient deployment status and errors. Super-user access is required.
|
|
786
|
+
* HTTP GET /rules/{id}
|
|
787
|
+
* Java method: org.openremote.model.rules.RulesResource.getGlobalRuleset
|
|
928
788
|
*/
|
|
929
|
-
|
|
789
|
+
getGlobalRuleset(id: number, options?: O): RestResponse<Model.GlobalRuleset>;
|
|
930
790
|
/**
|
|
931
|
-
*
|
|
932
|
-
* HTTP
|
|
933
|
-
* Java method: org.openremote.model.rules.
|
|
791
|
+
* Replaces and redeploys the identified global ruleset. Path and body IDs must match; legacy JavaScript rulesets cannot be updated.
|
|
792
|
+
* HTTP PUT /rules/{id}
|
|
793
|
+
* Java method: org.openremote.model.rules.RulesResource.updateGlobalRuleset
|
|
934
794
|
*/
|
|
935
|
-
|
|
795
|
+
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
936
796
|
}
|
|
937
|
-
export declare class
|
|
797
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
938
798
|
protected httpClient: HttpClient<O>;
|
|
939
799
|
constructor(httpClient: HttpClient<O>);
|
|
940
800
|
/**
|
|
941
|
-
*
|
|
942
|
-
* HTTP POST /
|
|
943
|
-
* Java method: org.openremote.model.
|
|
801
|
+
* Queries predicted values for one attribute using the supplied time-range and aggregation criteria. Anonymous access requires public-read access on both asset and attribute.
|
|
802
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
803
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
944
804
|
*/
|
|
945
|
-
|
|
805
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
946
806
|
/**
|
|
947
|
-
*
|
|
948
|
-
* HTTP PUT /
|
|
949
|
-
* Java method: org.openremote.model.
|
|
807
|
+
* Replaces or adds predicted values for one attribute. Anonymous access is allowed only when the asset and attribute are public-write; authenticated callers require attribute-write access.
|
|
808
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
809
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
950
810
|
*/
|
|
951
|
-
|
|
811
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
812
|
+
}
|
|
813
|
+
export declare class UserResourceClient<O> {
|
|
814
|
+
protected httpClient: HttpClient<O>;
|
|
815
|
+
constructor(httpClient: HttpClient<O>);
|
|
952
816
|
/**
|
|
953
|
-
*
|
|
954
|
-
* HTTP
|
|
955
|
-
* Java method: org.openremote.model.
|
|
817
|
+
* Stores the supplied non-empty locale string as the caller's identity-provider locale attribute.
|
|
818
|
+
* HTTP PUT /user/locale
|
|
819
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
956
820
|
*/
|
|
957
|
-
|
|
821
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
958
822
|
/**
|
|
959
|
-
* Executes a
|
|
960
|
-
* HTTP POST /
|
|
961
|
-
* Java method: org.openremote.model.
|
|
823
|
+
* Executes a UserQuery. Non-super users are forced into their authenticated realm and cannot see system accounts; callers with read-users but not read-admin receive basic fields only.
|
|
824
|
+
* HTTP POST /user/query
|
|
825
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
962
826
|
*/
|
|
963
|
-
query(
|
|
827
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
964
828
|
/**
|
|
965
|
-
*
|
|
966
|
-
* HTTP
|
|
967
|
-
* Java method: org.openremote.model.
|
|
829
|
+
* Initiates the identity provider's configured password-reset action for the caller's own account.
|
|
830
|
+
* HTTP PUT /user/request-password-reset
|
|
831
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
968
832
|
*/
|
|
969
|
-
|
|
833
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
970
834
|
/**
|
|
971
|
-
*
|
|
972
|
-
* HTTP
|
|
973
|
-
* Java method: org.openremote.model.
|
|
835
|
+
* Replaces the caller's own identity-provider credential using the supplied credential representation.
|
|
836
|
+
* HTTP PUT /user/reset-password
|
|
837
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
974
838
|
*/
|
|
975
|
-
|
|
976
|
-
}
|
|
977
|
-
export declare class AssetResourceClient<O> {
|
|
978
|
-
protected httpClient: HttpClient<O>;
|
|
979
|
-
constructor(httpClient: HttpClient<O>);
|
|
839
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
980
840
|
/**
|
|
981
|
-
*
|
|
982
|
-
* HTTP
|
|
983
|
-
* Java method: org.openremote.model.
|
|
841
|
+
* Updates the caller's own profile. A supplied user ID must match the access token; role and realm administration are not provided by this endpoint.
|
|
842
|
+
* HTTP PUT /user/update
|
|
843
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
984
844
|
*/
|
|
985
|
-
|
|
845
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
986
846
|
/**
|
|
987
|
-
*
|
|
988
|
-
* HTTP
|
|
989
|
-
* Java method: org.openremote.model.
|
|
847
|
+
* Returns the identity-provider record corresponding to the current access token.
|
|
848
|
+
* HTTP GET /user/user
|
|
849
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
990
850
|
*/
|
|
991
|
-
|
|
992
|
-
assetId?: string[];
|
|
993
|
-
}, options?: O): RestResponse<void>;
|
|
851
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
994
852
|
/**
|
|
995
|
-
*
|
|
996
|
-
* HTTP
|
|
997
|
-
* Java method: org.openremote.model.
|
|
853
|
+
* Returns realm-level role names assigned to the caller.
|
|
854
|
+
* HTTP GET /user/userRealmRoles
|
|
855
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
998
856
|
*/
|
|
999
|
-
|
|
857
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
1000
858
|
/**
|
|
1001
|
-
*
|
|
1002
|
-
* HTTP
|
|
1003
|
-
* Java method: org.openremote.model.
|
|
859
|
+
* Returns role names assigned to the caller for the named identity-provider client.
|
|
860
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
861
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
1004
862
|
*/
|
|
1005
|
-
|
|
863
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
1006
864
|
/**
|
|
1007
|
-
*
|
|
1008
|
-
* HTTP
|
|
1009
|
-
* Java method: org.openremote.model.
|
|
865
|
+
* Terminates the active MQTT connection identified by sessionID.
|
|
866
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
867
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
1010
868
|
*/
|
|
1011
|
-
|
|
869
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
1012
870
|
/**
|
|
1013
|
-
*
|
|
1014
|
-
*
|
|
1015
|
-
*
|
|
871
|
+
* Asks the identity provider to send or initiate its configured password-reset action for the specified user.
|
|
872
|
+
* Response code 405 - The caller cannot mutate a user in the requested realm
|
|
873
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
874
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
1016
875
|
*/
|
|
1017
|
-
|
|
1018
|
-
assetIds?: string[];
|
|
1019
|
-
}, options?: O): RestResponse<void>;
|
|
876
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
1020
877
|
/**
|
|
1021
|
-
*
|
|
1022
|
-
*
|
|
1023
|
-
*
|
|
878
|
+
* Replaces a user's credential in an administered realm using the supplied credential representation.
|
|
879
|
+
* Response code 405 - The caller cannot mutate a user in the requested realm
|
|
880
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
881
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
1024
882
|
*/
|
|
1025
|
-
|
|
883
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
1026
884
|
/**
|
|
1027
|
-
*
|
|
1028
|
-
* HTTP
|
|
1029
|
-
* Java method: org.openremote.model.
|
|
885
|
+
* Generates and returns a new client secret for a service user in an administered realm.
|
|
886
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
887
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
1030
888
|
*/
|
|
1031
|
-
|
|
889
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
1032
890
|
/**
|
|
1033
|
-
*
|
|
1034
|
-
* HTTP
|
|
1035
|
-
* Java method: org.openremote.model.
|
|
891
|
+
* Creates, updates, or removes role definitions for the default OpenRemote client in the requested realm.
|
|
892
|
+
* HTTP PUT /user/{realm}/roles
|
|
893
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
1036
894
|
*/
|
|
1037
|
-
|
|
895
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
1038
896
|
/**
|
|
1039
|
-
* Returns
|
|
1040
|
-
* HTTP GET /
|
|
1041
|
-
* Java method: org.openremote.model.
|
|
897
|
+
* Returns realm-level role names assigned to one user. Without read-admin permission, callers may retrieve only their own roles.
|
|
898
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
899
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
1042
900
|
*/
|
|
1043
|
-
|
|
901
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
1044
902
|
/**
|
|
1045
|
-
*
|
|
1046
|
-
* HTTP
|
|
1047
|
-
* Java method: org.openremote.model.
|
|
903
|
+
* Replaces the user's assigned realm-level role names in an administered realm.
|
|
904
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
905
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
1048
906
|
*/
|
|
1049
|
-
|
|
907
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
1050
908
|
/**
|
|
1051
|
-
* Returns
|
|
1052
|
-
* HTTP GET /
|
|
1053
|
-
* Java method: org.openremote.model.
|
|
909
|
+
* Returns role names assigned to one user for the named client. Without read-admin permission, callers may retrieve only their own roles.
|
|
910
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
911
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
1054
912
|
*/
|
|
1055
|
-
|
|
1056
|
-
realm?: string;
|
|
1057
|
-
userId?: string;
|
|
1058
|
-
assetId?: string;
|
|
1059
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
913
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
1060
914
|
/**
|
|
1061
|
-
*
|
|
1062
|
-
* HTTP
|
|
1063
|
-
* Java method: org.openremote.model.
|
|
915
|
+
* Replaces the user's assigned role names for the named client in an administered realm.
|
|
916
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
917
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
1064
918
|
*/
|
|
1065
|
-
|
|
919
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
1066
920
|
/**
|
|
1067
|
-
*
|
|
1068
|
-
* HTTP
|
|
1069
|
-
* Java method: org.openremote.model.
|
|
921
|
+
* Returns active MQTT sessions for one user, including connection ID, creation time, and remote address. Without read-admin permission, callers may inspect only themselves.
|
|
922
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
923
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
1070
924
|
*/
|
|
1071
|
-
|
|
925
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
1072
926
|
/**
|
|
1073
|
-
*
|
|
1074
|
-
* HTTP
|
|
1075
|
-
* Java method: org.openremote.model.
|
|
927
|
+
* Creates an identity-provider user in a realm administered by the caller and returns the resulting user record.
|
|
928
|
+
* HTTP POST /user/{realm}/users
|
|
929
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
1076
930
|
*/
|
|
1077
|
-
|
|
931
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
1078
932
|
/**
|
|
1079
|
-
*
|
|
1080
|
-
*
|
|
1081
|
-
*
|
|
933
|
+
* Updates an existing identity-provider user in an administered realm. The master administrator cannot be disabled.
|
|
934
|
+
* Response code 405 - The requested cross-realm or protected master-administrator mutation is not allowed
|
|
935
|
+
* HTTP PUT /user/{realm}/users
|
|
936
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
1082
937
|
*/
|
|
1083
|
-
|
|
938
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
1084
939
|
/**
|
|
1085
|
-
*
|
|
1086
|
-
*
|
|
1087
|
-
*
|
|
940
|
+
* Permanently deletes a user from an administered realm. The master-realm administrator cannot be deleted.
|
|
941
|
+
* Response code 405 - The master-realm administrator cannot be deleted
|
|
942
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
943
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
1088
944
|
*/
|
|
1089
|
-
|
|
945
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
1090
946
|
/**
|
|
1091
|
-
*
|
|
1092
|
-
*
|
|
1093
|
-
*
|
|
1094
|
-
* Response code 429 - The attribute event queue is full; retry the write later
|
|
1095
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
1096
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
947
|
+
* Returns all role definitions exposed by the named identity-provider client. Realm-administrator access is required.
|
|
948
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
949
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
1097
950
|
*/
|
|
1098
|
-
|
|
951
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
1099
952
|
/**
|
|
1100
|
-
*
|
|
1101
|
-
*
|
|
1102
|
-
*
|
|
1103
|
-
* Response code 429 - The attribute event queue is full; retry the write later
|
|
1104
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
1105
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
953
|
+
* Creates, updates, or removes role definitions for a named identity-provider client.
|
|
954
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
955
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
1106
956
|
*/
|
|
1107
|
-
|
|
957
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
1108
958
|
/**
|
|
1109
|
-
*
|
|
1110
|
-
* HTTP
|
|
1111
|
-
* Java method: org.openremote.model.
|
|
959
|
+
* Returns one user when it belongs to the requested accessible realm. Without read-admin permission, callers may retrieve only their own user.
|
|
960
|
+
* HTTP GET /user/{realm}/{userId}
|
|
961
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
1112
962
|
*/
|
|
1113
|
-
|
|
1114
|
-
assetIds?: string[];
|
|
1115
|
-
}, options?: O): RestResponse<void>;
|
|
963
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
1116
964
|
}
|
|
1117
965
|
export declare class MapResourceClient<O> {
|
|
1118
966
|
protected httpClient: HttpClient<O>;
|
|
@@ -1168,53 +1016,205 @@ export declare class MapResourceClient<O> {
|
|
|
1168
1016
|
[id: string]: unknown;
|
|
1169
1017
|
}>;
|
|
1170
1018
|
}
|
|
1019
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
1020
|
+
protected httpClient: HttpClient<O>;
|
|
1021
|
+
constructor(httpClient: HttpClient<O>);
|
|
1022
|
+
/**
|
|
1023
|
+
* Streams a ZIP archive containing exported datapoints for one or more attribute references over the requested inclusive time range. attributeRefs is a JSON-encoded array of objects with id and name fields.
|
|
1024
|
+
* Response code 200 - A ZIP archive containing the exported data
|
|
1025
|
+
* HTTP GET /asset/datapoint/export
|
|
1026
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
1027
|
+
*/
|
|
1028
|
+
getDatapointExport(queryParams?: {
|
|
1029
|
+
attributeRefs?: string;
|
|
1030
|
+
fromTimestamp?: number;
|
|
1031
|
+
toTimestamp?: number;
|
|
1032
|
+
format?: Model.DatapointExportFormat;
|
|
1033
|
+
}, options?: O): RestResponse<any>;
|
|
1034
|
+
/**
|
|
1035
|
+
* Returns the oldest and newest stored timestamps for one attribute. The asset and attribute must be readable by the authenticated user and configured for datapoint storage.
|
|
1036
|
+
* HTTP GET /asset/datapoint/periods
|
|
1037
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
1038
|
+
*/
|
|
1039
|
+
getDatapointPeriod(queryParams?: {
|
|
1040
|
+
assetId?: string;
|
|
1041
|
+
attributeName?: string;
|
|
1042
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
1043
|
+
/**
|
|
1044
|
+
* Returns stored historical values for one attribute. A null body returns the available series; a polymorphic query body controls the time range and retrieval or aggregation strategy. Anonymous access requires public-read access on both asset and attribute.
|
|
1045
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
1046
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
1047
|
+
*/
|
|
1048
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
1049
|
+
}
|
|
1050
|
+
export declare class AgentResourceClient<O> {
|
|
1051
|
+
protected httpClient: HttpClient<O>;
|
|
1052
|
+
constructor(httpClient: HttpClient<O>);
|
|
1053
|
+
/**
|
|
1054
|
+
* Runs the agent protocol's asset discovery, waits up to ten seconds for results, returns the discovered tree, and asynchronously persists discovered assets below the agent.
|
|
1055
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
1056
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
1057
|
+
*/
|
|
1058
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
1059
|
+
realm?: string;
|
|
1060
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
1061
|
+
/**
|
|
1062
|
+
* Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
|
|
1063
|
+
* Response code 405 - The selected agent protocol does not support asset import
|
|
1064
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
1065
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
1066
|
+
*/
|
|
1067
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
1068
|
+
realm?: string;
|
|
1069
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
1070
|
+
/**
|
|
1071
|
+
* Runs instance discovery for an agent type and returns candidate Agent assets. parentId selects local versus edge-gateway discovery; non-super users are always constrained to their authenticated realm.
|
|
1072
|
+
* Response code 415 - The selected agent protocol does not support instance discovery
|
|
1073
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
1074
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
1075
|
+
*/
|
|
1076
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
1077
|
+
parentId?: string;
|
|
1078
|
+
realm?: string;
|
|
1079
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
1080
|
+
}
|
|
1081
|
+
export declare class AlarmResourceClient<O> {
|
|
1082
|
+
protected httpClient: HttpClient<O>;
|
|
1083
|
+
constructor(httpClient: HttpClient<O>);
|
|
1084
|
+
/**
|
|
1085
|
+
* Creates a manual alarm in an accessible realm and optionally links it to the supplied asset IDs. The authenticated user or client becomes the alarm source.
|
|
1086
|
+
* HTTP POST /alarm
|
|
1087
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
1088
|
+
*/
|
|
1089
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
1090
|
+
assetIds?: string[];
|
|
1091
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
1092
|
+
/**
|
|
1093
|
+
* Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
|
|
1094
|
+
* HTTP GET /alarm
|
|
1095
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
1096
|
+
*/
|
|
1097
|
+
getAlarms(queryParams?: {
|
|
1098
|
+
realm?: string;
|
|
1099
|
+
status?: Model.AlarmStatus;
|
|
1100
|
+
assetId?: string;
|
|
1101
|
+
assigneeId?: string;
|
|
1102
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
1103
|
+
/**
|
|
1104
|
+
* Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
|
|
1105
|
+
* HTTP DELETE /alarm
|
|
1106
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
1107
|
+
*/
|
|
1108
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
1109
|
+
/**
|
|
1110
|
+
* Adds links between assets and one existing alarm.
|
|
1111
|
+
|
|
1112
|
+
The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
|
|
1113
|
+
every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
|
|
1114
|
+
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
1115
|
+
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
1116
|
+
|
|
1117
|
+
Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
|
|
1118
|
+
This operation does not remove existing links from the alarm.
|
|
1119
|
+
|
|
1120
|
+
* HTTP PUT /alarm/assets
|
|
1121
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
1122
|
+
*/
|
|
1123
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
1124
|
+
/**
|
|
1125
|
+
* Returns one alarm when its realm is active and accessible to the authenticated user.
|
|
1126
|
+
* HTTP GET /alarm/{alarmId}
|
|
1127
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
1128
|
+
*/
|
|
1129
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
1130
|
+
/**
|
|
1131
|
+
* Permanently removes one alarm after verifying access to its realm.
|
|
1132
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
1133
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
1134
|
+
*/
|
|
1135
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
1136
|
+
/**
|
|
1137
|
+
* Updates the mutable state of an existing alarm after verifying access to its current realm.
|
|
1138
|
+
* HTTP PUT /alarm/{alarmId}
|
|
1139
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
1140
|
+
*/
|
|
1141
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
1142
|
+
/**
|
|
1143
|
+
* Returns links from the alarm to assets in the explicitly supplied accessible realm.
|
|
1144
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
1145
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
1146
|
+
*/
|
|
1147
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
1148
|
+
realm?: string;
|
|
1149
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
1150
|
+
}
|
|
1151
|
+
export declare class StatusResourceClient<O> {
|
|
1152
|
+
protected httpClient: HttpClient<O>;
|
|
1153
|
+
constructor(httpClient: HttpClient<O>);
|
|
1154
|
+
/**
|
|
1155
|
+
* Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
|
|
1156
|
+
* HTTP GET /health
|
|
1157
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
1158
|
+
*/
|
|
1159
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
1160
|
+
[index: string]: any;
|
|
1161
|
+
}>;
|
|
1162
|
+
/**
|
|
1163
|
+
* Returns public bootstrap information, including the Manager version and identity-provider URL.
|
|
1164
|
+
* HTTP GET /info
|
|
1165
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
1166
|
+
*/
|
|
1167
|
+
getInfo(options?: O): RestResponse<{
|
|
1168
|
+
[index: string]: any;
|
|
1169
|
+
}>;
|
|
1170
|
+
}
|
|
1171
1171
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
1172
1172
|
export declare class ApiClient {
|
|
1173
|
-
protected
|
|
1174
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1175
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1176
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
1177
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
1173
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1178
1174
|
protected _appResource: AxiosAppResourceClient;
|
|
1179
|
-
protected
|
|
1175
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
1176
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
1180
1177
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
1181
|
-
protected
|
|
1182
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1178
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1183
1179
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
1184
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
1185
|
-
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
1186
1180
|
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1187
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
1188
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1189
|
-
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
1190
1181
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
1191
|
-
protected
|
|
1182
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
1183
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
1192
1184
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
1193
1185
|
protected _assetResource: AxiosAssetResourceClient;
|
|
1186
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
1187
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
1188
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
1189
|
+
protected _userResource: AxiosUserResourceClient;
|
|
1194
1190
|
protected _mapResource: AxiosMapResourceClient;
|
|
1191
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1192
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
1193
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1194
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
1195
1195
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1196
|
-
get
|
|
1197
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1198
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1199
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
1200
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1196
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1201
1197
|
get AppResource(): AxiosAppResourceClient;
|
|
1202
|
-
get
|
|
1198
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1199
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1203
1200
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1204
|
-
get
|
|
1205
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1201
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1206
1202
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1207
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
1208
|
-
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1209
1203
|
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1210
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
1211
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1212
|
-
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1213
1204
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1214
|
-
get
|
|
1205
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1206
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1215
1207
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1216
1208
|
get AssetResource(): AxiosAssetResourceClient;
|
|
1209
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1210
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1211
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1212
|
+
get UserResource(): AxiosUserResourceClient;
|
|
1217
1213
|
get MapResource(): AxiosMapResourceClient;
|
|
1214
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1215
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1216
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1217
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1218
1218
|
}
|
|
1219
1219
|
import * as Axios from "axios";
|
|
1220
1220
|
declare module "axios" {
|
|
@@ -1222,70 +1222,70 @@ declare module "axios" {
|
|
|
1222
1222
|
data: R;
|
|
1223
1223
|
}
|
|
1224
1224
|
}
|
|
1225
|
-
export declare class
|
|
1225
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1226
1226
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1227
1227
|
}
|
|
1228
|
-
export declare class
|
|
1228
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1229
1229
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1230
1230
|
}
|
|
1231
|
-
export declare class
|
|
1231
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1232
1232
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1233
1233
|
}
|
|
1234
|
-
export declare class
|
|
1234
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1235
1235
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1236
1236
|
}
|
|
1237
|
-
export declare class
|
|
1237
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1238
1238
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1239
1239
|
}
|
|
1240
|
-
export declare class
|
|
1240
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1241
1241
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1242
1242
|
}
|
|
1243
|
-
export declare class
|
|
1243
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1244
1244
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1245
1245
|
}
|
|
1246
|
-
export declare class
|
|
1246
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1247
1247
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1248
1248
|
}
|
|
1249
|
-
export declare class
|
|
1249
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1250
1250
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1251
1251
|
}
|
|
1252
|
-
export declare class
|
|
1252
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1253
1253
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1254
1254
|
}
|
|
1255
|
-
export declare class
|
|
1255
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1256
1256
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1257
1257
|
}
|
|
1258
|
-
export declare class
|
|
1258
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1259
1259
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1260
1260
|
}
|
|
1261
|
-
export declare class
|
|
1261
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1262
1262
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1263
1263
|
}
|
|
1264
|
-
export declare class
|
|
1264
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1265
1265
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1266
1266
|
}
|
|
1267
|
-
export declare class
|
|
1267
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1268
1268
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1269
1269
|
}
|
|
1270
|
-
export declare class
|
|
1270
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1271
1271
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1272
1272
|
}
|
|
1273
|
-
export declare class
|
|
1273
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1274
1274
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1275
1275
|
}
|
|
1276
|
-
export declare class
|
|
1276
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1277
1277
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1278
1278
|
}
|
|
1279
|
-
export declare class
|
|
1279
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1280
1280
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1281
1281
|
}
|
|
1282
|
-
export declare class
|
|
1282
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1283
1283
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1284
1284
|
}
|
|
1285
|
-
export declare class
|
|
1285
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1286
1286
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1287
1287
|
}
|
|
1288
|
-
export declare class
|
|
1288
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1289
1289
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1290
1290
|
}
|
|
1291
1291
|
//# sourceMappingURL=restclient.d.ts.map
|