@openremote/rest 1.28.0 → 1.28.1
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 +571 -571
- 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,6 +9,42 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
+
export declare class GatewayServiceResourceClient<O> {
|
|
13
|
+
protected httpClient: HttpClient<O>;
|
|
14
|
+
constructor(httpClient: HttpClient<O>);
|
|
15
|
+
/**
|
|
16
|
+
* Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
|
|
17
|
+
* Response code 417 - The gateway could not establish the requested tunnel
|
|
18
|
+
* HTTP POST /gateway/tunnel
|
|
19
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
20
|
+
*/
|
|
21
|
+
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
22
|
+
/**
|
|
23
|
+
* Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
|
|
24
|
+
* HTTP DELETE /gateway/tunnel
|
|
25
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
26
|
+
*/
|
|
27
|
+
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
28
|
+
/**
|
|
29
|
+
* Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
|
|
30
|
+
* HTTP GET /gateway/tunnel/{realm}
|
|
31
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
32
|
+
*/
|
|
33
|
+
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
34
|
+
/**
|
|
35
|
+
* Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
|
|
36
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
37
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
38
|
+
*/
|
|
39
|
+
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
40
|
+
/**
|
|
41
|
+
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
42
|
+
* Response code 204 - No active tunnel matches the requested endpoint
|
|
43
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
44
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
45
|
+
*/
|
|
46
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
47
|
+
}
|
|
12
48
|
export declare class AssetModelResourceClient<O> {
|
|
13
49
|
protected httpClient: HttpClient<O>;
|
|
14
50
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -70,93 +106,42 @@ export declare class AssetModelResourceClient<O> {
|
|
|
70
106
|
[index: string]: Model.ValueDescriptor;
|
|
71
107
|
}>;
|
|
72
108
|
}
|
|
73
|
-
export declare class
|
|
74
|
-
protected httpClient: HttpClient<O>;
|
|
75
|
-
constructor(httpClient: HttpClient<O>);
|
|
76
|
-
/**
|
|
77
|
-
* Returns the identifiers of applications installed in the Manager web root.
|
|
78
|
-
* HTTP GET /apps
|
|
79
|
-
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
80
|
-
*/
|
|
81
|
-
getApps(options?: O): RestResponse<string[]>;
|
|
82
|
-
/**
|
|
83
|
-
* Loads the public console_config.json document used to configure console clients before sign-in.
|
|
84
|
-
* HTTP GET /apps/consoleConfig
|
|
85
|
-
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
86
|
-
*/
|
|
87
|
-
getConsoleConfig(options?: O): RestResponse<any>;
|
|
88
|
-
/**
|
|
89
|
-
* Loads each installed application's info.json file and returns the documents keyed by application identifier.
|
|
90
|
-
* HTTP GET /apps/info
|
|
91
|
-
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
92
|
-
*/
|
|
93
|
-
getAppInfos(options?: O): RestResponse<{
|
|
94
|
-
[index: string]: any;
|
|
95
|
-
}>;
|
|
96
|
-
}
|
|
97
|
-
export declare class RealmResourceClient<O> {
|
|
109
|
+
export declare class SyslogResourceClient<O> {
|
|
98
110
|
protected httpClient: HttpClient<O>;
|
|
99
111
|
constructor(httpClient: HttpClient<O>);
|
|
100
112
|
/**
|
|
101
|
-
*
|
|
102
|
-
* HTTP
|
|
103
|
-
* Java method: org.openremote.model.
|
|
104
|
-
*/
|
|
105
|
-
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
106
|
-
/**
|
|
107
|
-
* Returns complete realm records from the identity provider. This operation is restricted to a super user.
|
|
108
|
-
* HTTP GET /realm
|
|
109
|
-
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
110
|
-
*/
|
|
111
|
-
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
112
|
-
/**
|
|
113
|
-
* Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
|
|
114
|
-
* HTTP GET /realm/accessible
|
|
115
|
-
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
116
|
-
*/
|
|
117
|
-
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
118
|
-
/**
|
|
119
|
-
* Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
|
|
120
|
-
* Response code 405 - The master realm cannot be deleted
|
|
121
|
-
* HTTP DELETE /realm/{name}
|
|
122
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
123
|
-
*/
|
|
124
|
-
delete(name: string, options?: O): RestResponse<void>;
|
|
125
|
-
/**
|
|
126
|
-
* Returns complete details for a named active realm when it is accessible to the caller. Regular users cannot use this endpoint to inspect other realms.
|
|
127
|
-
* HTTP GET /realm/{name}
|
|
128
|
-
* Java method: org.openremote.model.security.RealmResource.get
|
|
129
|
-
*/
|
|
130
|
-
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
131
|
-
/**
|
|
132
|
-
* Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
|
|
133
|
-
* Response code 405 - The requested mutation is not allowed for the master realm
|
|
134
|
-
* HTTP PUT /realm/{name}
|
|
135
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
113
|
+
* Returns the current log-storage and retention configuration.
|
|
114
|
+
* HTTP GET /syslog/config
|
|
115
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
136
116
|
*/
|
|
137
|
-
|
|
138
|
-
}
|
|
139
|
-
export declare class FlowResourceClient<O> {
|
|
140
|
-
protected httpClient: HttpClient<O>;
|
|
141
|
-
constructor(httpClient: HttpClient<O>);
|
|
117
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
142
118
|
/**
|
|
143
|
-
*
|
|
144
|
-
* HTTP
|
|
145
|
-
* Java method: org.openremote.model.
|
|
119
|
+
* Validates and applies log-storage and retention settings.
|
|
120
|
+
* HTTP PUT /syslog/config
|
|
121
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
146
122
|
*/
|
|
147
|
-
|
|
123
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
148
124
|
/**
|
|
149
|
-
*
|
|
150
|
-
* HTTP
|
|
151
|
-
* Java method: org.openremote.model.
|
|
125
|
+
* Permanently removes all events from the configured syslog storage.
|
|
126
|
+
* HTTP DELETE /syslog/event
|
|
127
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
152
128
|
*/
|
|
153
|
-
|
|
129
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
154
130
|
/**
|
|
155
|
-
* Returns
|
|
156
|
-
*
|
|
157
|
-
*
|
|
131
|
+
* 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.
|
|
132
|
+
* Response code 200 - The requested page of syslog events
|
|
133
|
+
* HTTP GET /syslog/event
|
|
134
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
158
135
|
*/
|
|
159
|
-
|
|
136
|
+
getEvents(queryParams?: {
|
|
137
|
+
level?: Model.SyslogLevel;
|
|
138
|
+
per_page?: number;
|
|
139
|
+
page?: number;
|
|
140
|
+
from?: number;
|
|
141
|
+
to?: number;
|
|
142
|
+
category?: Model.SyslogCategory[];
|
|
143
|
+
subCategory?: string[];
|
|
144
|
+
}, options?: O): RestResponse<any>;
|
|
160
145
|
}
|
|
161
146
|
export declare class ProvisioningResourceClient<O> {
|
|
162
147
|
protected httpClient: HttpClient<O>;
|
|
@@ -186,95 +171,6 @@ export declare class ProvisioningResourceClient<O> {
|
|
|
186
171
|
*/
|
|
187
172
|
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
188
173
|
}
|
|
189
|
-
export declare class GatewayClientResourceClient<O> {
|
|
190
|
-
protected httpClient: HttpClient<O>;
|
|
191
|
-
constructor(httpClient: HttpClient<O>);
|
|
192
|
-
/**
|
|
193
|
-
* Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
|
|
194
|
-
* HTTP DELETE /gateway/connection
|
|
195
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
196
|
-
*/
|
|
197
|
-
deleteConnections(queryParams?: {
|
|
198
|
-
realm?: string[];
|
|
199
|
-
}, options?: O): RestResponse<void>;
|
|
200
|
-
/**
|
|
201
|
-
* Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
|
|
202
|
-
* HTTP GET /gateway/connection
|
|
203
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
204
|
-
*/
|
|
205
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
206
|
-
/**
|
|
207
|
-
* Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
|
|
208
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
209
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
210
|
-
*/
|
|
211
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
212
|
-
/**
|
|
213
|
-
* 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.
|
|
214
|
-
* Response code 204 - No gateway connection is configured for the realm
|
|
215
|
-
* HTTP GET /gateway/connection/{realm}
|
|
216
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
217
|
-
*/
|
|
218
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
219
|
-
/**
|
|
220
|
-
* 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.
|
|
221
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
222
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
223
|
-
*/
|
|
224
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
225
|
-
/**
|
|
226
|
-
* Returns the live connection state for the requested local realm.
|
|
227
|
-
* HTTP GET /gateway/status/{realm}
|
|
228
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
229
|
-
*/
|
|
230
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
231
|
-
}
|
|
232
|
-
export declare class GatewayServiceResourceClient<O> {
|
|
233
|
-
protected httpClient: HttpClient<O>;
|
|
234
|
-
constructor(httpClient: HttpClient<O>);
|
|
235
|
-
/**
|
|
236
|
-
* Requests a TCP tunnel through a connected gateway and returns its allocated local endpoint. When realm is omitted, the authenticated realm is used.
|
|
237
|
-
* Response code 417 - The gateway could not establish the requested tunnel
|
|
238
|
-
* HTTP POST /gateway/tunnel
|
|
239
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.startTunnel
|
|
240
|
-
*/
|
|
241
|
-
startTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
242
|
-
/**
|
|
243
|
-
* Stops the tunnel identified by the supplied gateway, target, and port information. When realm is omitted, the authenticated realm is used.
|
|
244
|
-
* HTTP DELETE /gateway/tunnel
|
|
245
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.stopTunnel
|
|
246
|
-
*/
|
|
247
|
-
stopTunnel(tunnelInfo: Model.GatewayTunnelInfo, options?: O): RestResponse<void>;
|
|
248
|
-
/**
|
|
249
|
-
* Returns active tunnels for all gateway assets in the requested realm. Restricted users cannot list an entire realm.
|
|
250
|
-
* HTTP GET /gateway/tunnel/{realm}
|
|
251
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getAllActiveTunnelInfos
|
|
252
|
-
*/
|
|
253
|
-
getAllActiveTunnelInfos(realm: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
254
|
-
/**
|
|
255
|
-
* Returns active tunnels for one gateway asset. Restricted users may query only a linked gateway.
|
|
256
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}
|
|
257
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getGatewayActiveTunnelInfos
|
|
258
|
-
*/
|
|
259
|
-
getGatewayActiveTunnelInfos(realm: string, id: string, options?: O): RestResponse<Model.GatewayTunnelInfo[]>;
|
|
260
|
-
/**
|
|
261
|
-
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
262
|
-
* Response code 204 - No active tunnel matches the requested endpoint
|
|
263
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
264
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
265
|
-
*/
|
|
266
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
267
|
-
}
|
|
268
|
-
export declare class ConsoleResourceClient<O> {
|
|
269
|
-
protected httpClient: HttpClient<O>;
|
|
270
|
-
constructor(httpClient: HttpClient<O>);
|
|
271
|
-
/**
|
|
272
|
-
* Creates an anonymous console registration when id is absent, or updates an existing registration when id is present. Authenticated new registrations are linked to the caller; updates require that link. The returned registration contains the durable asset ID for later calls.
|
|
273
|
-
* HTTP POST /console/register
|
|
274
|
-
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
275
|
-
*/
|
|
276
|
-
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
277
|
-
}
|
|
278
174
|
export declare class ConfigurationResourceClient<O> {
|
|
279
175
|
protected httpClient: HttpClient<O>;
|
|
280
176
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -306,104 +202,174 @@ export declare class ConfigurationResourceClient<O> {
|
|
|
306
202
|
*/
|
|
307
203
|
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
308
204
|
}
|
|
309
|
-
export declare class
|
|
205
|
+
export declare class AlarmResourceClient<O> {
|
|
310
206
|
protected httpClient: HttpClient<O>;
|
|
311
207
|
constructor(httpClient: HttpClient<O>);
|
|
312
208
|
/**
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
209
|
+
* 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.
|
|
210
|
+
* HTTP POST /alarm
|
|
211
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
317
212
|
*/
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
}, options?: O): RestResponse<Model.
|
|
213
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
214
|
+
assetIds?: string[];
|
|
215
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
321
216
|
/**
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
*
|
|
325
|
-
* Response code 409 - ExternalService instance already registered
|
|
326
|
-
* HTTP POST /service
|
|
327
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
217
|
+
* Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
|
|
218
|
+
* HTTP GET /alarm
|
|
219
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
328
220
|
*/
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
221
|
+
getAlarms(queryParams?: {
|
|
222
|
+
realm?: string;
|
|
223
|
+
status?: Model.AlarmStatus;
|
|
224
|
+
assetId?: string;
|
|
225
|
+
assigneeId?: string;
|
|
226
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
227
|
+
/**
|
|
228
|
+
* Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
|
|
229
|
+
* HTTP DELETE /alarm
|
|
230
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
335
231
|
*/
|
|
336
|
-
|
|
232
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
337
233
|
/**
|
|
338
|
-
*
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
234
|
+
* Adds links between assets and one existing alarm.
|
|
235
|
+
|
|
236
|
+
The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
|
|
237
|
+
every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
|
|
238
|
+
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
239
|
+
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
240
|
+
|
|
241
|
+
Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
|
|
242
|
+
This operation does not remove existing links from the alarm.
|
|
243
|
+
|
|
244
|
+
* HTTP PUT /alarm/assets
|
|
245
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
344
246
|
*/
|
|
345
|
-
|
|
247
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
346
248
|
/**
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
*
|
|
350
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
351
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
249
|
+
* Returns one alarm when its realm is active and accessible to the authenticated user.
|
|
250
|
+
* HTTP GET /alarm/{alarmId}
|
|
251
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
352
252
|
*/
|
|
353
|
-
|
|
253
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
354
254
|
/**
|
|
355
|
-
*
|
|
356
|
-
*
|
|
357
|
-
*
|
|
358
|
-
* HTTP GET /service/{serviceId}/{instanceId}
|
|
359
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
255
|
+
* Permanently removes one alarm after verifying access to its realm.
|
|
256
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
257
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
360
258
|
*/
|
|
361
|
-
|
|
259
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
362
260
|
/**
|
|
363
|
-
*
|
|
364
|
-
*
|
|
365
|
-
*
|
|
366
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
367
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
261
|
+
* Updates the mutable state of an existing alarm after verifying access to its current realm.
|
|
262
|
+
* HTTP PUT /alarm/{alarmId}
|
|
263
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
368
264
|
*/
|
|
369
|
-
|
|
265
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
266
|
+
/**
|
|
267
|
+
* Returns links from the alarm to assets in the explicitly supplied accessible realm.
|
|
268
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
269
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
270
|
+
*/
|
|
271
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
272
|
+
realm?: string;
|
|
273
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
370
274
|
}
|
|
371
|
-
export declare class
|
|
275
|
+
export declare class StatusResourceClient<O> {
|
|
372
276
|
protected httpClient: HttpClient<O>;
|
|
373
277
|
constructor(httpClient: HttpClient<O>);
|
|
374
278
|
/**
|
|
375
|
-
* Returns
|
|
376
|
-
* HTTP GET /
|
|
377
|
-
* Java method: org.openremote.model.
|
|
279
|
+
* Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
|
|
280
|
+
* HTTP GET /health
|
|
281
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
378
282
|
*/
|
|
379
|
-
|
|
283
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
284
|
+
[index: string]: any;
|
|
285
|
+
}>;
|
|
380
286
|
/**
|
|
381
|
-
*
|
|
382
|
-
* HTTP
|
|
383
|
-
* Java method: org.openremote.model.
|
|
287
|
+
* Returns public bootstrap information, including the Manager version and identity-provider URL.
|
|
288
|
+
* HTTP GET /info
|
|
289
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
384
290
|
*/
|
|
385
|
-
|
|
291
|
+
getInfo(options?: O): RestResponse<{
|
|
292
|
+
[index: string]: any;
|
|
293
|
+
}>;
|
|
294
|
+
}
|
|
295
|
+
export declare class NotificationResourceClient<O> {
|
|
296
|
+
protected httpClient: HttpClient<O>;
|
|
297
|
+
constructor(httpClient: HttpClient<O>);
|
|
386
298
|
/**
|
|
387
|
-
*
|
|
388
|
-
* HTTP
|
|
389
|
-
* Java method: org.openremote.model.
|
|
299
|
+
* 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.
|
|
300
|
+
* HTTP GET /notification
|
|
301
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
390
302
|
*/
|
|
391
|
-
|
|
303
|
+
getNotifications(queryParams?: {
|
|
304
|
+
id?: number;
|
|
305
|
+
type?: string;
|
|
306
|
+
from?: number;
|
|
307
|
+
to?: number;
|
|
308
|
+
realmId?: string;
|
|
309
|
+
userId?: string;
|
|
310
|
+
assetId?: string;
|
|
311
|
+
source?: Model.NotificationSource;
|
|
312
|
+
sort?: Model.SentNotificationSortField;
|
|
313
|
+
descending?: boolean;
|
|
314
|
+
offset?: number;
|
|
315
|
+
limit?: number;
|
|
316
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
392
317
|
/**
|
|
393
|
-
*
|
|
394
|
-
*
|
|
395
|
-
*
|
|
396
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
318
|
+
* Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
|
|
319
|
+
* HTTP DELETE /notification
|
|
320
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
397
321
|
*/
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
page?: number;
|
|
322
|
+
removeNotifications(queryParams?: {
|
|
323
|
+
id?: number;
|
|
324
|
+
type?: string;
|
|
402
325
|
from?: number;
|
|
403
326
|
to?: number;
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
327
|
+
realmId?: string;
|
|
328
|
+
userId?: string;
|
|
329
|
+
assetId?: string;
|
|
330
|
+
}, options?: O): RestResponse<void>;
|
|
331
|
+
/**
|
|
332
|
+
* 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.
|
|
333
|
+
* HTTP POST /notification/alert
|
|
334
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
335
|
+
*/
|
|
336
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
337
|
+
/**
|
|
338
|
+
* Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
|
|
339
|
+
* HTTP GET /notification/count
|
|
340
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
|
|
341
|
+
*/
|
|
342
|
+
getNotificationsCount(queryParams?: {
|
|
343
|
+
type?: string;
|
|
344
|
+
from?: number;
|
|
345
|
+
to?: number;
|
|
346
|
+
realmId?: string;
|
|
347
|
+
userId?: string;
|
|
348
|
+
assetId?: string;
|
|
349
|
+
source?: Model.NotificationSource;
|
|
350
|
+
}, options?: O): RestResponse<number>;
|
|
351
|
+
/**
|
|
352
|
+
* Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
|
|
353
|
+
* HTTP DELETE /notification/{notificationId}
|
|
354
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
355
|
+
*/
|
|
356
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
357
|
+
/**
|
|
358
|
+
* Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
|
|
359
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
360
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
361
|
+
*/
|
|
362
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
363
|
+
targetId?: string;
|
|
364
|
+
}, options?: O): RestResponse<void>;
|
|
365
|
+
/**
|
|
366
|
+
* 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.
|
|
367
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
368
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
369
|
+
*/
|
|
370
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
371
|
+
targetId?: string;
|
|
372
|
+
}, options?: O): RestResponse<void>;
|
|
407
373
|
}
|
|
408
374
|
export declare class DashboardResourceClient<O> {
|
|
409
375
|
protected httpClient: HttpClient<O>;
|
|
@@ -445,6 +411,105 @@ export declare class DashboardResourceClient<O> {
|
|
|
445
411
|
*/
|
|
446
412
|
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
447
413
|
}
|
|
414
|
+
export declare class RealmResourceClient<O> {
|
|
415
|
+
protected httpClient: HttpClient<O>;
|
|
416
|
+
constructor(httpClient: HttpClient<O>);
|
|
417
|
+
/**
|
|
418
|
+
* Creates and configures a realm in the identity provider. This operation is restricted to a super user.
|
|
419
|
+
* HTTP POST /realm
|
|
420
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
421
|
+
*/
|
|
422
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
423
|
+
/**
|
|
424
|
+
* Returns complete realm records from the identity provider. This operation is restricted to a super user.
|
|
425
|
+
* HTTP GET /realm
|
|
426
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
427
|
+
*/
|
|
428
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
429
|
+
/**
|
|
430
|
+
* Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
|
|
431
|
+
* HTTP GET /realm/accessible
|
|
432
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
433
|
+
*/
|
|
434
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
435
|
+
/**
|
|
436
|
+
* Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
|
|
437
|
+
* Response code 405 - The master realm cannot be deleted
|
|
438
|
+
* HTTP DELETE /realm/{name}
|
|
439
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
440
|
+
*/
|
|
441
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
442
|
+
/**
|
|
443
|
+
* 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.
|
|
444
|
+
* HTTP GET /realm/{name}
|
|
445
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
446
|
+
*/
|
|
447
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
448
|
+
/**
|
|
449
|
+
* Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
|
|
450
|
+
* Response code 405 - The requested mutation is not allowed for the master realm
|
|
451
|
+
* HTTP PUT /realm/{name}
|
|
452
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
453
|
+
*/
|
|
454
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
455
|
+
}
|
|
456
|
+
export declare class ConsoleResourceClient<O> {
|
|
457
|
+
protected httpClient: HttpClient<O>;
|
|
458
|
+
constructor(httpClient: HttpClient<O>);
|
|
459
|
+
/**
|
|
460
|
+
* Creates an anonymous console registration when id is absent, or updates an existing registration when id is present. Authenticated new registrations are linked to the caller; updates require that link. The returned registration contains the durable asset ID for later calls.
|
|
461
|
+
* HTTP POST /console/register
|
|
462
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
463
|
+
*/
|
|
464
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
465
|
+
}
|
|
466
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
467
|
+
protected httpClient: HttpClient<O>;
|
|
468
|
+
constructor(httpClient: HttpClient<O>);
|
|
469
|
+
/**
|
|
470
|
+
* 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.
|
|
471
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
472
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
473
|
+
*/
|
|
474
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
475
|
+
/**
|
|
476
|
+
* 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.
|
|
477
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
478
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
479
|
+
*/
|
|
480
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
481
|
+
}
|
|
482
|
+
export declare class AgentResourceClient<O> {
|
|
483
|
+
protected httpClient: HttpClient<O>;
|
|
484
|
+
constructor(httpClient: HttpClient<O>);
|
|
485
|
+
/**
|
|
486
|
+
* 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.
|
|
487
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
488
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
489
|
+
*/
|
|
490
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
491
|
+
realm?: string;
|
|
492
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
493
|
+
/**
|
|
494
|
+
* Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
|
|
495
|
+
* Response code 405 - The selected agent protocol does not support asset import
|
|
496
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
497
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
498
|
+
*/
|
|
499
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
500
|
+
realm?: string;
|
|
501
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
502
|
+
/**
|
|
503
|
+
* 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.
|
|
504
|
+
* Response code 415 - The selected agent protocol does not support instance discovery
|
|
505
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
506
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
507
|
+
*/
|
|
508
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
509
|
+
parentId?: string;
|
|
510
|
+
realm?: string;
|
|
511
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
512
|
+
}
|
|
448
513
|
export declare class AssetResourceClient<O> {
|
|
449
514
|
protected httpClient: HttpClient<O>;
|
|
450
515
|
constructor(httpClient: HttpClient<O>);
|
|
@@ -527,141 +592,62 @@ export declare class AssetResourceClient<O> {
|
|
|
527
592
|
realm?: string;
|
|
528
593
|
userId?: string;
|
|
529
594
|
assetId?: string;
|
|
530
|
-
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
531
|
-
/**
|
|
532
|
-
* Removes all supplied links. Every item must identify the same realm and user.
|
|
533
|
-
* HTTP POST /asset/user/link/delete
|
|
534
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
535
|
-
*/
|
|
536
|
-
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
537
|
-
/**
|
|
538
|
-
* Removes every asset link belonging to the user in the requested realm.
|
|
539
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
540
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
541
|
-
*/
|
|
542
|
-
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
543
|
-
/**
|
|
544
|
-
* Removes the link identified by realm, user, and asset. The caller must be allowed to administer asset links in that realm.
|
|
545
|
-
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
546
|
-
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
547
|
-
*/
|
|
548
|
-
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
549
|
-
/**
|
|
550
|
-
* Returns a fully loaded asset including its path and attributes. Access is constrained to the caller's realm and, for restricted users, linked assets.
|
|
551
|
-
* HTTP GET /asset/{assetId}
|
|
552
|
-
* Java method: org.openremote.model.asset.AssetResource.get
|
|
553
|
-
*/
|
|
554
|
-
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
555
|
-
/**
|
|
556
|
-
* Replaces mutable asset data while preserving the path identifier. Realm, parent, restricted-user, and private-metadata rules are validated; disallowed restricted-user fields may be ignored.
|
|
557
|
-
* HTTP PUT /asset/{assetId}
|
|
558
|
-
* Java method: org.openremote.model.asset.AssetResource.update
|
|
559
|
-
*/
|
|
560
|
-
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
561
|
-
/**
|
|
562
|
-
* Submits an asynchronous attribute write using the current server time. The result reports whether the event was accepted, not whether downstream processing ultimately succeeded. Anonymous writes require public-write metadata.
|
|
563
|
-
* Response code 400 - The attribute write failed
|
|
564
|
-
* Response code 406 - The supplied value is not valid for the attribute
|
|
565
|
-
* Response code 429 - The attribute event queue is full; retry the write later
|
|
566
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
567
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
568
|
-
*/
|
|
569
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
570
|
-
/**
|
|
571
|
-
* Submits an asynchronous attribute write using the supplied Unix timestamp in milliseconds. The result reports acceptance only; anonymous writes require public-write metadata.
|
|
572
|
-
* Response code 400 - The attribute write failed
|
|
573
|
-
* Response code 406 - The supplied value is not valid for the attribute
|
|
574
|
-
* Response code 429 - The attribute event queue is full; retry the write later
|
|
575
|
-
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
576
|
-
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
577
|
-
*/
|
|
578
|
-
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
579
|
-
/**
|
|
580
|
-
* Sets parentAssetId as the parent of every asset listed in repeated assetIds query parameters. Parent and children must satisfy realm, access, and hierarchy constraints.
|
|
581
|
-
* HTTP PUT /asset/{parentAssetId}/child
|
|
582
|
-
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
583
|
-
*/
|
|
584
|
-
updateParent(parentAssetId: string, queryParams?: {
|
|
585
|
-
assetIds?: string[];
|
|
586
|
-
}, options?: O): RestResponse<void>;
|
|
587
|
-
}
|
|
588
|
-
export declare class NotificationResourceClient<O> {
|
|
589
|
-
protected httpClient: HttpClient<O>;
|
|
590
|
-
constructor(httpClient: HttpClient<O>);
|
|
591
|
-
/**
|
|
592
|
-
* 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.
|
|
593
|
-
* HTTP GET /notification
|
|
594
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
595
|
-
*/
|
|
596
|
-
getNotifications(queryParams?: {
|
|
597
|
-
id?: number;
|
|
598
|
-
type?: string;
|
|
599
|
-
from?: number;
|
|
600
|
-
to?: number;
|
|
601
|
-
realmId?: string;
|
|
602
|
-
userId?: string;
|
|
603
|
-
assetId?: string;
|
|
604
|
-
source?: Model.NotificationSource;
|
|
605
|
-
sort?: Model.SentNotificationSortField;
|
|
606
|
-
descending?: boolean;
|
|
607
|
-
offset?: number;
|
|
608
|
-
limit?: number;
|
|
609
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
610
|
-
/**
|
|
611
|
-
* Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
|
|
612
|
-
* HTTP DELETE /notification
|
|
613
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
614
|
-
*/
|
|
615
|
-
removeNotifications(queryParams?: {
|
|
616
|
-
id?: number;
|
|
617
|
-
type?: string;
|
|
618
|
-
from?: number;
|
|
619
|
-
to?: number;
|
|
620
|
-
realmId?: string;
|
|
621
|
-
userId?: string;
|
|
622
|
-
assetId?: string;
|
|
623
|
-
}, options?: O): RestResponse<void>;
|
|
595
|
+
}, options?: O): RestResponse<Model.UserAssetLink[]>;
|
|
624
596
|
/**
|
|
625
|
-
*
|
|
626
|
-
* HTTP POST /
|
|
627
|
-
* Java method: org.openremote.model.
|
|
597
|
+
* Removes all supplied links. Every item must identify the same realm and user.
|
|
598
|
+
* HTTP POST /asset/user/link/delete
|
|
599
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLinks
|
|
628
600
|
*/
|
|
629
|
-
|
|
601
|
+
deleteUserAssetLinks(userAssets: Model.UserAssetLink[], options?: O): RestResponse<void>;
|
|
630
602
|
/**
|
|
631
|
-
*
|
|
632
|
-
* HTTP
|
|
633
|
-
* Java method: org.openremote.model.
|
|
603
|
+
* Removes every asset link belonging to the user in the requested realm.
|
|
604
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}
|
|
605
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteAllUserAssetLinks
|
|
634
606
|
*/
|
|
635
|
-
|
|
636
|
-
type?: string;
|
|
637
|
-
from?: number;
|
|
638
|
-
to?: number;
|
|
639
|
-
realmId?: string;
|
|
640
|
-
userId?: string;
|
|
641
|
-
assetId?: string;
|
|
642
|
-
source?: Model.NotificationSource;
|
|
643
|
-
}, options?: O): RestResponse<number>;
|
|
607
|
+
deleteAllUserAssetLinks(realm: string, userId: string, options?: O): RestResponse<void>;
|
|
644
608
|
/**
|
|
645
|
-
*
|
|
646
|
-
* HTTP DELETE /
|
|
647
|
-
* Java method: org.openremote.model.
|
|
609
|
+
* Removes the link identified by realm, user, and asset. The caller must be allowed to administer asset links in that realm.
|
|
610
|
+
* HTTP DELETE /asset/user/link/{realm}/{userId}/{assetId}
|
|
611
|
+
* Java method: org.openremote.model.asset.AssetResource.deleteUserAssetLink
|
|
648
612
|
*/
|
|
649
|
-
|
|
613
|
+
deleteUserAssetLink(realm: string, userId: string, assetId: string, options?: O): RestResponse<void>;
|
|
650
614
|
/**
|
|
651
|
-
*
|
|
652
|
-
* HTTP
|
|
653
|
-
* Java method: org.openremote.model.
|
|
615
|
+
* Returns a fully loaded asset including its path and attributes. Access is constrained to the caller's realm and, for restricted users, linked assets.
|
|
616
|
+
* HTTP GET /asset/{assetId}
|
|
617
|
+
* Java method: org.openremote.model.asset.AssetResource.get
|
|
654
618
|
*/
|
|
655
|
-
|
|
656
|
-
targetId?: string;
|
|
657
|
-
}, options?: O): RestResponse<void>;
|
|
619
|
+
get(assetId: string, options?: O): RestResponse<Model.Asset>;
|
|
658
620
|
/**
|
|
659
|
-
*
|
|
660
|
-
* HTTP PUT /
|
|
661
|
-
* Java method: org.openremote.model.
|
|
621
|
+
* 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.
|
|
622
|
+
* HTTP PUT /asset/{assetId}
|
|
623
|
+
* Java method: org.openremote.model.asset.AssetResource.update
|
|
662
624
|
*/
|
|
663
|
-
|
|
664
|
-
|
|
625
|
+
update(assetId: string, asset: Model.Asset, options?: O): RestResponse<Model.Asset>;
|
|
626
|
+
/**
|
|
627
|
+
* 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.
|
|
628
|
+
* Response code 400 - The attribute write failed
|
|
629
|
+
* Response code 406 - The supplied value is not valid for the attribute
|
|
630
|
+
* Response code 429 - The attribute event queue is full; retry the write later
|
|
631
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}
|
|
632
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
633
|
+
*/
|
|
634
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName(assetId: string, attributeName: string, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
635
|
+
/**
|
|
636
|
+
* Submits an asynchronous attribute write using the supplied Unix timestamp in milliseconds. The result reports acceptance only; anonymous writes require public-write metadata.
|
|
637
|
+
* Response code 400 - The attribute write failed
|
|
638
|
+
* Response code 406 - The supplied value is not valid for the attribute
|
|
639
|
+
* Response code 429 - The attribute event queue is full; retry the write later
|
|
640
|
+
* HTTP PUT /asset/{assetId}/attribute/{attributeName}/{timestamp}
|
|
641
|
+
* Java method: org.openremote.model.asset.AssetResource.writeAttributeValue
|
|
642
|
+
*/
|
|
643
|
+
writeAttributeValue$PUT$asset_assetId_attribute_attributeName_timestamp(assetId: string, attributeName: string, timestamp: number, value: any, options?: O): RestResponse<Model.AttributeWriteResult>;
|
|
644
|
+
/**
|
|
645
|
+
* Sets parentAssetId as the parent of every asset listed in repeated assetIds query parameters. Parent and children must satisfy realm, access, and hierarchy constraints.
|
|
646
|
+
* HTTP PUT /asset/{parentAssetId}/child
|
|
647
|
+
* Java method: org.openremote.model.asset.AssetResource.updateParent
|
|
648
|
+
*/
|
|
649
|
+
updateParent(parentAssetId: string, queryParams?: {
|
|
650
|
+
assetIds?: string[];
|
|
665
651
|
}, options?: O): RestResponse<void>;
|
|
666
652
|
}
|
|
667
653
|
export declare class RulesResourceClient<O> {
|
|
@@ -794,21 +780,187 @@ export declare class RulesResourceClient<O> {
|
|
|
794
780
|
*/
|
|
795
781
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
796
782
|
}
|
|
797
|
-
export declare class
|
|
783
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
798
784
|
protected httpClient: HttpClient<O>;
|
|
799
785
|
constructor(httpClient: HttpClient<O>);
|
|
800
786
|
/**
|
|
801
|
-
*
|
|
802
|
-
*
|
|
803
|
-
*
|
|
787
|
+
* Returns all active realm-scoped service registrations for an active realm accessible to the caller.
|
|
788
|
+
* Response code 200 - List of registered external services
|
|
789
|
+
* HTTP GET /service
|
|
790
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
804
791
|
*/
|
|
805
|
-
|
|
792
|
+
getServices(queryParams?: {
|
|
793
|
+
realm?: string;
|
|
794
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
806
795
|
/**
|
|
807
|
-
*
|
|
808
|
-
*
|
|
809
|
-
*
|
|
796
|
+
* 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.
|
|
797
|
+
* Response code 200 - Service registered successfully
|
|
798
|
+
* Response code 400 - Invalid external service object
|
|
799
|
+
* Response code 409 - ExternalService instance already registered
|
|
800
|
+
* HTTP POST /service
|
|
801
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
802
|
+
*/
|
|
803
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
804
|
+
/**
|
|
805
|
+
* Returns active registrations marked as globally available across realms.
|
|
806
|
+
* Response code 200 - List of registered external services
|
|
807
|
+
* HTTP GET /service/global
|
|
808
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
809
|
+
*/
|
|
810
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
811
|
+
/**
|
|
812
|
+
* Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
|
|
813
|
+
* Response code 200 - Service registered successfully
|
|
814
|
+
* Response code 400 - Invalid external service object
|
|
815
|
+
* Response code 409 - ExternalService instance already registered
|
|
816
|
+
* HTTP POST /service/global
|
|
817
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
818
|
+
*/
|
|
819
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
820
|
+
/**
|
|
821
|
+
* Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
|
|
822
|
+
* Response code 204 - Service deregistered successfully
|
|
823
|
+
* Response code 404 - Service instance not found
|
|
824
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
825
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
826
|
+
*/
|
|
827
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
828
|
+
/**
|
|
829
|
+
* Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
|
|
830
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
831
|
+
* Response code 404 - ExternalService not found
|
|
832
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
833
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
834
|
+
*/
|
|
835
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
836
|
+
/**
|
|
837
|
+
* 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.
|
|
838
|
+
* Response code 204 - Heartbeat sent successfully
|
|
839
|
+
* Response code 404 - Service instance not found
|
|
840
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
841
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
842
|
+
*/
|
|
843
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
844
|
+
}
|
|
845
|
+
export declare class GatewayClientResourceClient<O> {
|
|
846
|
+
protected httpClient: HttpClient<O>;
|
|
847
|
+
constructor(httpClient: HttpClient<O>);
|
|
848
|
+
/**
|
|
849
|
+
* Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
|
|
850
|
+
* HTTP DELETE /gateway/connection
|
|
851
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
852
|
+
*/
|
|
853
|
+
deleteConnections(queryParams?: {
|
|
854
|
+
realm?: string[];
|
|
855
|
+
}, options?: O): RestResponse<void>;
|
|
856
|
+
/**
|
|
857
|
+
* Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
|
|
858
|
+
* HTTP GET /gateway/connection
|
|
859
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
860
|
+
*/
|
|
861
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
862
|
+
/**
|
|
863
|
+
* Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
|
|
864
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
865
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
866
|
+
*/
|
|
867
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
868
|
+
/**
|
|
869
|
+
* 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.
|
|
870
|
+
* Response code 204 - No gateway connection is configured for the realm
|
|
871
|
+
* HTTP GET /gateway/connection/{realm}
|
|
872
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
873
|
+
*/
|
|
874
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
875
|
+
/**
|
|
876
|
+
* 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.
|
|
877
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
878
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
879
|
+
*/
|
|
880
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
881
|
+
/**
|
|
882
|
+
* Returns the live connection state for the requested local realm.
|
|
883
|
+
* HTTP GET /gateway/status/{realm}
|
|
884
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
885
|
+
*/
|
|
886
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
887
|
+
}
|
|
888
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
889
|
+
protected httpClient: HttpClient<O>;
|
|
890
|
+
constructor(httpClient: HttpClient<O>);
|
|
891
|
+
/**
|
|
892
|
+
* 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.
|
|
893
|
+
* Response code 200 - A ZIP archive containing the exported data
|
|
894
|
+
* HTTP GET /asset/datapoint/export
|
|
895
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
896
|
+
*/
|
|
897
|
+
getDatapointExport(queryParams?: {
|
|
898
|
+
attributeRefs?: string;
|
|
899
|
+
fromTimestamp?: number;
|
|
900
|
+
toTimestamp?: number;
|
|
901
|
+
format?: Model.DatapointExportFormat;
|
|
902
|
+
}, options?: O): RestResponse<any>;
|
|
903
|
+
/**
|
|
904
|
+
* 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.
|
|
905
|
+
* HTTP GET /asset/datapoint/periods
|
|
906
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
907
|
+
*/
|
|
908
|
+
getDatapointPeriod(queryParams?: {
|
|
909
|
+
assetId?: string;
|
|
910
|
+
attributeName?: string;
|
|
911
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
912
|
+
/**
|
|
913
|
+
* 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.
|
|
914
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
915
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
916
|
+
*/
|
|
917
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
918
|
+
}
|
|
919
|
+
export declare class FlowResourceClient<O> {
|
|
920
|
+
protected httpClient: HttpClient<O>;
|
|
921
|
+
constructor(httpClient: HttpClient<O>);
|
|
922
|
+
/**
|
|
923
|
+
* Returns every supported flow node definition except the internal LOG_OUTPUT node.
|
|
924
|
+
* HTTP GET /flow
|
|
925
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
926
|
+
*/
|
|
927
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
928
|
+
/**
|
|
929
|
+
* Resolves one flow node definition by its model name.
|
|
930
|
+
* HTTP GET /flow/{name}
|
|
931
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
932
|
+
*/
|
|
933
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
934
|
+
/**
|
|
935
|
+
* Returns supported flow node definitions whose category matches the requested node type.
|
|
936
|
+
* HTTP GET /flow/{type}
|
|
937
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
938
|
+
*/
|
|
939
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
940
|
+
}
|
|
941
|
+
export declare class AppResourceClient<O> {
|
|
942
|
+
protected httpClient: HttpClient<O>;
|
|
943
|
+
constructor(httpClient: HttpClient<O>);
|
|
944
|
+
/**
|
|
945
|
+
* Returns the identifiers of applications installed in the Manager web root.
|
|
946
|
+
* HTTP GET /apps
|
|
947
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
948
|
+
*/
|
|
949
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
950
|
+
/**
|
|
951
|
+
* Loads the public console_config.json document used to configure console clients before sign-in.
|
|
952
|
+
* HTTP GET /apps/consoleConfig
|
|
953
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
954
|
+
*/
|
|
955
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
956
|
+
/**
|
|
957
|
+
* Loads each installed application's info.json file and returns the documents keyed by application identifier.
|
|
958
|
+
* HTTP GET /apps/info
|
|
959
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
810
960
|
*/
|
|
811
|
-
|
|
961
|
+
getAppInfos(options?: O): RestResponse<{
|
|
962
|
+
[index: string]: any;
|
|
963
|
+
}>;
|
|
812
964
|
}
|
|
813
965
|
export declare class UserResourceClient<O> {
|
|
814
966
|
protected httpClient: HttpClient<O>;
|
|
@@ -1016,205 +1168,53 @@ export declare class MapResourceClient<O> {
|
|
|
1016
1168
|
[id: string]: unknown;
|
|
1017
1169
|
}>;
|
|
1018
1170
|
}
|
|
1019
|
-
export declare class AssetDatapointResourceClient<O> {
|
|
1020
|
-
protected httpClient: HttpClient<O>;
|
|
1021
|
-
constructor(httpClient: HttpClient<O>);
|
|
1022
|
-
/**
|
|
1023
|
-
* Streams a ZIP archive containing exported datapoints for one or more attribute references over the requested inclusive time range. attributeRefs is a JSON-encoded array of objects with id and name fields.
|
|
1024
|
-
* Response code 200 - A ZIP archive containing the exported data
|
|
1025
|
-
* HTTP GET /asset/datapoint/export
|
|
1026
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
1027
|
-
*/
|
|
1028
|
-
getDatapointExport(queryParams?: {
|
|
1029
|
-
attributeRefs?: string;
|
|
1030
|
-
fromTimestamp?: number;
|
|
1031
|
-
toTimestamp?: number;
|
|
1032
|
-
format?: Model.DatapointExportFormat;
|
|
1033
|
-
}, options?: O): RestResponse<any>;
|
|
1034
|
-
/**
|
|
1035
|
-
* Returns the oldest and newest stored timestamps for one attribute. The asset and attribute must be readable by the authenticated user and configured for datapoint storage.
|
|
1036
|
-
* HTTP GET /asset/datapoint/periods
|
|
1037
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
1038
|
-
*/
|
|
1039
|
-
getDatapointPeriod(queryParams?: {
|
|
1040
|
-
assetId?: string;
|
|
1041
|
-
attributeName?: string;
|
|
1042
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
1043
|
-
/**
|
|
1044
|
-
* Returns stored historical values for one attribute. A null body returns the available series; a polymorphic query body controls the time range and retrieval or aggregation strategy. Anonymous access requires public-read access on both asset and attribute.
|
|
1045
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
1046
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
1047
|
-
*/
|
|
1048
|
-
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
1049
|
-
}
|
|
1050
|
-
export declare class AgentResourceClient<O> {
|
|
1051
|
-
protected httpClient: HttpClient<O>;
|
|
1052
|
-
constructor(httpClient: HttpClient<O>);
|
|
1053
|
-
/**
|
|
1054
|
-
* Runs the agent protocol's asset discovery, waits up to ten seconds for results, returns the discovered tree, and asynchronously persists discovered assets below the agent.
|
|
1055
|
-
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
1056
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
1057
|
-
*/
|
|
1058
|
-
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
1059
|
-
realm?: string;
|
|
1060
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
1061
|
-
/**
|
|
1062
|
-
* Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
|
|
1063
|
-
* Response code 405 - The selected agent protocol does not support asset import
|
|
1064
|
-
* HTTP POST /agent/assetImport/{agentId}
|
|
1065
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
1066
|
-
*/
|
|
1067
|
-
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
1068
|
-
realm?: string;
|
|
1069
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
1070
|
-
/**
|
|
1071
|
-
* Runs instance discovery for an agent type and returns candidate Agent assets. parentId selects local versus edge-gateway discovery; non-super users are always constrained to their authenticated realm.
|
|
1072
|
-
* Response code 415 - The selected agent protocol does not support instance discovery
|
|
1073
|
-
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
1074
|
-
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
1075
|
-
*/
|
|
1076
|
-
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
1077
|
-
parentId?: string;
|
|
1078
|
-
realm?: string;
|
|
1079
|
-
}, options?: O): RestResponse<Model.Agent[]>;
|
|
1080
|
-
}
|
|
1081
|
-
export declare class AlarmResourceClient<O> {
|
|
1082
|
-
protected httpClient: HttpClient<O>;
|
|
1083
|
-
constructor(httpClient: HttpClient<O>);
|
|
1084
|
-
/**
|
|
1085
|
-
* Creates a manual alarm in an accessible realm and optionally links it to the supplied asset IDs. The authenticated user or client becomes the alarm source.
|
|
1086
|
-
* HTTP POST /alarm
|
|
1087
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
1088
|
-
*/
|
|
1089
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
1090
|
-
assetIds?: string[];
|
|
1091
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
1092
|
-
/**
|
|
1093
|
-
* Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
|
|
1094
|
-
* HTTP GET /alarm
|
|
1095
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
1096
|
-
*/
|
|
1097
|
-
getAlarms(queryParams?: {
|
|
1098
|
-
realm?: string;
|
|
1099
|
-
status?: Model.AlarmStatus;
|
|
1100
|
-
assetId?: string;
|
|
1101
|
-
assigneeId?: string;
|
|
1102
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
1103
|
-
/**
|
|
1104
|
-
* Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
|
|
1105
|
-
* HTTP DELETE /alarm
|
|
1106
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
1107
|
-
*/
|
|
1108
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
1109
|
-
/**
|
|
1110
|
-
* Adds links between assets and one existing alarm.
|
|
1111
|
-
|
|
1112
|
-
The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
|
|
1113
|
-
every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
|
|
1114
|
-
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
1115
|
-
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
1116
|
-
|
|
1117
|
-
Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
|
|
1118
|
-
This operation does not remove existing links from the alarm.
|
|
1119
|
-
|
|
1120
|
-
* HTTP PUT /alarm/assets
|
|
1121
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
1122
|
-
*/
|
|
1123
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
1124
|
-
/**
|
|
1125
|
-
* Returns one alarm when its realm is active and accessible to the authenticated user.
|
|
1126
|
-
* HTTP GET /alarm/{alarmId}
|
|
1127
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
1128
|
-
*/
|
|
1129
|
-
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
1130
|
-
/**
|
|
1131
|
-
* Permanently removes one alarm after verifying access to its realm.
|
|
1132
|
-
* HTTP DELETE /alarm/{alarmId}
|
|
1133
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
1134
|
-
*/
|
|
1135
|
-
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
1136
|
-
/**
|
|
1137
|
-
* Updates the mutable state of an existing alarm after verifying access to its current realm.
|
|
1138
|
-
* HTTP PUT /alarm/{alarmId}
|
|
1139
|
-
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
1140
|
-
*/
|
|
1141
|
-
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
1142
|
-
/**
|
|
1143
|
-
* Returns links from the alarm to assets in the explicitly supplied accessible realm.
|
|
1144
|
-
* HTTP GET /alarm/{alarmId}/assets
|
|
1145
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
1146
|
-
*/
|
|
1147
|
-
getAssetLinks(alarmId: number, queryParams?: {
|
|
1148
|
-
realm?: string;
|
|
1149
|
-
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
1150
|
-
}
|
|
1151
|
-
export declare class StatusResourceClient<O> {
|
|
1152
|
-
protected httpClient: HttpClient<O>;
|
|
1153
|
-
constructor(httpClient: HttpClient<O>);
|
|
1154
|
-
/**
|
|
1155
|
-
* Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
|
|
1156
|
-
* HTTP GET /health
|
|
1157
|
-
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
1158
|
-
*/
|
|
1159
|
-
getHealthStatus(options?: O): RestResponse<{
|
|
1160
|
-
[index: string]: any;
|
|
1161
|
-
}>;
|
|
1162
|
-
/**
|
|
1163
|
-
* Returns public bootstrap information, including the Manager version and identity-provider URL.
|
|
1164
|
-
* HTTP GET /info
|
|
1165
|
-
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
1166
|
-
*/
|
|
1167
|
-
getInfo(options?: O): RestResponse<{
|
|
1168
|
-
[index: string]: any;
|
|
1169
|
-
}>;
|
|
1170
|
-
}
|
|
1171
1171
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
1172
1172
|
export declare class ApiClient {
|
|
1173
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
1173
1174
|
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1174
|
-
protected
|
|
1175
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
1176
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
1175
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
1177
1176
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
1178
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1179
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
1180
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1181
1177
|
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
1182
|
-
protected
|
|
1183
|
-
protected
|
|
1178
|
+
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1179
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
1180
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
1184
1181
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
1182
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
1183
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1184
|
+
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
1185
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
1185
1186
|
protected _assetResource: AxiosAssetResourceClient;
|
|
1186
|
-
protected _notificationResource: AxiosNotificationResourceClient;
|
|
1187
1187
|
protected _rulesResource: AxiosRulesResourceClient;
|
|
1188
|
-
protected
|
|
1188
|
+
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
1189
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1190
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1191
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
1192
|
+
protected _appResource: AxiosAppResourceClient;
|
|
1189
1193
|
protected _userResource: AxiosUserResourceClient;
|
|
1190
1194
|
protected _mapResource: AxiosMapResourceClient;
|
|
1191
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1192
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
1193
|
-
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1194
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
1195
1195
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1196
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1196
1197
|
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1197
|
-
get
|
|
1198
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1199
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
1198
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1200
1199
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1201
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1202
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1203
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1204
1200
|
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1205
|
-
get
|
|
1206
|
-
get
|
|
1201
|
+
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1202
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1203
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1207
1204
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1205
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1206
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1207
|
+
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1208
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1208
1209
|
get AssetResource(): AxiosAssetResourceClient;
|
|
1209
|
-
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1210
1210
|
get RulesResource(): AxiosRulesResourceClient;
|
|
1211
|
-
get
|
|
1211
|
+
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1212
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1213
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1214
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1215
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1212
1216
|
get UserResource(): AxiosUserResourceClient;
|
|
1213
1217
|
get MapResource(): AxiosMapResourceClient;
|
|
1214
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1215
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
1216
|
-
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1217
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
1218
1218
|
}
|
|
1219
1219
|
import * as Axios from "axios";
|
|
1220
1220
|
declare module "axios" {
|
|
@@ -1222,70 +1222,70 @@ declare module "axios" {
|
|
|
1222
1222
|
data: R;
|
|
1223
1223
|
}
|
|
1224
1224
|
}
|
|
1225
|
-
export declare class
|
|
1225
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1226
1226
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1227
1227
|
}
|
|
1228
|
-
export declare class
|
|
1228
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1229
1229
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1230
1230
|
}
|
|
1231
|
-
export declare class
|
|
1231
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1232
1232
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1233
1233
|
}
|
|
1234
|
-
export declare class
|
|
1234
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1235
1235
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1236
1236
|
}
|
|
1237
|
-
export declare class
|
|
1237
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1238
1238
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1239
1239
|
}
|
|
1240
|
-
export declare class
|
|
1240
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1241
1241
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1242
1242
|
}
|
|
1243
|
-
export declare class
|
|
1243
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1244
1244
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1245
1245
|
}
|
|
1246
|
-
export declare class
|
|
1246
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1247
1247
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1248
1248
|
}
|
|
1249
|
-
export declare class
|
|
1249
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1250
1250
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1251
1251
|
}
|
|
1252
|
-
export declare class
|
|
1252
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1253
1253
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1254
1254
|
}
|
|
1255
|
-
export declare class
|
|
1255
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1256
1256
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1257
1257
|
}
|
|
1258
|
-
export declare class
|
|
1258
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1259
1259
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1260
1260
|
}
|
|
1261
|
-
export declare class
|
|
1261
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1262
1262
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1263
1263
|
}
|
|
1264
|
-
export declare class
|
|
1264
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1265
1265
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1266
1266
|
}
|
|
1267
1267
|
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1268
1268
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1269
1269
|
}
|
|
1270
|
-
export declare class
|
|
1270
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1271
1271
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1272
1272
|
}
|
|
1273
|
-
export declare class
|
|
1273
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<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 AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1280
1280
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1281
1281
|
}
|
|
1282
|
-
export declare class
|
|
1282
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1283
1283
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1284
1284
|
}
|
|
1285
|
-
export declare class
|
|
1285
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1286
1286
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1287
1287
|
}
|
|
1288
|
-
export declare class
|
|
1288
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1289
1289
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1290
1290
|
}
|
|
1291
1291
|
//# sourceMappingURL=restclient.d.ts.map
|