@openremote/rest 1.29.0-snapshot.20260810071738 → 1.29.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 +725 -725
- 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,70 +9,45 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
12
|
+
export declare class DashboardResourceClient<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
|
-
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
21
|
-
/**
|
|
22
|
-
* Validates and applies log-storage and retention settings.
|
|
23
|
-
* HTTP PUT /syslog/config
|
|
24
|
-
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
25
|
-
*/
|
|
26
|
-
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
27
|
-
/**
|
|
28
|
-
* Permanently removes all events from the configured syslog storage.
|
|
29
|
-
* HTTP DELETE /syslog/event
|
|
30
|
-
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
16
|
+
* Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
|
|
17
|
+
* HTTP POST /dashboard
|
|
18
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
31
19
|
*/
|
|
32
|
-
|
|
20
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
33
21
|
/**
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
22
|
+
* Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
|
|
23
|
+
* HTTP PUT /dashboard
|
|
24
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
38
25
|
*/
|
|
39
|
-
|
|
40
|
-
level?: Model.SyslogLevel;
|
|
41
|
-
per_page?: number;
|
|
42
|
-
page?: number;
|
|
43
|
-
from?: number;
|
|
44
|
-
to?: number;
|
|
45
|
-
category?: Model.SyslogCategory[];
|
|
46
|
-
subCategory?: string[];
|
|
47
|
-
}, options?: O): RestResponse<any>;
|
|
48
|
-
}
|
|
49
|
-
export declare class ProvisioningResourceClient<O> {
|
|
50
|
-
protected httpClient: HttpClient<O>;
|
|
51
|
-
constructor(httpClient: HttpClient<O>);
|
|
26
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
52
27
|
/**
|
|
53
|
-
*
|
|
54
|
-
* HTTP
|
|
55
|
-
* Java method: org.openremote.model.
|
|
28
|
+
* 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.
|
|
29
|
+
* HTTP GET /dashboard/all/{realm}
|
|
30
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
56
31
|
*/
|
|
57
|
-
|
|
32
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
58
33
|
/**
|
|
59
|
-
*
|
|
60
|
-
* HTTP
|
|
61
|
-
* Java method: org.openremote.model.
|
|
34
|
+
* 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.
|
|
35
|
+
* HTTP POST /dashboard/query
|
|
36
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
62
37
|
*/
|
|
63
|
-
|
|
38
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
64
39
|
/**
|
|
65
|
-
* Permanently removes
|
|
66
|
-
* HTTP DELETE /
|
|
67
|
-
* Java method: org.openremote.model.
|
|
40
|
+
* Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
|
|
41
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
42
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
68
43
|
*/
|
|
69
|
-
|
|
44
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
70
45
|
/**
|
|
71
|
-
*
|
|
72
|
-
* HTTP
|
|
73
|
-
* Java method: org.openremote.model.
|
|
46
|
+
* Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
|
|
47
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
48
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
74
49
|
*/
|
|
75
|
-
|
|
50
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
76
51
|
}
|
|
77
52
|
export declare class RulesResourceClient<O> {
|
|
78
53
|
protected httpClient: HttpClient<O>;
|
|
@@ -204,89 +179,119 @@ export declare class RulesResourceClient<O> {
|
|
|
204
179
|
*/
|
|
205
180
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
206
181
|
}
|
|
207
|
-
export declare class
|
|
182
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
208
183
|
protected httpClient: HttpClient<O>;
|
|
209
184
|
constructor(httpClient: HttpClient<O>);
|
|
210
185
|
/**
|
|
211
|
-
*
|
|
212
|
-
*
|
|
213
|
-
*
|
|
186
|
+
* Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
|
|
187
|
+
* Response code 417 - The gateway could not establish the requested tunnel
|
|
188
|
+
* HTTP POST /gateway/tunnel
|
|
189
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
214
190
|
*/
|
|
215
|
-
|
|
191
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
216
192
|
/**
|
|
217
|
-
*
|
|
218
|
-
* HTTP
|
|
219
|
-
* Java method: org.openremote.model.
|
|
193
|
+
* Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
|
|
194
|
+
* HTTP DELETE /gateway/tunnel
|
|
195
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
220
196
|
*/
|
|
221
|
-
|
|
197
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
222
198
|
/**
|
|
223
|
-
*
|
|
224
|
-
* HTTP
|
|
225
|
-
* Java method: org.openremote.model.
|
|
199
|
+
* Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
|
|
200
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
201
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
226
202
|
*/
|
|
227
|
-
|
|
228
|
-
path?: string;
|
|
229
|
-
}, options?: O): RestResponse<string>;
|
|
203
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
230
204
|
/**
|
|
231
|
-
*
|
|
232
|
-
*
|
|
233
|
-
*
|
|
234
|
-
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
205
|
+
* Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
|
|
206
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
207
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
235
208
|
*/
|
|
236
|
-
|
|
209
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
210
|
+
/**
|
|
211
|
+
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
212
|
+
* Response code 204 - No active tunnel matches the requested endpoint
|
|
213
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
214
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
215
|
+
*/
|
|
216
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
237
217
|
}
|
|
238
|
-
export declare class
|
|
218
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
239
219
|
protected httpClient: HttpClient<O>;
|
|
240
220
|
constructor(httpClient: HttpClient<O>);
|
|
241
221
|
/**
|
|
242
|
-
*
|
|
243
|
-
*
|
|
244
|
-
*
|
|
245
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
246
|
-
*/
|
|
247
|
-
getDatapointExport(queryParams?: {
|
|
248
|
-
attributeRefs?: string;
|
|
249
|
-
fromTimestamp?: number;
|
|
250
|
-
toTimestamp?: number;
|
|
251
|
-
format?: Model.DatapointExportFormat;
|
|
252
|
-
}, options?: O): RestResponse<any>;
|
|
253
|
-
/**
|
|
254
|
-
* 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.
|
|
255
|
-
* HTTP GET /asset/datapoint/periods
|
|
256
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
222
|
+
* 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.
|
|
223
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
224
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
257
225
|
*/
|
|
258
|
-
|
|
259
|
-
assetId?: string;
|
|
260
|
-
attributeName?: string;
|
|
261
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
226
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
262
227
|
/**
|
|
263
|
-
*
|
|
264
|
-
* HTTP
|
|
265
|
-
* Java method: org.openremote.model.datapoint.
|
|
228
|
+
* 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.
|
|
229
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
230
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
266
231
|
*/
|
|
267
|
-
|
|
232
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
268
233
|
}
|
|
269
|
-
export declare class
|
|
234
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
270
235
|
protected httpClient: HttpClient<O>;
|
|
271
236
|
constructor(httpClient: HttpClient<O>);
|
|
272
237
|
/**
|
|
273
|
-
* Returns
|
|
274
|
-
*
|
|
275
|
-
*
|
|
238
|
+
* Returns all active realm-scoped service registrations for an active realm accessible to the caller.
|
|
239
|
+
* Response code 200 - List of registered external services
|
|
240
|
+
* HTTP GET /service
|
|
241
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
276
242
|
*/
|
|
277
|
-
|
|
243
|
+
getServices(queryParams?: {
|
|
244
|
+
realm?: string;
|
|
245
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
278
246
|
/**
|
|
279
|
-
*
|
|
280
|
-
*
|
|
281
|
-
*
|
|
247
|
+
* 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.
|
|
248
|
+
* Response code 200 - Service registered successfully
|
|
249
|
+
* Response code 400 - Invalid external service object
|
|
250
|
+
* Response code 409 - ExternalService instance already registered
|
|
251
|
+
* HTTP POST /service
|
|
252
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
282
253
|
*/
|
|
283
|
-
|
|
254
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
284
255
|
/**
|
|
285
|
-
* Returns
|
|
286
|
-
*
|
|
287
|
-
*
|
|
256
|
+
* Returns active registrations marked as globally available across realms.
|
|
257
|
+
* Response code 200 - List of registered external services
|
|
258
|
+
* HTTP GET /service/global
|
|
259
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
288
260
|
*/
|
|
289
|
-
|
|
261
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
262
|
+
/**
|
|
263
|
+
* Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
|
|
264
|
+
* Response code 200 - Service registered successfully
|
|
265
|
+
* Response code 400 - Invalid external service object
|
|
266
|
+
* Response code 409 - ExternalService instance already registered
|
|
267
|
+
* HTTP POST /service/global
|
|
268
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
269
|
+
*/
|
|
270
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
271
|
+
/**
|
|
272
|
+
* Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
|
|
273
|
+
* Response code 204 - Service deregistered successfully
|
|
274
|
+
* Response code 404 - Service instance not found
|
|
275
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
276
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
277
|
+
*/
|
|
278
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
279
|
+
/**
|
|
280
|
+
* Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
|
|
281
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
282
|
+
* Response code 404 - ExternalService not found
|
|
283
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
284
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
285
|
+
*/
|
|
286
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
287
|
+
/**
|
|
288
|
+
* 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.
|
|
289
|
+
* Response code 204 - Heartbeat sent successfully
|
|
290
|
+
* Response code 404 - Service instance not found
|
|
291
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
292
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
293
|
+
*/
|
|
294
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
290
295
|
}
|
|
291
296
|
export declare class AssetModelResourceClient<O> {
|
|
292
297
|
protected httpClient: HttpClient<O>;
|
|
@@ -349,39 +354,81 @@ export declare class AssetModelResourceClient<O> {
|
|
|
349
354
|
[index: string]: Model.ValueDescriptor;
|
|
350
355
|
}>;
|
|
351
356
|
}
|
|
352
|
-
export declare class
|
|
357
|
+
export declare class RealmResourceClient<O> {
|
|
353
358
|
protected httpClient: HttpClient<O>;
|
|
354
359
|
constructor(httpClient: HttpClient<O>);
|
|
355
360
|
/**
|
|
356
|
-
* Creates
|
|
357
|
-
* HTTP POST /
|
|
358
|
-
* Java method: org.openremote.model.
|
|
361
|
+
* Creates and configures a realm in the identity provider. This operation is restricted to a super user.
|
|
362
|
+
* HTTP POST /realm
|
|
363
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
359
364
|
*/
|
|
360
|
-
|
|
361
|
-
assetIds?: string[];
|
|
362
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
365
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
363
366
|
/**
|
|
364
|
-
* Returns
|
|
365
|
-
* HTTP GET /
|
|
366
|
-
* Java method: org.openremote.model.
|
|
367
|
+
* Returns complete realm records from the identity provider. This operation is restricted to a super user.
|
|
368
|
+
* HTTP GET /realm
|
|
369
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
367
370
|
*/
|
|
368
|
-
|
|
369
|
-
realm?: string;
|
|
370
|
-
status?: Model.AlarmStatus;
|
|
371
|
-
assetId?: string;
|
|
372
|
-
assigneeId?: string;
|
|
373
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
371
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
374
372
|
/**
|
|
375
|
-
*
|
|
376
|
-
* HTTP
|
|
377
|
-
* Java method: org.openremote.model.
|
|
373
|
+
* Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
|
|
374
|
+
* HTTP GET /realm/accessible
|
|
375
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
378
376
|
*/
|
|
379
|
-
|
|
377
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
380
378
|
/**
|
|
381
|
-
*
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
379
|
+
* Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
|
|
380
|
+
* Response code 405 - The master realm cannot be deleted
|
|
381
|
+
* HTTP DELETE /realm/{name}
|
|
382
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
383
|
+
*/
|
|
384
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
385
|
+
/**
|
|
386
|
+
* 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.
|
|
387
|
+
* HTTP GET /realm/{name}
|
|
388
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
389
|
+
*/
|
|
390
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
391
|
+
/**
|
|
392
|
+
* Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
|
|
393
|
+
* Response code 405 - The requested mutation is not allowed for the master realm
|
|
394
|
+
* HTTP PUT /realm/{name}
|
|
395
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
396
|
+
*/
|
|
397
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
398
|
+
}
|
|
399
|
+
export declare class AlarmResourceClient<O> {
|
|
400
|
+
protected httpClient: HttpClient<O>;
|
|
401
|
+
constructor(httpClient: HttpClient<O>);
|
|
402
|
+
/**
|
|
403
|
+
* 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.
|
|
404
|
+
* HTTP POST /alarm
|
|
405
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
406
|
+
*/
|
|
407
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
408
|
+
assetIds?: string[];
|
|
409
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
410
|
+
/**
|
|
411
|
+
* Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
|
|
412
|
+
* HTTP GET /alarm
|
|
413
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
414
|
+
*/
|
|
415
|
+
getAlarms(queryParams?: {
|
|
416
|
+
realm?: string;
|
|
417
|
+
status?: Model.AlarmStatus;
|
|
418
|
+
assetId?: string;
|
|
419
|
+
assigneeId?: string;
|
|
420
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
421
|
+
/**
|
|
422
|
+
* Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
|
|
423
|
+
* HTTP DELETE /alarm
|
|
424
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
425
|
+
*/
|
|
426
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
427
|
+
/**
|
|
428
|
+
* Adds links between assets and one existing alarm.
|
|
429
|
+
|
|
430
|
+
The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
|
|
431
|
+
every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
|
|
385
432
|
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
386
433
|
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
387
434
|
|
|
@@ -419,138 +466,109 @@ This operation does not remove existing links from the alarm.
|
|
|
419
466
|
realm?: string;
|
|
420
467
|
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
421
468
|
}
|
|
422
|
-
export declare class
|
|
469
|
+
export declare class FlowResourceClient<O> {
|
|
423
470
|
protected httpClient: HttpClient<O>;
|
|
424
471
|
constructor(httpClient: HttpClient<O>);
|
|
425
472
|
/**
|
|
426
|
-
*
|
|
427
|
-
* HTTP GET /
|
|
428
|
-
* Java method: org.openremote.model.
|
|
473
|
+
* Returns every supported flow node definition except the internal LOG_OUTPUT node.
|
|
474
|
+
* HTTP GET /flow
|
|
475
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
429
476
|
*/
|
|
430
|
-
|
|
431
|
-
realm?: string;
|
|
432
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
477
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
433
478
|
/**
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
479
|
+
* Resolves one flow node definition by its model name.
|
|
480
|
+
* HTTP GET /flow/{name}
|
|
481
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
438
482
|
*/
|
|
439
|
-
|
|
440
|
-
realm?: string;
|
|
441
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
483
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
442
484
|
/**
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
485
|
+
* Returns supported flow node definitions whose category matches the requested node type.
|
|
486
|
+
* HTTP GET /flow/{type}
|
|
487
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
447
488
|
*/
|
|
448
|
-
|
|
449
|
-
parentId?: string;
|
|
450
|
-
realm?: string;
|
|
451
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
489
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
452
490
|
}
|
|
453
|
-
export declare class
|
|
491
|
+
export declare class ProvisioningResourceClient<O> {
|
|
454
492
|
protected httpClient: HttpClient<O>;
|
|
455
493
|
constructor(httpClient: HttpClient<O>);
|
|
456
494
|
/**
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
*
|
|
460
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
461
|
-
*/
|
|
462
|
-
getServices(queryParams?: {
|
|
463
|
-
realm?: string;
|
|
464
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
465
|
-
/**
|
|
466
|
-
* 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.
|
|
467
|
-
* Response code 200 - Service registered successfully
|
|
468
|
-
* Response code 400 - Invalid external service object
|
|
469
|
-
* Response code 409 - ExternalService instance already registered
|
|
470
|
-
* HTTP POST /service
|
|
471
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
472
|
-
*/
|
|
473
|
-
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
474
|
-
/**
|
|
475
|
-
* Returns active registrations marked as globally available across realms.
|
|
476
|
-
* Response code 200 - List of registered external services
|
|
477
|
-
* HTTP GET /service/global
|
|
478
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
479
|
-
*/
|
|
480
|
-
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
481
|
-
/**
|
|
482
|
-
* Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
|
|
483
|
-
* Response code 200 - Service registered successfully
|
|
484
|
-
* Response code 400 - Invalid external service object
|
|
485
|
-
* Response code 409 - ExternalService instance already registered
|
|
486
|
-
* HTTP POST /service/global
|
|
487
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
495
|
+
* Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
|
|
496
|
+
* HTTP POST /provisioning
|
|
497
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
488
498
|
*/
|
|
489
|
-
|
|
499
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
490
500
|
/**
|
|
491
|
-
*
|
|
492
|
-
*
|
|
493
|
-
*
|
|
494
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
495
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
501
|
+
* Returns every provisioning configuration. This operation is restricted to a super administrator.
|
|
502
|
+
* HTTP GET /provisioning
|
|
503
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
496
504
|
*/
|
|
497
|
-
|
|
505
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
498
506
|
/**
|
|
499
|
-
*
|
|
500
|
-
*
|
|
501
|
-
*
|
|
502
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
503
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
507
|
+
* Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
508
|
+
* HTTP DELETE /provisioning/{id}
|
|
509
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
504
510
|
*/
|
|
505
|
-
|
|
511
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
506
512
|
/**
|
|
507
|
-
*
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
511
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
513
|
+
* Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
514
|
+
* HTTP PUT /provisioning/{id}
|
|
515
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
512
516
|
*/
|
|
513
|
-
|
|
517
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
514
518
|
}
|
|
515
|
-
export declare class
|
|
519
|
+
export declare class MapResourceClient<O> {
|
|
516
520
|
protected httpClient: HttpClient<O>;
|
|
517
521
|
constructor(httpClient: HttpClient<O>);
|
|
518
522
|
/**
|
|
519
|
-
*
|
|
520
|
-
* HTTP
|
|
521
|
-
* Java method: org.openremote.model.
|
|
523
|
+
* Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
|
|
524
|
+
* HTTP GET /map
|
|
525
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
522
526
|
*/
|
|
523
|
-
|
|
527
|
+
getSettings(options?: O): RestResponse<{
|
|
528
|
+
[id: string]: unknown;
|
|
529
|
+
}>;
|
|
524
530
|
/**
|
|
525
|
-
*
|
|
526
|
-
* HTTP PUT /
|
|
527
|
-
* Java method: org.openremote.model.
|
|
531
|
+
* Stores the map configuration and returns the resulting public MapLibre settings.
|
|
532
|
+
* HTTP PUT /map
|
|
533
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
528
534
|
*/
|
|
529
|
-
|
|
535
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
536
|
+
[id: string]: unknown;
|
|
537
|
+
}>;
|
|
530
538
|
/**
|
|
531
|
-
*
|
|
532
|
-
* HTTP
|
|
533
|
-
* Java method: org.openremote.model.
|
|
539
|
+
* Deletes the installed custom MBTiles database and returns the fallback public map settings.
|
|
540
|
+
* HTTP DELETE /map/deleteMap
|
|
541
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
534
542
|
*/
|
|
535
|
-
|
|
543
|
+
deleteMap(options?: O): RestResponse<{
|
|
544
|
+
[id: string]: unknown;
|
|
545
|
+
}>;
|
|
536
546
|
/**
|
|
537
|
-
*
|
|
538
|
-
* HTTP
|
|
539
|
-
* Java method: org.openremote.model.
|
|
547
|
+
* Reports whether custom MBTiles data is installed and the maximum accepted upload size.
|
|
548
|
+
* HTTP GET /map/getCustomMapInfo
|
|
549
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
540
550
|
*/
|
|
541
|
-
|
|
551
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
552
|
+
[id: string]: unknown;
|
|
553
|
+
}>;
|
|
542
554
|
/**
|
|
543
|
-
*
|
|
544
|
-
*
|
|
545
|
-
*
|
|
555
|
+
* Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
|
|
556
|
+
* Response code 200 - Gzip-compressed vector tile
|
|
557
|
+
* Response code 204 - No tile exists at the requested coordinates
|
|
558
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
559
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
546
560
|
*/
|
|
547
|
-
|
|
561
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
548
562
|
/**
|
|
549
|
-
*
|
|
550
|
-
* HTTP
|
|
551
|
-
* Java method: org.openremote.model.
|
|
563
|
+
* Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings.
|
|
564
|
+
* HTTP POST /map/upload
|
|
565
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
552
566
|
*/
|
|
553
|
-
|
|
567
|
+
uploadMap(queryParams?: {
|
|
568
|
+
filename?: string;
|
|
569
|
+
}, options?: O): RestResponse<{
|
|
570
|
+
[id: string]: unknown;
|
|
571
|
+
}>;
|
|
554
572
|
}
|
|
555
573
|
export declare class ConsoleResourceClient<O> {
|
|
556
574
|
protected httpClient: HttpClient<O>;
|
|
@@ -562,659 +580,641 @@ export declare class ConsoleResourceClient<O> {
|
|
|
562
580
|
*/
|
|
563
581
|
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
564
582
|
}
|
|
565
|
-
export declare class
|
|
583
|
+
export declare class SyslogResourceClient<O> {
|
|
566
584
|
protected httpClient: HttpClient<O>;
|
|
567
585
|
constructor(httpClient: HttpClient<O>);
|
|
568
586
|
/**
|
|
569
|
-
*
|
|
570
|
-
* HTTP
|
|
571
|
-
* Java method: org.openremote.model.
|
|
587
|
+
* Returns the current log-storage and retention configuration.
|
|
588
|
+
* HTTP GET /syslog/config
|
|
589
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
572
590
|
*/
|
|
573
|
-
|
|
591
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
574
592
|
/**
|
|
575
|
-
*
|
|
576
|
-
* HTTP
|
|
577
|
-
* Java method: org.openremote.model.
|
|
593
|
+
* Validates and applies log-storage and retention settings.
|
|
594
|
+
* HTTP PUT /syslog/config
|
|
595
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
578
596
|
*/
|
|
579
|
-
|
|
580
|
-
assetId?: string[];
|
|
581
|
-
}, options?: O): RestResponse<void>;
|
|
597
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
582
598
|
/**
|
|
583
|
-
*
|
|
584
|
-
* HTTP
|
|
585
|
-
* Java method: org.openremote.model.
|
|
599
|
+
* Permanently removes all events from the configured syslog storage.
|
|
600
|
+
* HTTP DELETE /syslog/event
|
|
601
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
586
602
|
*/
|
|
587
|
-
|
|
603
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
588
604
|
/**
|
|
589
|
-
*
|
|
590
|
-
*
|
|
591
|
-
*
|
|
605
|
+
* 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.
|
|
606
|
+
* Response code 200 - The requested page of syslog events
|
|
607
|
+
* HTTP GET /syslog/event
|
|
608
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
592
609
|
*/
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
610
|
+
getEvents(queryParams?: {
|
|
611
|
+
level?: Model.SyslogLevel;
|
|
612
|
+
per_page?: number;
|
|
613
|
+
page?: number;
|
|
614
|
+
from?: number;
|
|
615
|
+
to?: number;
|
|
616
|
+
category?: Model.SyslogCategory[];
|
|
617
|
+
subCategory?: string[];
|
|
618
|
+
}, options?: O): RestResponse<any>;
|
|
619
|
+
}
|
|
620
|
+
export declare class GatewayClientResourceClient<O> {
|
|
621
|
+
protected httpClient: HttpClient<O>;
|
|
622
|
+
constructor(httpClient: HttpClient<O>);
|
|
600
623
|
/**
|
|
601
|
-
*
|
|
602
|
-
* HTTP DELETE /
|
|
603
|
-
* Java method: org.openremote.model.
|
|
624
|
+
* Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
|
|
625
|
+
* HTTP DELETE /gateway/connection
|
|
626
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
604
627
|
*/
|
|
605
|
-
|
|
606
|
-
|
|
628
|
+
deleteConnections(queryParams?: {
|
|
629
|
+
realm?: string[];
|
|
607
630
|
}, options?: O): RestResponse<void>;
|
|
608
631
|
/**
|
|
609
|
-
* Returns
|
|
610
|
-
* HTTP GET /
|
|
611
|
-
* Java method: org.openremote.model.
|
|
612
|
-
*/
|
|
613
|
-
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
614
|
-
/**
|
|
615
|
-
* 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.
|
|
616
|
-
* HTTP POST /asset/query
|
|
617
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
618
|
-
*/
|
|
619
|
-
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
620
|
-
/**
|
|
621
|
-
* Applies the same authorization and selection rules as queryAssets, then returns a hierarchy optimized for tree display rather than a flat asset array.
|
|
622
|
-
* HTTP POST /asset/tree
|
|
623
|
-
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
624
|
-
*/
|
|
625
|
-
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
626
|
-
/**
|
|
627
|
-
* 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.
|
|
628
|
-
* HTTP GET /asset/user/current
|
|
629
|
-
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
630
|
-
*/
|
|
631
|
-
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
632
|
-
/**
|
|
633
|
-
* 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.
|
|
634
|
-
* HTTP POST /asset/user/link
|
|
635
|
-
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
636
|
-
*/
|
|
637
|
-
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
638
|
-
/**
|
|
639
|
-
* 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.
|
|
640
|
-
* HTTP GET /asset/user/link
|
|
641
|
-
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
632
|
+
* Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
|
|
633
|
+
* HTTP GET /gateway/connection
|
|
634
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
642
635
|
*/
|
|
643
|
-
|
|
644
|
-
realm?: string;
|
|
645
|
-
userId?: string;
|
|
646
|
-
assetId?: string;
|
|
647
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
636
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
648
637
|
/**
|
|
649
|
-
* Removes
|
|
650
|
-
* HTTP
|
|
651
|
-
* Java method: org.openremote.model.
|
|
638
|
+
* Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
|
|
639
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
640
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
652
641
|
*/
|
|
653
|
-
|
|
642
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
654
643
|
/**
|
|
655
|
-
*
|
|
656
|
-
*
|
|
657
|
-
*
|
|
644
|
+
* Returns the central-manager connection configured for a realm, or null when none exists. Realm administrators can read their own realm; super users can read any realm.
|
|
645
|
+
* Response code 204 - No gateway connection is configured for the realm
|
|
646
|
+
* HTTP GET /gateway/connection/{realm}
|
|
647
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
658
648
|
*/
|
|
659
|
-
|
|
649
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
660
650
|
/**
|
|
661
|
-
*
|
|
662
|
-
* HTTP
|
|
663
|
-
* Java method: org.openremote.model.
|
|
651
|
+
* Creates or replaces the connection for the path realm. The server forces the local realm, including realm predicates in attribute filters, to match the path.
|
|
652
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
653
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
664
654
|
*/
|
|
665
|
-
|
|
655
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
666
656
|
/**
|
|
667
|
-
* Returns
|
|
668
|
-
* HTTP GET /
|
|
669
|
-
* Java method: org.openremote.model.
|
|
657
|
+
* Returns the live connection state for the requested local realm.
|
|
658
|
+
* HTTP GET /gateway/status/{realm}
|
|
659
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
670
660
|
*/
|
|
671
|
-
|
|
661
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
662
|
+
}
|
|
663
|
+
export declare class StatusResourceClient<O> {
|
|
664
|
+
protected httpClient: HttpClient<O>;
|
|
665
|
+
constructor(httpClient: HttpClient<O>);
|
|
672
666
|
/**
|
|
673
|
-
*
|
|
674
|
-
* HTTP
|
|
675
|
-
* Java method: org.openremote.model.
|
|
667
|
+
* Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
|
|
668
|
+
* HTTP GET /health
|
|
669
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
676
670
|
*/
|
|
677
|
-
|
|
671
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
672
|
+
[index: string]: any;
|
|
673
|
+
}>;
|
|
678
674
|
/**
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
-
*
|
|
682
|
-
* Response code 429 - The attribute event queue is full; retry the write later
|
|
683
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
684
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
675
|
+
* Returns public bootstrap information, including the Manager version and identity-provider URL.
|
|
676
|
+
* HTTP GET /info
|
|
677
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
685
678
|
*/
|
|
686
|
-
|
|
679
|
+
getInfo(options?: O): RestResponse<{
|
|
680
|
+
[index: string]: any;
|
|
681
|
+
}>;
|
|
682
|
+
}
|
|
683
|
+
export declare class UserResourceClient<O> {
|
|
684
|
+
protected httpClient: HttpClient<O>;
|
|
685
|
+
constructor(httpClient: HttpClient<O>);
|
|
687
686
|
/**
|
|
688
|
-
*
|
|
689
|
-
*
|
|
690
|
-
*
|
|
691
|
-
* Response code 429 - The attribute event queue is full; retry the write later
|
|
692
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
693
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
687
|
+
* Stores the supplied non-empty locale string as the caller's identity-provider locale attribute.
|
|
688
|
+
* HTTP PUT /user/locale
|
|
689
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrentUserLocale
|
|
694
690
|
*/
|
|
695
|
-
|
|
691
|
+
updateCurrentUserLocale(locale: string, options?: O): RestResponse<void>;
|
|
696
692
|
/**
|
|
697
|
-
*
|
|
698
|
-
* HTTP
|
|
699
|
-
* Java method: org.openremote.model.
|
|
693
|
+
* 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.
|
|
694
|
+
* HTTP POST /user/query
|
|
695
|
+
* Java method: org.openremote.model.security.UserResource.query
|
|
700
696
|
*/
|
|
701
|
-
|
|
702
|
-
assetIds?: string[];
|
|
703
|
-
}, options?: O): RestResponse<void>;
|
|
704
|
-
}
|
|
705
|
-
export declare class NotificationResourceClient<O> {
|
|
706
|
-
protected httpClient: HttpClient<O>;
|
|
707
|
-
constructor(httpClient: HttpClient<O>);
|
|
697
|
+
query(query: Model.UserQuery, options?: O): RestResponse<Model.User[]>;
|
|
708
698
|
/**
|
|
709
|
-
*
|
|
710
|
-
* HTTP
|
|
711
|
-
* Java method: org.openremote.model.
|
|
699
|
+
* Initiates the identity provider's configured password-reset action for the caller's own account.
|
|
700
|
+
* HTTP PUT /user/request-password-reset
|
|
701
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordResetCurrent
|
|
712
702
|
*/
|
|
713
|
-
|
|
714
|
-
id?: number;
|
|
715
|
-
type?: string;
|
|
716
|
-
from?: number;
|
|
717
|
-
to?: number;
|
|
718
|
-
realmId?: string;
|
|
719
|
-
userId?: string;
|
|
720
|
-
assetId?: string;
|
|
721
|
-
source?: Model.NotificationSource;
|
|
722
|
-
sort?: Model.SentNotificationSortField;
|
|
723
|
-
descending?: boolean;
|
|
724
|
-
offset?: number;
|
|
725
|
-
limit?: number;
|
|
726
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
703
|
+
requestPasswordResetCurrent(options?: O): RestResponse<void>;
|
|
727
704
|
/**
|
|
728
|
-
*
|
|
729
|
-
* HTTP
|
|
730
|
-
* Java method: org.openremote.model.
|
|
705
|
+
* Replaces the caller's own identity-provider credential using the supplied credential representation.
|
|
706
|
+
* HTTP PUT /user/reset-password
|
|
707
|
+
* Java method: org.openremote.model.security.UserResource.updatePasswordCurrent
|
|
731
708
|
*/
|
|
732
|
-
|
|
733
|
-
id?: number;
|
|
734
|
-
type?: string;
|
|
735
|
-
from?: number;
|
|
736
|
-
to?: number;
|
|
737
|
-
realmId?: string;
|
|
738
|
-
userId?: string;
|
|
739
|
-
assetId?: string;
|
|
740
|
-
}, options?: O): RestResponse<void>;
|
|
709
|
+
updatePasswordCurrent(credential: Model.Credential, options?: O): RestResponse<void>;
|
|
741
710
|
/**
|
|
742
|
-
*
|
|
743
|
-
* HTTP
|
|
744
|
-
* Java method: org.openremote.model.
|
|
711
|
+
* 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.
|
|
712
|
+
* HTTP PUT /user/update
|
|
713
|
+
* Java method: org.openremote.model.security.UserResource.updateCurrent
|
|
745
714
|
*/
|
|
746
|
-
|
|
715
|
+
updateCurrent(user: Model.User, options?: O): RestResponse<Model.User>;
|
|
747
716
|
/**
|
|
748
|
-
* Returns the
|
|
749
|
-
* HTTP GET /
|
|
750
|
-
* Java method: org.openremote.model.
|
|
717
|
+
* Returns the identity-provider record corresponding to the current access token.
|
|
718
|
+
* HTTP GET /user/user
|
|
719
|
+
* Java method: org.openremote.model.security.UserResource.getCurrent
|
|
751
720
|
*/
|
|
752
|
-
|
|
753
|
-
type?: string;
|
|
754
|
-
from?: number;
|
|
755
|
-
to?: number;
|
|
756
|
-
realmId?: string;
|
|
757
|
-
userId?: string;
|
|
758
|
-
assetId?: string;
|
|
759
|
-
source?: Model.NotificationSource;
|
|
760
|
-
}, options?: O): RestResponse<number>;
|
|
721
|
+
getCurrent(options?: O): RestResponse<Model.User>;
|
|
761
722
|
/**
|
|
762
|
-
*
|
|
763
|
-
* HTTP
|
|
764
|
-
* Java method: org.openremote.model.
|
|
723
|
+
* Returns realm-level role names assigned to the caller.
|
|
724
|
+
* HTTP GET /user/userRealmRoles
|
|
725
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserRealmRoles
|
|
765
726
|
*/
|
|
766
|
-
|
|
727
|
+
getCurrentUserRealmRoles(options?: O): RestResponse<string[]>;
|
|
767
728
|
/**
|
|
768
|
-
*
|
|
769
|
-
* HTTP
|
|
770
|
-
* Java method: org.openremote.model.
|
|
729
|
+
* Returns role names assigned to the caller for the named identity-provider client.
|
|
730
|
+
* HTTP GET /user/userRoles/{clientId}
|
|
731
|
+
* Java method: org.openremote.model.security.UserResource.getCurrentUserClientRoles
|
|
771
732
|
*/
|
|
772
|
-
|
|
773
|
-
targetId?: string;
|
|
774
|
-
}, options?: O): RestResponse<void>;
|
|
733
|
+
getCurrentUserClientRoles(clientId: string, options?: O): RestResponse<string[]>;
|
|
775
734
|
/**
|
|
776
|
-
*
|
|
777
|
-
* HTTP
|
|
778
|
-
* Java method: org.openremote.model.
|
|
735
|
+
* Terminates the active MQTT connection identified by sessionID.
|
|
736
|
+
* HTTP GET /user/{realm}/disconnect/{sessionID}
|
|
737
|
+
* Java method: org.openremote.model.security.UserResource.disconnectUserSession
|
|
779
738
|
*/
|
|
780
|
-
|
|
781
|
-
targetId?: string;
|
|
782
|
-
}, options?: O): RestResponse<void>;
|
|
783
|
-
}
|
|
784
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
785
|
-
protected httpClient: HttpClient<O>;
|
|
786
|
-
constructor(httpClient: HttpClient<O>);
|
|
739
|
+
disconnectUserSession(realm: string, sessionID: string, options?: O): RestResponse<void>;
|
|
787
740
|
/**
|
|
788
|
-
*
|
|
789
|
-
* Response code
|
|
790
|
-
* HTTP
|
|
791
|
-
* Java method: org.openremote.model.
|
|
741
|
+
* Asks the identity provider to send or initiate its configured password-reset action for the specified user.
|
|
742
|
+
* Response code 405 - The caller cannot mutate a user in the requested realm
|
|
743
|
+
* HTTP PUT /user/{realm}/request-password-reset/{userId}
|
|
744
|
+
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
792
745
|
*/
|
|
793
|
-
|
|
746
|
+
requestPasswordReset(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
794
747
|
/**
|
|
795
|
-
*
|
|
796
|
-
*
|
|
797
|
-
*
|
|
748
|
+
* Replaces a user's credential in an administered realm using the supplied credential representation.
|
|
749
|
+
* Response code 405 - The caller cannot mutate a user in the requested realm
|
|
750
|
+
* HTTP PUT /user/{realm}/reset-password/{userId}
|
|
751
|
+
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
798
752
|
*/
|
|
799
|
-
|
|
753
|
+
updatePassword(realm: string, userId: string, credential: Model.Credential, options?: O): RestResponse<void>;
|
|
800
754
|
/**
|
|
801
|
-
*
|
|
802
|
-
* HTTP GET /
|
|
803
|
-
* Java method: org.openremote.model.
|
|
755
|
+
* Generates and returns a new client secret for a service user in an administered realm.
|
|
756
|
+
* HTTP GET /user/{realm}/reset-secret/{userId}
|
|
757
|
+
* Java method: org.openremote.model.security.UserResource.resetSecret
|
|
804
758
|
*/
|
|
805
|
-
|
|
759
|
+
resetSecret(realm: string, userId: string, options?: O): RestResponse<string>;
|
|
806
760
|
/**
|
|
807
|
-
*
|
|
808
|
-
* HTTP
|
|
809
|
-
* Java method: org.openremote.model.
|
|
761
|
+
* Creates, updates, or removes role definitions for the default OpenRemote client in the requested realm.
|
|
762
|
+
* HTTP PUT /user/{realm}/roles
|
|
763
|
+
* Java method: org.openremote.model.security.UserResource.updateRoles
|
|
810
764
|
*/
|
|
811
|
-
|
|
765
|
+
updateRoles(realm: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
812
766
|
/**
|
|
813
|
-
* Returns
|
|
814
|
-
*
|
|
815
|
-
*
|
|
816
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
767
|
+
* Returns realm-level role names assigned to one user. Without read-admin permission, callers may retrieve only their own roles.
|
|
768
|
+
* HTTP GET /user/{realm}/userRealmRoles/{userId}
|
|
769
|
+
* Java method: org.openremote.model.security.UserResource.getUserRealmRoles
|
|
817
770
|
*/
|
|
818
|
-
|
|
819
|
-
}
|
|
820
|
-
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
821
|
-
protected httpClient: HttpClient<O>;
|
|
822
|
-
constructor(httpClient: HttpClient<O>);
|
|
771
|
+
getUserRealmRoles(realm: string, userId: string, options?: O): RestResponse<string[]>;
|
|
823
772
|
/**
|
|
824
|
-
*
|
|
825
|
-
* HTTP
|
|
826
|
-
* Java method: org.openremote.model.
|
|
773
|
+
* Replaces the user's assigned realm-level role names in an administered realm.
|
|
774
|
+
* HTTP PUT /user/{realm}/userRealmRoles/{userId}
|
|
775
|
+
* Java method: org.openremote.model.security.UserResource.updateUserRealmRoles
|
|
827
776
|
*/
|
|
828
|
-
|
|
777
|
+
updateUserRealmRoles(realm: string, userId: string, roles: string[], options?: O): RestResponse<void>;
|
|
829
778
|
/**
|
|
830
|
-
*
|
|
831
|
-
* HTTP
|
|
832
|
-
* Java method: org.openremote.model.
|
|
779
|
+
* Returns role names assigned to one user for the named client. Without read-admin permission, callers may retrieve only their own roles.
|
|
780
|
+
* HTTP GET /user/{realm}/userRoles/{userId}/{clientId}
|
|
781
|
+
* Java method: org.openremote.model.security.UserResource.getUserClientRoles
|
|
833
782
|
*/
|
|
834
|
-
|
|
835
|
-
}
|
|
836
|
-
export declare class StatusResourceClient<O> {
|
|
837
|
-
protected httpClient: HttpClient<O>;
|
|
838
|
-
constructor(httpClient: HttpClient<O>);
|
|
783
|
+
getUserClientRoles(realm: string, userId: string, clientId: string, options?: O): RestResponse<string[]>;
|
|
839
784
|
/**
|
|
840
|
-
*
|
|
841
|
-
* HTTP
|
|
842
|
-
* Java method: org.openremote.model.
|
|
785
|
+
* Replaces the user's assigned role names for the named client in an administered realm.
|
|
786
|
+
* HTTP PUT /user/{realm}/userRoles/{userId}/{clientId}
|
|
787
|
+
* Java method: org.openremote.model.security.UserResource.updateUserClientRoles
|
|
843
788
|
*/
|
|
844
|
-
|
|
845
|
-
[index: string]: any;
|
|
846
|
-
}>;
|
|
789
|
+
updateUserClientRoles(realm: string, userId: string, clientId: string, roles: string[], options?: O): RestResponse<void>;
|
|
847
790
|
/**
|
|
848
|
-
* Returns
|
|
849
|
-
* HTTP GET /
|
|
850
|
-
* Java method: org.openremote.model.
|
|
791
|
+
* Returns active MQTT sessions for one user, including connection ID, creation time, and remote address. Without read-admin permission, callers may inspect only themselves.
|
|
792
|
+
* HTTP GET /user/{realm}/userSessions/{userId}
|
|
793
|
+
* Java method: org.openremote.model.security.UserResource.getUserSessions
|
|
851
794
|
*/
|
|
852
|
-
|
|
853
|
-
[index: string]: any;
|
|
854
|
-
}>;
|
|
855
|
-
}
|
|
856
|
-
export declare class RealmResourceClient<O> {
|
|
857
|
-
protected httpClient: HttpClient<O>;
|
|
858
|
-
constructor(httpClient: HttpClient<O>);
|
|
795
|
+
getUserSessions(realm: string, userId: string, options?: O): RestResponse<Model.UserSession[]>;
|
|
859
796
|
/**
|
|
860
|
-
* Creates
|
|
861
|
-
* HTTP POST /realm
|
|
862
|
-
* Java method: org.openremote.model.security.
|
|
797
|
+
* Creates an identity-provider user in a realm administered by the caller and returns the resulting user record.
|
|
798
|
+
* HTTP POST /user/{realm}/users
|
|
799
|
+
* Java method: org.openremote.model.security.UserResource.create
|
|
863
800
|
*/
|
|
864
|
-
create(realm: Model.
|
|
801
|
+
create(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
865
802
|
/**
|
|
866
|
-
*
|
|
867
|
-
*
|
|
868
|
-
*
|
|
803
|
+
* Updates an existing identity-provider user in an administered realm. The master administrator cannot be disabled.
|
|
804
|
+
* Response code 405 - The requested cross-realm or protected master-administrator mutation is not allowed
|
|
805
|
+
* HTTP PUT /user/{realm}/users
|
|
806
|
+
* Java method: org.openremote.model.security.UserResource.update
|
|
869
807
|
*/
|
|
870
|
-
|
|
808
|
+
update(realm: string, user: Model.User, options?: O): RestResponse<Model.User>;
|
|
871
809
|
/**
|
|
872
|
-
*
|
|
873
|
-
*
|
|
874
|
-
*
|
|
810
|
+
* Permanently deletes a user from an administered realm. The master-realm administrator cannot be deleted.
|
|
811
|
+
* Response code 405 - The master-realm administrator cannot be deleted
|
|
812
|
+
* HTTP DELETE /user/{realm}/users/{userId}
|
|
813
|
+
* Java method: org.openremote.model.security.UserResource.delete
|
|
875
814
|
*/
|
|
876
|
-
|
|
815
|
+
delete(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
877
816
|
/**
|
|
878
|
-
*
|
|
879
|
-
*
|
|
880
|
-
*
|
|
881
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
817
|
+
* Returns all role definitions exposed by the named identity-provider client. Realm-administrator access is required.
|
|
818
|
+
* HTTP GET /user/{realm}/{clientId}/roles
|
|
819
|
+
* Java method: org.openremote.model.security.UserResource.getClientRoles
|
|
882
820
|
*/
|
|
883
|
-
|
|
821
|
+
getClientRoles(realm: string, clientId: string, options?: O): RestResponse<Model.Role[]>;
|
|
884
822
|
/**
|
|
885
|
-
*
|
|
886
|
-
* HTTP
|
|
887
|
-
* Java method: org.openremote.model.security.
|
|
823
|
+
* Creates, updates, or removes role definitions for a named identity-provider client.
|
|
824
|
+
* HTTP PUT /user/{realm}/{clientId}/roles
|
|
825
|
+
* Java method: org.openremote.model.security.UserResource.updateClientRoles
|
|
888
826
|
*/
|
|
889
|
-
|
|
827
|
+
updateClientRoles(realm: string, clientId: string, roles: Model.Role[], options?: O): RestResponse<void>;
|
|
890
828
|
/**
|
|
891
|
-
*
|
|
892
|
-
*
|
|
893
|
-
*
|
|
894
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
829
|
+
* Returns one user when it belongs to the requested accessible realm. Without read-admin permission, callers may retrieve only their own user.
|
|
830
|
+
* HTTP GET /user/{realm}/{userId}
|
|
831
|
+
* Java method: org.openremote.model.security.UserResource.get
|
|
895
832
|
*/
|
|
896
|
-
|
|
833
|
+
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
897
834
|
}
|
|
898
|
-
export declare class
|
|
835
|
+
export declare class ConfigurationResourceClient<O> {
|
|
899
836
|
protected httpClient: HttpClient<O>;
|
|
900
837
|
constructor(httpClient: HttpClient<O>);
|
|
901
838
|
/**
|
|
902
|
-
*
|
|
903
|
-
* HTTP
|
|
904
|
-
* Java method: org.openremote.model.
|
|
839
|
+
* Returns the public Manager application configuration used by clients before and after authentication.
|
|
840
|
+
* HTTP GET /configuration/manager
|
|
841
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
905
842
|
*/
|
|
906
|
-
|
|
907
|
-
realm?: string[];
|
|
908
|
-
}, options?: O): RestResponse<void>;
|
|
843
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
909
844
|
/**
|
|
910
|
-
*
|
|
911
|
-
* HTTP
|
|
912
|
-
* Java method: org.openremote.model.
|
|
845
|
+
* Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
|
|
846
|
+
* HTTP PUT /configuration/manager
|
|
847
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
913
848
|
*/
|
|
914
|
-
|
|
849
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
915
850
|
/**
|
|
916
|
-
*
|
|
917
|
-
* HTTP
|
|
918
|
-
* Java method: org.openremote.model.
|
|
851
|
+
* Decodes and stores the supplied FileInfo under the requested relative path, then returns its Manager API path.
|
|
852
|
+
* HTTP POST /configuration/manager/file
|
|
853
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
854
|
+
*/
|
|
855
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
856
|
+
path?: string;
|
|
857
|
+
}, options?: O): RestResponse<string>;
|
|
858
|
+
/**
|
|
859
|
+
* Streams a previously uploaded configuration image using its detected media type.
|
|
860
|
+
* Response code 200 - The image file
|
|
861
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
862
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
919
863
|
*/
|
|
920
|
-
|
|
864
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
865
|
+
}
|
|
866
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
867
|
+
protected httpClient: HttpClient<O>;
|
|
868
|
+
constructor(httpClient: HttpClient<O>);
|
|
921
869
|
/**
|
|
922
|
-
*
|
|
923
|
-
* Response code
|
|
924
|
-
* HTTP GET /
|
|
925
|
-
* Java method: org.openremote.model.
|
|
870
|
+
* 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.
|
|
871
|
+
* Response code 200 - A ZIP archive containing the exported data
|
|
872
|
+
* HTTP GET /asset/datapoint/export
|
|
873
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
926
874
|
*/
|
|
927
|
-
|
|
875
|
+
getDatapointExport(queryParams?: {
|
|
876
|
+
attributeRefs?: string;
|
|
877
|
+
fromTimestamp?: number;
|
|
878
|
+
toTimestamp?: number;
|
|
879
|
+
format?: Model.DatapointExportFormat;
|
|
880
|
+
}, options?: O): RestResponse<any>;
|
|
928
881
|
/**
|
|
929
|
-
*
|
|
930
|
-
* HTTP
|
|
931
|
-
* Java method: org.openremote.model.
|
|
882
|
+
* 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.
|
|
883
|
+
* HTTP GET /asset/datapoint/periods
|
|
884
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
932
885
|
*/
|
|
933
|
-
|
|
886
|
+
getDatapointPeriod(queryParams?: {
|
|
887
|
+
assetId?: string;
|
|
888
|
+
attributeName?: string;
|
|
889
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
934
890
|
/**
|
|
935
|
-
* Returns the
|
|
936
|
-
* HTTP
|
|
937
|
-
* Java method: org.openremote.model.
|
|
891
|
+
* 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.
|
|
892
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
893
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
938
894
|
*/
|
|
939
|
-
|
|
895
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
940
896
|
}
|
|
941
|
-
export declare class
|
|
897
|
+
export declare class AgentResourceClient<O> {
|
|
942
898
|
protected httpClient: HttpClient<O>;
|
|
943
899
|
constructor(httpClient: HttpClient<O>);
|
|
944
900
|
/**
|
|
945
|
-
*
|
|
946
|
-
* HTTP
|
|
947
|
-
* Java method: org.openremote.model.
|
|
901
|
+
* 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.
|
|
902
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
903
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
948
904
|
*/
|
|
949
|
-
|
|
905
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
906
|
+
realm?: string;
|
|
907
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
950
908
|
/**
|
|
951
|
-
*
|
|
952
|
-
*
|
|
953
|
-
*
|
|
909
|
+
* Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
|
|
910
|
+
* Response code 405 - The selected agent protocol does not support asset import
|
|
911
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
912
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
954
913
|
*/
|
|
955
|
-
|
|
914
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
915
|
+
realm?: string;
|
|
916
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
956
917
|
/**
|
|
957
|
-
*
|
|
958
|
-
*
|
|
959
|
-
*
|
|
918
|
+
* 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.
|
|
919
|
+
* Response code 415 - The selected agent protocol does not support instance discovery
|
|
920
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
921
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
960
922
|
*/
|
|
961
|
-
|
|
923
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
924
|
+
parentId?: string;
|
|
925
|
+
realm?: string;
|
|
926
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
927
|
+
}
|
|
928
|
+
export declare class NotificationResourceClient<O> {
|
|
929
|
+
protected httpClient: HttpClient<O>;
|
|
930
|
+
constructor(httpClient: HttpClient<O>);
|
|
962
931
|
/**
|
|
963
|
-
*
|
|
964
|
-
* HTTP
|
|
965
|
-
* Java method: org.openremote.model.
|
|
932
|
+
* Returns sent-notification records filtered by identity, message type, time, realm, target, source, sorting, and pagination. Results are realm-scoped and sensitive target/source identifiers are redacted when the caller lacks user or asset read permission.
|
|
933
|
+
* HTTP GET /notification
|
|
934
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
966
935
|
*/
|
|
967
|
-
|
|
936
|
+
getNotifications(queryParams?: {
|
|
937
|
+
id?: number;
|
|
938
|
+
type?: string;
|
|
939
|
+
from?: number;
|
|
940
|
+
to?: number;
|
|
941
|
+
realmId?: string;
|
|
942
|
+
userId?: string;
|
|
943
|
+
assetId?: string;
|
|
944
|
+
source?: Model.NotificationSource;
|
|
945
|
+
sort?: Model.SentNotificationSortField;
|
|
946
|
+
descending?: boolean;
|
|
947
|
+
offset?: number;
|
|
948
|
+
limit?: number;
|
|
949
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
968
950
|
/**
|
|
969
|
-
*
|
|
970
|
-
* HTTP
|
|
971
|
-
* Java method: org.openremote.model.
|
|
951
|
+
* Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
|
|
952
|
+
* HTTP DELETE /notification
|
|
953
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
972
954
|
*/
|
|
973
|
-
|
|
955
|
+
removeNotifications(queryParams?: {
|
|
956
|
+
id?: number;
|
|
957
|
+
type?: string;
|
|
958
|
+
from?: number;
|
|
959
|
+
to?: number;
|
|
960
|
+
realmId?: string;
|
|
961
|
+
userId?: string;
|
|
962
|
+
assetId?: string;
|
|
963
|
+
}, options?: O): RestResponse<void>;
|
|
974
964
|
/**
|
|
975
|
-
*
|
|
976
|
-
* HTTP
|
|
977
|
-
* Java method: org.openremote.model.
|
|
965
|
+
* Queues a notification for delivery. Authorization is checked for every target; if any target is inaccessible, the complete request fails rather than sending a partial set.
|
|
966
|
+
* HTTP POST /notification/alert
|
|
967
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
978
968
|
*/
|
|
979
|
-
|
|
969
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
980
970
|
/**
|
|
981
|
-
* Returns realm-
|
|
982
|
-
* HTTP GET /
|
|
983
|
-
* Java method: org.openremote.model.
|
|
971
|
+
* Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
|
|
972
|
+
* HTTP GET /notification/count
|
|
973
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
|
|
984
974
|
*/
|
|
985
|
-
|
|
975
|
+
getNotificationsCount(queryParams?: {
|
|
976
|
+
type?: string;
|
|
977
|
+
from?: number;
|
|
978
|
+
to?: number;
|
|
979
|
+
realmId?: string;
|
|
980
|
+
userId?: string;
|
|
981
|
+
assetId?: string;
|
|
982
|
+
source?: Model.NotificationSource;
|
|
983
|
+
}, options?: O): RestResponse<number>;
|
|
986
984
|
/**
|
|
987
|
-
*
|
|
988
|
-
* HTTP
|
|
989
|
-
* Java method: org.openremote.model.
|
|
985
|
+
* Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
|
|
986
|
+
* HTTP DELETE /notification/{notificationId}
|
|
987
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
990
988
|
*/
|
|
991
|
-
|
|
989
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
992
990
|
/**
|
|
993
|
-
*
|
|
994
|
-
* HTTP
|
|
995
|
-
* Java method: org.openremote.model.
|
|
991
|
+
* Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
|
|
992
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
993
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
996
994
|
*/
|
|
997
|
-
|
|
995
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
996
|
+
targetId?: string;
|
|
997
|
+
}, options?: O): RestResponse<void>;
|
|
998
998
|
/**
|
|
999
|
-
*
|
|
1000
|
-
*
|
|
1001
|
-
*
|
|
1002
|
-
* Java method: org.openremote.model.security.UserResource.requestPasswordReset
|
|
999
|
+
* Marks one target's notification as delivered after matching both notificationId and targetId. Anonymous callers may update notifications sent to a public asset; authenticated callers are constrained to their own user, realm, or accessible assets.
|
|
1000
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
1001
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
1003
1002
|
*/
|
|
1004
|
-
|
|
1003
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
1004
|
+
targetId?: string;
|
|
1005
|
+
}, options?: O): RestResponse<void>;
|
|
1006
|
+
}
|
|
1007
|
+
export declare class AppResourceClient<O> {
|
|
1008
|
+
protected httpClient: HttpClient<O>;
|
|
1009
|
+
constructor(httpClient: HttpClient<O>);
|
|
1005
1010
|
/**
|
|
1006
|
-
*
|
|
1007
|
-
*
|
|
1008
|
-
*
|
|
1009
|
-
* Java method: org.openremote.model.security.UserResource.updatePassword
|
|
1011
|
+
* Returns the identifiers of applications installed in the Manager web root.
|
|
1012
|
+
* HTTP GET /apps
|
|
1013
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
1010
1014
|
*/
|
|
1011
|
-
|
|
1015
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
1012
1016
|
/**
|
|
1013
|
-
*
|
|
1014
|
-
* HTTP GET /
|
|
1015
|
-
* Java method: org.openremote.model.
|
|
1017
|
+
* Loads the public console_config.json document used to configure console clients before sign-in.
|
|
1018
|
+
* HTTP GET /apps/consoleConfig
|
|
1019
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
1016
1020
|
*/
|
|
1017
|
-
|
|
1021
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
1018
1022
|
/**
|
|
1019
|
-
*
|
|
1020
|
-
* HTTP
|
|
1021
|
-
* Java method: org.openremote.model.
|
|
1023
|
+
* Loads each installed application's info.json file and returns the documents keyed by application identifier.
|
|
1024
|
+
* HTTP GET /apps/info
|
|
1025
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
1022
1026
|
*/
|
|
1023
|
-
|
|
1027
|
+
getAppInfos(options?: O): RestResponse<{
|
|
1028
|
+
[index: string]: any;
|
|
1029
|
+
}>;
|
|
1030
|
+
}
|
|
1031
|
+
export declare class AssetResourceClient<O> {
|
|
1032
|
+
protected httpClient: HttpClient<O>;
|
|
1033
|
+
constructor(httpClient: HttpClient<O>);
|
|
1024
1034
|
/**
|
|
1025
|
-
*
|
|
1026
|
-
* HTTP
|
|
1027
|
-
* Java method: org.openremote.model.
|
|
1035
|
+
* 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.
|
|
1036
|
+
* HTTP POST /asset
|
|
1037
|
+
* Java method: org.openremote.model.asset.AssetResource.create
|
|
1028
1038
|
*/
|
|
1029
|
-
|
|
1039
|
+
create(asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
1030
1040
|
/**
|
|
1031
|
-
*
|
|
1032
|
-
* HTTP
|
|
1033
|
-
* Java method: org.openremote.model.
|
|
1041
|
+
* Permanently deletes every asset identified by repeated assetId query parameters, subject to realm and restricted-user access rules.
|
|
1042
|
+
* HTTP DELETE /asset
|
|
1043
|
+
* Java method: org.openremote.model.asset.AssetResource.delete
|
|
1034
1044
|
*/
|
|
1035
|
-
|
|
1045
|
+
delete(queryParams?: {
|
|
1046
|
+
assetId?: string[];
|
|
1047
|
+
}, options?: O): RestResponse<void>;
|
|
1036
1048
|
/**
|
|
1037
|
-
*
|
|
1038
|
-
* HTTP
|
|
1039
|
-
* Java method: org.openremote.model.
|
|
1049
|
+
* 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.
|
|
1050
|
+
* HTTP PUT /asset/attributes
|
|
1051
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValues
|
|
1040
1052
|
*/
|
|
1041
|
-
|
|
1053
|
+
writeAttributeValues(attributeStates: Model.AttributeState[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
1042
1054
|
/**
|
|
1043
|
-
*
|
|
1044
|
-
* HTTP PUT /
|
|
1045
|
-
* Java method: org.openremote.model.
|
|
1055
|
+
* 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.
|
|
1056
|
+
* HTTP PUT /asset/attributes/timestamp
|
|
1057
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeEvents
|
|
1046
1058
|
*/
|
|
1047
|
-
|
|
1059
|
+
writeAttributeEvents(attributeEvents: Model.AttributeEvent[], options?: O): RestResponse<Model.AttributeWriteResult[]>;
|
|
1048
1060
|
/**
|
|
1049
|
-
* Returns
|
|
1050
|
-
* HTTP
|
|
1051
|
-
* Java method: org.openremote.model.
|
|
1061
|
+
* Returns only the number of assets matching an AssetQuery after applying the caller's realm, public, and linked-asset access constraints.
|
|
1062
|
+
* HTTP POST /asset/count
|
|
1063
|
+
* Java method: org.openremote.model.asset.AssetResource.queryCount
|
|
1052
1064
|
*/
|
|
1053
|
-
|
|
1065
|
+
queryCount(query: Model.AssetQuery, options?: O): RestResponse<number>;
|
|
1054
1066
|
/**
|
|
1055
|
-
*
|
|
1056
|
-
* HTTP
|
|
1057
|
-
* Java method: org.openremote.model.
|
|
1067
|
+
* Clears the parent reference of every asset listed in repeated assetIds query parameters.
|
|
1068
|
+
* HTTP DELETE /asset/parent
|
|
1069
|
+
* Java method: org.openremote.model.asset.AssetResource.updateNoneParent
|
|
1058
1070
|
*/
|
|
1059
|
-
|
|
1071
|
+
updateNoneParent(queryParams?: {
|
|
1072
|
+
assetIds?: string[];
|
|
1073
|
+
}, options?: O): RestResponse<void>;
|
|
1060
1074
|
/**
|
|
1061
|
-
*
|
|
1062
|
-
*
|
|
1063
|
-
*
|
|
1064
|
-
* Java method: org.openremote.model.security.UserResource.update
|
|
1075
|
+
* Returns the asset identity and properties without loading attributes or path data. The same access rules as getAsset apply.
|
|
1076
|
+
* HTTP GET /asset/partial/{assetId}
|
|
1077
|
+
* Java method: org.openremote.model.asset.AssetResource.getPartial
|
|
1065
1078
|
*/
|
|
1066
|
-
|
|
1079
|
+
getPartial(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
1067
1080
|
/**
|
|
1068
|
-
*
|
|
1069
|
-
*
|
|
1070
|
-
*
|
|
1071
|
-
* Java method: org.openremote.model.security.UserResource.delete
|
|
1081
|
+
* 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.
|
|
1082
|
+
* HTTP POST /asset/query
|
|
1083
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssets
|
|
1072
1084
|
*/
|
|
1073
|
-
|
|
1085
|
+
queryAssets(query: Model.AssetQuery, options?: O): RestResponse<Model.Asset[]>;
|
|
1074
1086
|
/**
|
|
1075
|
-
*
|
|
1076
|
-
* HTTP
|
|
1077
|
-
* Java method: org.openremote.model.
|
|
1087
|
+
* Applies the same authorization and selection rules as queryAssets, then returns a hierarchy optimized for tree display rather than a flat asset array.
|
|
1088
|
+
* HTTP POST /asset/tree
|
|
1089
|
+
* Java method: org.openremote.model.asset.AssetResource.queryAssetTree
|
|
1078
1090
|
*/
|
|
1079
|
-
|
|
1091
|
+
queryAssetTree(query: Model.AssetQuery, options?: O): RestResponse<Model.AssetTree>;
|
|
1080
1092
|
/**
|
|
1081
|
-
*
|
|
1082
|
-
* HTTP
|
|
1083
|
-
* Java method: org.openremote.model.
|
|
1093
|
+
* 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.
|
|
1094
|
+
* HTTP GET /asset/user/current
|
|
1095
|
+
* Java method: org.openremote.model.asset.AssetResource.getCurrentUserAssets
|
|
1084
1096
|
*/
|
|
1085
|
-
|
|
1097
|
+
getCurrentUserAssets(options?: O): RestResponse<Model.Asset[]>;
|
|
1086
1098
|
/**
|
|
1087
|
-
*
|
|
1088
|
-
* HTTP
|
|
1089
|
-
* Java method: org.openremote.model.
|
|
1099
|
+
* 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.
|
|
1100
|
+
* HTTP POST /asset/user/link
|
|
1101
|
+
* Java method: org.openremote.model.asset.AssetResource.createUserAssetLinks
|
|
1090
1102
|
*/
|
|
1091
|
-
|
|
1092
|
-
}
|
|
1093
|
-
export declare class MapResourceClient<O> {
|
|
1094
|
-
protected httpClient: HttpClient<O>;
|
|
1095
|
-
constructor(httpClient: HttpClient<O>);
|
|
1103
|
+
createUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
1096
1104
|
/**
|
|
1097
|
-
* Returns
|
|
1098
|
-
* HTTP GET /
|
|
1099
|
-
* Java method: org.openremote.model.
|
|
1105
|
+
* 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.
|
|
1106
|
+
* HTTP GET /asset/user/link
|
|
1107
|
+
* Java method: org.openremote.model.asset.AssetResource.getUserAssetLinks
|
|
1100
1108
|
*/
|
|
1101
|
-
|
|
1102
|
-
|
|
1103
|
-
|
|
1109
|
+
getUserAssetLinks(queryParams?: {
|
|
1110
|
+
realm?: string;
|
|
1111
|
+
userId?: string;
|
|
1112
|
+
assetId?: string;
|
|
1113
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
1104
1114
|
/**
|
|
1105
|
-
*
|
|
1106
|
-
* HTTP
|
|
1107
|
-
* Java method: org.openremote.model.
|
|
1115
|
+
* Removes all supplied links. Every item must identify the same realm and user.
|
|
1116
|
+
* HTTP POST /asset/user/link/delete
|
|
1117
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
1108
1118
|
*/
|
|
1109
|
-
|
|
1110
|
-
[id: string]: unknown;
|
|
1111
|
-
}>;
|
|
1119
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
1112
1120
|
/**
|
|
1113
|
-
*
|
|
1114
|
-
* HTTP DELETE /
|
|
1115
|
-
* Java method: org.openremote.model.
|
|
1121
|
+
* Removes every asset link belonging to the user in the requested realm.
|
|
1122
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
1123
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
1116
1124
|
*/
|
|
1117
|
-
|
|
1118
|
-
[id: string]: unknown;
|
|
1119
|
-
}>;
|
|
1125
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
1120
1126
|
/**
|
|
1121
|
-
*
|
|
1122
|
-
* HTTP
|
|
1123
|
-
* Java method: org.openremote.model.
|
|
1127
|
+
* Removes the link identified by realm, user, and asset. The caller must be allowed to administer asset links in that realm.
|
|
1128
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
1129
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
1124
1130
|
*/
|
|
1125
|
-
|
|
1126
|
-
[id: string]: unknown;
|
|
1127
|
-
}>;
|
|
1131
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
1128
1132
|
/**
|
|
1129
|
-
* Returns a
|
|
1130
|
-
*
|
|
1131
|
-
*
|
|
1132
|
-
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
1133
|
-
* Java method: org.openremote.model.map.MapResource.getTile
|
|
1133
|
+
* Returns a fully loaded asset including its path and attributes. Access is constrained to the caller's realm and, for restricted users, linked assets.
|
|
1134
|
+
* HTTP GET /asset/{assetId}
|
|
1135
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
1134
1136
|
*/
|
|
1135
|
-
|
|
1137
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
1136
1138
|
/**
|
|
1137
|
-
*
|
|
1138
|
-
* HTTP
|
|
1139
|
-
* Java method: org.openremote.model.
|
|
1139
|
+
* 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.
|
|
1140
|
+
* HTTP PUT /asset/{assetId}
|
|
1141
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
1140
1142
|
*/
|
|
1141
|
-
|
|
1142
|
-
filename?: string;
|
|
1143
|
-
}, options?: O): RestResponse<{
|
|
1144
|
-
[id: string]: unknown;
|
|
1145
|
-
}>;
|
|
1146
|
-
}
|
|
1147
|
-
export declare class AppResourceClient<O> {
|
|
1148
|
-
protected httpClient: HttpClient<O>;
|
|
1149
|
-
constructor(httpClient: HttpClient<O>);
|
|
1143
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
1150
1144
|
/**
|
|
1151
|
-
*
|
|
1152
|
-
*
|
|
1153
|
-
*
|
|
1145
|
+
* 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.
|
|
1146
|
+
* Response code 400 - The attribute write failed
|
|
1147
|
+
* Response code 406 - The supplied value is not valid for the attribute
|
|
1148
|
+
* Response code 429 - The attribute event queue is full; retry the write later
|
|
1149
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
1150
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
1154
1151
|
*/
|
|
1155
|
-
|
|
1152
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
1156
1153
|
/**
|
|
1157
|
-
*
|
|
1158
|
-
*
|
|
1159
|
-
*
|
|
1154
|
+
* Submits an asynchronous attribute write using the supplied Unix timestamp in milliseconds. The result reports acceptance only; anonymous writes require public-write metadata.
|
|
1155
|
+
* Response code 400 - The attribute write failed
|
|
1156
|
+
* Response code 406 - The supplied value is not valid for the attribute
|
|
1157
|
+
* Response code 429 - The attribute event queue is full; retry the write later
|
|
1158
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
1159
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
1160
1160
|
*/
|
|
1161
|
-
|
|
1161
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
1162
1162
|
/**
|
|
1163
|
-
*
|
|
1164
|
-
* HTTP
|
|
1165
|
-
* Java method: org.openremote.model.
|
|
1163
|
+
* Sets parentAssetId as the parent of every asset listed in repeated assetIds query parameters. Parent and children must satisfy realm, access, and hierarchy constraints.
|
|
1164
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
1165
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
1166
1166
|
*/
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
}>;
|
|
1167
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
1168
|
+
assetIds?: string[];
|
|
1169
|
+
}, options?: O): RestResponse<void>;
|
|
1170
1170
|
}
|
|
1171
1171
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
1172
1172
|
export declare class ApiClient {
|
|
1173
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
1174
|
-
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
1175
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
1176
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
1177
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1178
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
1179
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1180
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1181
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
1182
|
-
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
1183
1173
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
1184
|
-
protected
|
|
1185
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
1186
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
1174
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
1187
1175
|
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
1188
1176
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
1189
|
-
protected
|
|
1177
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
1178
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1190
1179
|
protected _realmResource: AxiosRealmResourceClient;
|
|
1180
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1181
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
1182
|
+
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
1183
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
1184
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1185
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
1191
1186
|
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1187
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
1192
1188
|
protected _userResource: AxiosUserResourceClient;
|
|
1193
|
-
protected
|
|
1189
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
1190
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1191
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
1192
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
1194
1193
|
protected _appResource: AxiosAppResourceClient;
|
|
1194
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
1195
1195
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1196
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1197
|
-
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1198
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
1199
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1200
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1201
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
1202
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1203
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1204
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
1205
|
-
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1206
1196
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1207
|
-
get
|
|
1208
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
1209
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1197
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1210
1198
|
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1211
1199
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1212
|
-
get
|
|
1200
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1201
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1213
1202
|
get RealmResource(): AxiosRealmResourceClient;
|
|
1203
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1204
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1205
|
+
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1206
|
+
get MapResource(): AxiosMapResourceClient;
|
|
1207
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1208
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1214
1209
|
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1210
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1215
1211
|
get UserResource(): AxiosUserResourceClient;
|
|
1216
|
-
get
|
|
1212
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1213
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1214
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1215
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1217
1216
|
get AppResource(): AxiosAppResourceClient;
|
|
1217
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
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
|
|
1226
|
-
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1227
|
-
}
|
|
1228
|
-
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1225
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1229
1226
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1230
1227
|
}
|
|
1231
1228
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1232
1229
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1233
1230
|
}
|
|
1234
|
-
export declare class
|
|
1231
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1235
1232
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1236
1233
|
}
|
|
1237
|
-
export declare class
|
|
1234
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1238
1235
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1239
1236
|
}
|
|
1240
|
-
export declare class
|
|
1237
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1241
1238
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1242
1239
|
}
|
|
1243
1240
|
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1244
1241
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1245
1242
|
}
|
|
1243
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1244
|
+
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1245
|
+
}
|
|
1246
1246
|
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1247
1247
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1248
1248
|
}
|
|
1249
|
-
export declare class
|
|
1249
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1250
1250
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1251
1251
|
}
|
|
1252
|
-
export declare class
|
|
1252
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1253
1253
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1254
1254
|
}
|
|
1255
|
-
export declare class
|
|
1255
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1256
1256
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1257
1257
|
}
|
|
1258
1258
|
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1259
1259
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1260
1260
|
}
|
|
1261
|
-
export declare class
|
|
1261
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1262
1262
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1263
1263
|
}
|
|
1264
|
-
export declare class
|
|
1264
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1265
1265
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1266
1266
|
}
|
|
1267
|
-
export declare class
|
|
1267
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1268
1268
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1269
1269
|
}
|
|
1270
|
-
export declare class
|
|
1270
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1271
1271
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1272
1272
|
}
|
|
1273
|
-
export declare class
|
|
1273
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1274
1274
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1275
1275
|
}
|
|
1276
|
-
export declare class
|
|
1276
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1277
1277
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1278
1278
|
}
|
|
1279
|
-
export declare class
|
|
1279
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1280
1280
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1281
1281
|
}
|
|
1282
|
-
export declare class
|
|
1282
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1283
1283
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1284
1284
|
}
|
|
1285
|
-
export declare class
|
|
1285
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1286
1286
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1287
1287
|
}
|
|
1288
|
-
export declare class
|
|
1288
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1289
1289
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1290
1290
|
}
|
|
1291
1291
|
//# sourceMappingURL=restclient.d.ts.map
|