@openremote/rest 1.32.0-snapshot.20261012122155 → 1.32.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.
|
@@ -9,187 +9,24 @@ export interface HttpClient<O> {
|
|
|
9
9
|
options?: O;
|
|
10
10
|
}): RestResponse<R>;
|
|
11
11
|
}
|
|
12
|
-
export declare class
|
|
13
|
-
protected httpClient: HttpClient<O>;
|
|
14
|
-
constructor(httpClient: HttpClient<O>);
|
|
15
|
-
/**
|
|
16
|
-
* 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.
|
|
17
|
-
* HTTP GET /notification
|
|
18
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
19
|
-
*/
|
|
20
|
-
getNotifications(queryParams?: {
|
|
21
|
-
id?: number;
|
|
22
|
-
type?: string;
|
|
23
|
-
from?: number;
|
|
24
|
-
to?: number;
|
|
25
|
-
realmId?: string;
|
|
26
|
-
userId?: string;
|
|
27
|
-
assetId?: string;
|
|
28
|
-
source?: Model.NotificationSource;
|
|
29
|
-
sort?: Model.SentNotificationSortField;
|
|
30
|
-
descending?: boolean;
|
|
31
|
-
offset?: number;
|
|
32
|
-
limit?: number;
|
|
33
|
-
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
34
|
-
/**
|
|
35
|
-
* Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
|
|
36
|
-
* HTTP DELETE /notification
|
|
37
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
38
|
-
*/
|
|
39
|
-
removeNotifications(queryParams?: {
|
|
40
|
-
id?: number;
|
|
41
|
-
type?: string;
|
|
42
|
-
from?: number;
|
|
43
|
-
to?: number;
|
|
44
|
-
realmId?: string;
|
|
45
|
-
userId?: string;
|
|
46
|
-
assetId?: string;
|
|
47
|
-
}, options?: O): RestResponse<void>;
|
|
48
|
-
/**
|
|
49
|
-
* 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.
|
|
50
|
-
* HTTP POST /notification/alert
|
|
51
|
-
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
52
|
-
*/
|
|
53
|
-
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
54
|
-
/**
|
|
55
|
-
* Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
|
|
56
|
-
* HTTP GET /notification/count
|
|
57
|
-
* Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
|
|
58
|
-
*/
|
|
59
|
-
getNotificationsCount(queryParams?: {
|
|
60
|
-
type?: string;
|
|
61
|
-
from?: number;
|
|
62
|
-
to?: number;
|
|
63
|
-
realmId?: string;
|
|
64
|
-
userId?: string;
|
|
65
|
-
assetId?: string;
|
|
66
|
-
source?: Model.NotificationSource;
|
|
67
|
-
}, options?: O): RestResponse<number>;
|
|
68
|
-
/**
|
|
69
|
-
* Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
|
|
70
|
-
* HTTP DELETE /notification/{notificationId}
|
|
71
|
-
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
72
|
-
*/
|
|
73
|
-
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
74
|
-
/**
|
|
75
|
-
* Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
|
|
76
|
-
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
77
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
78
|
-
*/
|
|
79
|
-
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
80
|
-
targetId?: string;
|
|
81
|
-
}, options?: O): RestResponse<void>;
|
|
82
|
-
/**
|
|
83
|
-
* 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.
|
|
84
|
-
* HTTP PUT /notification/{notificationId}/delivered
|
|
85
|
-
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
86
|
-
*/
|
|
87
|
-
notificationDelivered(notificationId: number, queryParams?: {
|
|
88
|
-
targetId?: string;
|
|
89
|
-
}, options?: O): RestResponse<void>;
|
|
90
|
-
}
|
|
91
|
-
export declare class GatewayClientResourceClient<O> {
|
|
92
|
-
protected httpClient: HttpClient<O>;
|
|
93
|
-
constructor(httpClient: HttpClient<O>);
|
|
94
|
-
/**
|
|
95
|
-
* Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
|
|
96
|
-
* HTTP DELETE /gateway/connection
|
|
97
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
98
|
-
*/
|
|
99
|
-
deleteConnections(queryParams?: {
|
|
100
|
-
realm?: string[];
|
|
101
|
-
}, options?: O): RestResponse<void>;
|
|
102
|
-
/**
|
|
103
|
-
* Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
|
|
104
|
-
* HTTP GET /gateway/connection
|
|
105
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
106
|
-
*/
|
|
107
|
-
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
108
|
-
/**
|
|
109
|
-
* Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
|
|
110
|
-
* HTTP DELETE /gateway/connection/{realm}
|
|
111
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
112
|
-
*/
|
|
113
|
-
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
114
|
-
/**
|
|
115
|
-
* 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.
|
|
116
|
-
* Response code 204 - No gateway connection is configured for the realm
|
|
117
|
-
* HTTP GET /gateway/connection/{realm}
|
|
118
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
119
|
-
*/
|
|
120
|
-
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
121
|
-
/**
|
|
122
|
-
* 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.
|
|
123
|
-
* HTTP PUT /gateway/connection/{realm}
|
|
124
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
125
|
-
*/
|
|
126
|
-
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
127
|
-
/**
|
|
128
|
-
* Returns the live connection state for the requested local realm.
|
|
129
|
-
* HTTP GET /gateway/status/{realm}
|
|
130
|
-
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
131
|
-
*/
|
|
132
|
-
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
133
|
-
}
|
|
134
|
-
export declare class AssetModelResourceClient<O> {
|
|
12
|
+
export declare class StatusResourceClient<O> {
|
|
135
13
|
protected httpClient: HttpClient<O>;
|
|
136
14
|
constructor(httpClient: HttpClient<O>);
|
|
137
15
|
/**
|
|
138
|
-
* Returns
|
|
139
|
-
* HTTP GET /
|
|
140
|
-
* Java method: org.openremote.model.
|
|
141
|
-
*/
|
|
142
|
-
getAssetDescriptors(queryParams?: {
|
|
143
|
-
parentId?: string;
|
|
144
|
-
parentType?: string;
|
|
145
|
-
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
146
|
-
/**
|
|
147
|
-
* Returns metadata for one asset type from this Manager or, when parentId is below a gateway, from that gateway's model. An unknown or gateway-provided type that is not locally available returns no content.
|
|
148
|
-
* Response code 204 - No model information is available for the requested asset type
|
|
149
|
-
* HTTP GET /model/assetInfo/{assetType}
|
|
150
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
151
|
-
*/
|
|
152
|
-
getAssetInfo(assetType: string, queryParams?: {
|
|
153
|
-
parentId?: string;
|
|
154
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
155
|
-
/**
|
|
156
|
-
* Returns type metadata from this Manager by default. When parentId identifies an asset below a gateway, the gateway's model is used instead; parentType can provide type context for a new parent that does not yet exist.
|
|
157
|
-
* HTTP GET /model/assetInfos
|
|
158
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
159
|
-
*/
|
|
160
|
-
getAssetInfos(queryParams?: {
|
|
161
|
-
parentId?: string;
|
|
162
|
-
parentType?: string;
|
|
163
|
-
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
164
|
-
/**
|
|
165
|
-
* Returns the JSON Schema and a weak ETag for the named value descriptor. Send If-None-Match on later requests to receive 304 when the schema has not changed.
|
|
166
|
-
* Response code 200 - The current JSON Schema
|
|
167
|
-
* Response code 304 - The supplied ETag still identifies the current schema
|
|
168
|
-
* HTTP GET /model/getValueDescriptorSchema
|
|
169
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
170
|
-
*/
|
|
171
|
-
getValueDescriptorSchema(queryParams?: {
|
|
172
|
-
name?: string;
|
|
173
|
-
}, options?: O): RestResponse<any>;
|
|
174
|
-
/**
|
|
175
|
-
* Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
176
|
-
* HTTP GET /model/metaItemDescriptors
|
|
177
|
-
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
16
|
+
* Returns health data keyed by registered health-provider name. A null provider result is represented as JSON null.
|
|
17
|
+
* HTTP GET /health
|
|
18
|
+
* Java method: org.openremote.model.system.StatusResource.getHealthStatus
|
|
178
19
|
*/
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
}, options?: O): RestResponse<{
|
|
182
|
-
[index: string]: Model.MetaItemDescriptor;
|
|
20
|
+
getHealthStatus(options?: O): RestResponse<{
|
|
21
|
+
[index: string]: any;
|
|
183
22
|
}>;
|
|
184
23
|
/**
|
|
185
|
-
* Returns
|
|
186
|
-
* HTTP GET /
|
|
187
|
-
* Java method: org.openremote.model.
|
|
24
|
+
* Returns public bootstrap information, including the Manager version and identity-provider URL.
|
|
25
|
+
* HTTP GET /info
|
|
26
|
+
* Java method: org.openremote.model.system.StatusResource.getInfo
|
|
188
27
|
*/
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
}, options?: O): RestResponse<{
|
|
192
|
-
[index: string]: Model.ValueDescriptor;
|
|
28
|
+
getInfo(options?: O): RestResponse<{
|
|
29
|
+
[index: string]: any;
|
|
193
30
|
}>;
|
|
194
31
|
}
|
|
195
32
|
export declare class UserResourceClient<O> {
|
|
@@ -347,223 +184,202 @@ export declare class UserResourceClient<O> {
|
|
|
347
184
|
*/
|
|
348
185
|
get(realm: string, userId: string, options?: O): RestResponse<Model.User>;
|
|
349
186
|
}
|
|
350
|
-
export declare class
|
|
187
|
+
export declare class ProvisioningResourceClient<O> {
|
|
351
188
|
protected httpClient: HttpClient<O>;
|
|
352
189
|
constructor(httpClient: HttpClient<O>);
|
|
353
190
|
/**
|
|
354
|
-
*
|
|
355
|
-
* HTTP
|
|
356
|
-
* Java method: org.openremote.model.
|
|
191
|
+
* Persists a new provisioning configuration and returns its generated numeric identifier. This operation is restricted to a super administrator.
|
|
192
|
+
* HTTP POST /provisioning
|
|
193
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.createProvisioningConfig
|
|
357
194
|
*/
|
|
358
|
-
|
|
195
|
+
createProvisioningConfig(provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<number>;
|
|
359
196
|
/**
|
|
360
|
-
*
|
|
361
|
-
* HTTP
|
|
362
|
-
* Java method: org.openremote.model.
|
|
197
|
+
* Returns every provisioning configuration. This operation is restricted to a super administrator.
|
|
198
|
+
* HTTP GET /provisioning
|
|
199
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.getProvisioningConfigs
|
|
363
200
|
*/
|
|
364
|
-
|
|
201
|
+
getProvisioningConfigs(options?: O): RestResponse<Model.ProvisioningConfigUnion<any, any>[]>;
|
|
365
202
|
/**
|
|
366
|
-
* Permanently removes
|
|
367
|
-
* HTTP DELETE /
|
|
368
|
-
* Java method: org.openremote.model.
|
|
203
|
+
* Permanently removes the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
204
|
+
* HTTP DELETE /provisioning/{id}
|
|
205
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.deleteProvisioningConfig
|
|
369
206
|
*/
|
|
370
|
-
|
|
207
|
+
deleteProvisioningConfig(id: number, options?: O): RestResponse<void>;
|
|
371
208
|
/**
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
209
|
+
* Replaces the provisioning configuration identified by the path. This operation is restricted to a super administrator.
|
|
210
|
+
* HTTP PUT /provisioning/{id}
|
|
211
|
+
* Java method: org.openremote.model.provisioning.ProvisioningResource.updateProvisioningConfig
|
|
376
212
|
*/
|
|
377
|
-
|
|
378
|
-
level?: Model.SyslogLevel;
|
|
379
|
-
per_page?: number;
|
|
380
|
-
page?: number;
|
|
381
|
-
from?: number;
|
|
382
|
-
to?: number;
|
|
383
|
-
category?: Model.SyslogCategory[];
|
|
384
|
-
subCategory?: string[];
|
|
385
|
-
}, options?: O): RestResponse<any>;
|
|
213
|
+
updateProvisioningConfig(id: number, provisioningConfig: Model.ProvisioningConfigUnion<any, any>, options?: O): RestResponse<void>;
|
|
386
214
|
}
|
|
387
|
-
export declare class
|
|
215
|
+
export declare class AssetPredictedDatapointResourceClient<O> {
|
|
388
216
|
protected httpClient: HttpClient<O>;
|
|
389
217
|
constructor(httpClient: HttpClient<O>);
|
|
390
218
|
/**
|
|
391
|
-
*
|
|
392
|
-
*
|
|
393
|
-
*
|
|
394
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
219
|
+
* 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.
|
|
220
|
+
* HTTP POST /asset/predicted/{assetId}/{attributeName}
|
|
221
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.getPredictedDatapoints
|
|
395
222
|
*/
|
|
396
|
-
|
|
397
|
-
attributeRefs?: string;
|
|
398
|
-
fromTimestamp?: number;
|
|
399
|
-
toTimestamp?: number;
|
|
400
|
-
format?: Model.DatapointExportFormat;
|
|
401
|
-
}, options?: O): RestResponse<any>;
|
|
223
|
+
getPredictedDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
402
224
|
/**
|
|
403
|
-
*
|
|
404
|
-
* HTTP
|
|
405
|
-
* Java method: org.openremote.model.datapoint.
|
|
225
|
+
* 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.
|
|
226
|
+
* HTTP PUT /asset/predicted/{assetId}/{attributeName}
|
|
227
|
+
* Java method: org.openremote.model.datapoint.AssetPredictedDatapointResource.writePredictedDatapoints
|
|
406
228
|
*/
|
|
407
|
-
|
|
408
|
-
assetId?: string;
|
|
409
|
-
attributeName?: string;
|
|
410
|
-
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
411
|
-
/**
|
|
412
|
-
* 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.
|
|
413
|
-
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
414
|
-
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
415
|
-
*/
|
|
416
|
-
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
229
|
+
writePredictedDatapoints(assetId: string, attributeName: string, predictedDatapoints: Model.ValueDatapoint<any>[], options?: O): RestResponse<void>;
|
|
417
230
|
}
|
|
418
|
-
export declare class
|
|
231
|
+
export declare class DashboardResourceClient<O> {
|
|
419
232
|
protected httpClient: HttpClient<O>;
|
|
420
233
|
constructor(httpClient: HttpClient<O>);
|
|
421
234
|
/**
|
|
422
|
-
*
|
|
423
|
-
* HTTP
|
|
424
|
-
* Java method: org.openremote.model.
|
|
425
|
-
*/
|
|
426
|
-
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
427
|
-
/**
|
|
428
|
-
* Resolves one flow node definition by its model name.
|
|
429
|
-
* HTTP GET /flow/{name}
|
|
430
|
-
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
235
|
+
* Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
|
|
236
|
+
* HTTP POST /dashboard
|
|
237
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
431
238
|
*/
|
|
432
|
-
|
|
239
|
+
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
433
240
|
/**
|
|
434
|
-
*
|
|
435
|
-
* HTTP
|
|
436
|
-
* Java method: org.openremote.model.
|
|
241
|
+
* Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
|
|
242
|
+
* HTTP PUT /dashboard
|
|
243
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
437
244
|
*/
|
|
438
|
-
|
|
439
|
-
}
|
|
440
|
-
export declare class ProvisioningResourceClient<O> {
|
|
441
|
-
protected httpClient: HttpClient<O>;
|
|
442
|
-
constructor(httpClient: HttpClient<O>);
|
|
245
|
+
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
443
246
|
/**
|
|
444
|
-
*
|
|
445
|
-
* HTTP
|
|
446
|
-
* Java method: org.openremote.model.
|
|
247
|
+
* 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.
|
|
248
|
+
* HTTP GET /dashboard/all/{realm}
|
|
249
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.getAllRealmDashboards
|
|
447
250
|
*/
|
|
448
|
-
|
|
251
|
+
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
449
252
|
/**
|
|
450
|
-
*
|
|
451
|
-
* HTTP
|
|
452
|
-
* Java method: org.openremote.model.
|
|
253
|
+
* 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.
|
|
254
|
+
* HTTP POST /dashboard/query
|
|
255
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
453
256
|
*/
|
|
454
|
-
|
|
257
|
+
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
455
258
|
/**
|
|
456
|
-
* Permanently removes
|
|
457
|
-
* HTTP DELETE /
|
|
458
|
-
* Java method: org.openremote.model.
|
|
259
|
+
* Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
|
|
260
|
+
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
261
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
459
262
|
*/
|
|
460
|
-
|
|
263
|
+
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
461
264
|
/**
|
|
462
|
-
*
|
|
463
|
-
* HTTP
|
|
464
|
-
* Java method: org.openremote.model.
|
|
265
|
+
* Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
|
|
266
|
+
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
267
|
+
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
465
268
|
*/
|
|
466
|
-
|
|
269
|
+
get(realm: string, dashboardId: string, options?: O): RestResponse<Model.Dashboard>;
|
|
467
270
|
}
|
|
468
|
-
export declare class
|
|
271
|
+
export declare class AlarmResourceClient<O> {
|
|
469
272
|
protected httpClient: HttpClient<O>;
|
|
470
273
|
constructor(httpClient: HttpClient<O>);
|
|
471
274
|
/**
|
|
472
|
-
*
|
|
473
|
-
* HTTP POST /
|
|
474
|
-
* Java method: org.openremote.model.
|
|
275
|
+
* 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.
|
|
276
|
+
* HTTP POST /alarm
|
|
277
|
+
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
475
278
|
*/
|
|
476
|
-
|
|
279
|
+
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
280
|
+
assetIds?: string[];
|
|
281
|
+
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
477
282
|
/**
|
|
478
|
-
*
|
|
479
|
-
* HTTP
|
|
480
|
-
* Java method: org.openremote.model.
|
|
283
|
+
* Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
|
|
284
|
+
* HTTP GET /alarm
|
|
285
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
481
286
|
*/
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
287
|
+
getAlarms(queryParams?: {
|
|
288
|
+
realm?: string;
|
|
289
|
+
status?: Model.AlarmStatus;
|
|
290
|
+
assetId?: string;
|
|
291
|
+
assigneeId?: string;
|
|
292
|
+
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
487
293
|
/**
|
|
488
|
-
*
|
|
489
|
-
* HTTP
|
|
490
|
-
* Java method: org.openremote.model.
|
|
294
|
+
* Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
|
|
295
|
+
* HTTP DELETE /alarm
|
|
296
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
491
297
|
*/
|
|
492
|
-
|
|
298
|
+
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
493
299
|
/**
|
|
494
|
-
*
|
|
495
|
-
|
|
496
|
-
|
|
300
|
+
* Adds links between assets and one existing alarm.
|
|
301
|
+
|
|
302
|
+
The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
|
|
303
|
+
every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
|
|
304
|
+
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
305
|
+
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
306
|
+
|
|
307
|
+
Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
|
|
308
|
+
This operation does not remove existing links from the alarm.
|
|
309
|
+
|
|
310
|
+
* HTTP PUT /alarm/assets
|
|
311
|
+
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
497
312
|
*/
|
|
498
|
-
|
|
313
|
+
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
499
314
|
/**
|
|
500
|
-
* Returns
|
|
501
|
-
* HTTP GET /
|
|
502
|
-
* Java method: org.openremote.model.
|
|
315
|
+
* Returns one alarm when its realm is active and accessible to the authenticated user.
|
|
316
|
+
* HTTP GET /alarm/{alarmId}
|
|
317
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
503
318
|
*/
|
|
504
|
-
|
|
319
|
+
getAlarm(alarmId: number, options?: O): RestResponse<Model.SentAlarm>;
|
|
505
320
|
/**
|
|
506
|
-
* Permanently
|
|
507
|
-
*
|
|
508
|
-
*
|
|
509
|
-
* HTTP DELETE /realm/{name}
|
|
510
|
-
* Java method: org.openremote.model.security.RealmResource.delete
|
|
321
|
+
* Permanently removes one alarm after verifying access to its realm.
|
|
322
|
+
* HTTP DELETE /alarm/{alarmId}
|
|
323
|
+
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarm
|
|
511
324
|
*/
|
|
512
|
-
|
|
325
|
+
removeAlarm(alarmId: number, options?: O): RestResponse<void>;
|
|
513
326
|
/**
|
|
514
|
-
*
|
|
515
|
-
* HTTP
|
|
516
|
-
* Java method: org.openremote.model.
|
|
327
|
+
* Updates the mutable state of an existing alarm after verifying access to its current realm.
|
|
328
|
+
* HTTP PUT /alarm/{alarmId}
|
|
329
|
+
* Java method: org.openremote.model.alarm.AlarmResource.updateAlarm
|
|
517
330
|
*/
|
|
518
|
-
|
|
331
|
+
updateAlarm(alarmId: number, alarm: Model.SentAlarm, options?: O): RestResponse<void>;
|
|
519
332
|
/**
|
|
520
|
-
*
|
|
521
|
-
*
|
|
522
|
-
*
|
|
523
|
-
* Java method: org.openremote.model.security.RealmResource.update
|
|
333
|
+
* Returns links from the alarm to assets in the explicitly supplied accessible realm.
|
|
334
|
+
* HTTP GET /alarm/{alarmId}/assets
|
|
335
|
+
* Java method: org.openremote.model.alarm.AlarmResource.getAssetLinks
|
|
524
336
|
*/
|
|
525
|
-
|
|
337
|
+
getAssetLinks(alarmId: number, queryParams?: {
|
|
338
|
+
realm?: string;
|
|
339
|
+
}, options?: O): RestResponse<Model.AlarmAssetLink[]>;
|
|
526
340
|
}
|
|
527
|
-
export declare class
|
|
341
|
+
export declare class GatewayClientResourceClient<O> {
|
|
528
342
|
protected httpClient: HttpClient<O>;
|
|
529
343
|
constructor(httpClient: HttpClient<O>);
|
|
530
344
|
/**
|
|
531
|
-
*
|
|
532
|
-
* HTTP
|
|
533
|
-
* Java method: org.openremote.model.
|
|
345
|
+
* Removes connections for all repeated realm query parameters. Deleting multiple realms is restricted to super users.
|
|
346
|
+
* HTTP DELETE /gateway/connection
|
|
347
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnections
|
|
534
348
|
*/
|
|
535
|
-
|
|
349
|
+
deleteConnections(queryParams?: {
|
|
350
|
+
realm?: string[];
|
|
351
|
+
}, options?: O): RestResponse<void>;
|
|
536
352
|
/**
|
|
537
|
-
*
|
|
538
|
-
* HTTP
|
|
539
|
-
* Java method: org.openremote.model.
|
|
353
|
+
* Returns every configured central-manager connection. Unlike the single-realm endpoint, this operation is restricted to super users.
|
|
354
|
+
* HTTP GET /gateway/connection
|
|
355
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnections
|
|
540
356
|
*/
|
|
541
|
-
|
|
357
|
+
getConnections(options?: O): RestResponse<Model.GatewayConnection[]>;
|
|
542
358
|
/**
|
|
543
|
-
*
|
|
544
|
-
* HTTP
|
|
545
|
-
* Java method: org.openremote.model.
|
|
359
|
+
* Removes the central-manager connection for one realm. Realm administrators can remove their own connection; super users can remove any connection.
|
|
360
|
+
* HTTP DELETE /gateway/connection/{realm}
|
|
361
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.deleteConnection
|
|
546
362
|
*/
|
|
547
|
-
|
|
548
|
-
path?: string;
|
|
549
|
-
}, options?: O): RestResponse<string>;
|
|
363
|
+
deleteConnection(realm: string, options?: O): RestResponse<void>;
|
|
550
364
|
/**
|
|
551
|
-
*
|
|
552
|
-
* Response code
|
|
553
|
-
* HTTP GET /
|
|
554
|
-
* Java method: org.openremote.model.
|
|
365
|
+
* 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.
|
|
366
|
+
* Response code 204 - No gateway connection is configured for the realm
|
|
367
|
+
* HTTP GET /gateway/connection/{realm}
|
|
368
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnection
|
|
555
369
|
*/
|
|
556
|
-
|
|
557
|
-
}
|
|
558
|
-
export declare class ConsoleResourceClient<O> {
|
|
559
|
-
protected httpClient: HttpClient<O>;
|
|
560
|
-
constructor(httpClient: HttpClient<O>);
|
|
370
|
+
getConnection(realm: string, options?: O): RestResponse<Model.GatewayConnection>;
|
|
561
371
|
/**
|
|
562
|
-
* Creates
|
|
563
|
-
* HTTP
|
|
564
|
-
* Java method: org.openremote.model.
|
|
372
|
+
* 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.
|
|
373
|
+
* HTTP PUT /gateway/connection/{realm}
|
|
374
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.setConnection
|
|
565
375
|
*/
|
|
566
|
-
|
|
376
|
+
setConnection(realm: string, connection: Model.GatewayConnection, options?: O): RestResponse<void>;
|
|
377
|
+
/**
|
|
378
|
+
* Returns the live connection state for the requested local realm.
|
|
379
|
+
* HTTP GET /gateway/status/{realm}
|
|
380
|
+
* Java method: org.openremote.model.gateway.GatewayClientResource.getConnectionStatus
|
|
381
|
+
*/
|
|
382
|
+
getConnectionStatus(realm: string, options?: O): RestResponse<Model.ConnectionStatus>;
|
|
567
383
|
}
|
|
568
384
|
export declare class AssetResourceClient<O> {
|
|
569
385
|
protected httpClient: HttpClient<O>;
|
|
@@ -705,80 +521,321 @@ export declare class AssetResourceClient<O> {
|
|
|
705
521
|
assetIds?: string[];
|
|
706
522
|
}, options?: O): RestResponse<void>;
|
|
707
523
|
}
|
|
708
|
-
export declare class
|
|
524
|
+
export declare class ConfigurationResourceClient<O> {
|
|
709
525
|
protected httpClient: HttpClient<O>;
|
|
710
526
|
constructor(httpClient: HttpClient<O>);
|
|
711
527
|
/**
|
|
712
|
-
* Returns the
|
|
713
|
-
* HTTP GET /
|
|
714
|
-
* Java method: org.openremote.model.
|
|
528
|
+
* Returns the public Manager application configuration used by clients before and after authentication.
|
|
529
|
+
* HTTP GET /configuration/manager
|
|
530
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfig
|
|
715
531
|
*/
|
|
716
|
-
|
|
532
|
+
getManagerConfig(options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
717
533
|
/**
|
|
718
|
-
*
|
|
719
|
-
* HTTP
|
|
720
|
-
* Java method: org.openremote.model.
|
|
534
|
+
* Replaces manager_config.json and returns the stored configuration. This administrative change affects Manager UI branding and behavior.
|
|
535
|
+
* HTTP PUT /configuration/manager
|
|
536
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.update
|
|
721
537
|
*/
|
|
722
|
-
|
|
538
|
+
update(managerConfiguration: Model.ManagerAppConfig, options?: O): RestResponse<Model.ManagerAppConfig>;
|
|
723
539
|
/**
|
|
724
|
-
*
|
|
725
|
-
* HTTP
|
|
726
|
-
* Java method: org.openremote.model.
|
|
540
|
+
* Decodes and stores the supplied FileInfo under the requested relative path, then returns its Manager API path.
|
|
541
|
+
* HTTP POST /configuration/manager/file
|
|
542
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.fileUpload
|
|
727
543
|
*/
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
}>;
|
|
544
|
+
fileUpload(fileInfo: Model.FileInfo, queryParams?: {
|
|
545
|
+
path?: string;
|
|
546
|
+
}, options?: O): RestResponse<string>;
|
|
547
|
+
/**
|
|
548
|
+
* Streams a previously uploaded configuration image using its detected media type.
|
|
549
|
+
* Response code 200 - The image file
|
|
550
|
+
* HTTP GET /configuration/manager/image/{filename: .+}
|
|
551
|
+
* Java method: org.openremote.model.manager.ConfigurationResource.getManagerConfigImage
|
|
552
|
+
*/
|
|
553
|
+
getManagerConfigImage(filename: string, options?: O): RestResponse<any>;
|
|
731
554
|
}
|
|
732
|
-
export declare class
|
|
555
|
+
export declare class ExternalServiceResourceClient<O> {
|
|
733
556
|
protected httpClient: HttpClient<O>;
|
|
734
557
|
constructor(httpClient: HttpClient<O>);
|
|
735
558
|
/**
|
|
736
|
-
*
|
|
737
|
-
*
|
|
738
|
-
*
|
|
559
|
+
* Returns all active realm-scoped service registrations for an active realm accessible to the caller.
|
|
560
|
+
* Response code 200 - List of registered external services
|
|
561
|
+
* HTTP GET /service
|
|
562
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
739
563
|
*/
|
|
740
|
-
|
|
564
|
+
getServices(queryParams?: {
|
|
741
565
|
realm?: string;
|
|
742
|
-
}, options?: O): RestResponse<Model.
|
|
566
|
+
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
743
567
|
/**
|
|
744
|
-
*
|
|
745
|
-
* Response code
|
|
746
|
-
*
|
|
747
|
-
*
|
|
568
|
+
* 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.
|
|
569
|
+
* Response code 200 - Service registered successfully
|
|
570
|
+
* Response code 400 - Invalid external service object
|
|
571
|
+
* Response code 409 - ExternalService instance already registered
|
|
572
|
+
* HTTP POST /service
|
|
573
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
748
574
|
*/
|
|
749
|
-
|
|
750
|
-
realm?: string;
|
|
751
|
-
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
575
|
+
registerService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
752
576
|
/**
|
|
753
|
-
*
|
|
754
|
-
* Response code
|
|
755
|
-
* HTTP GET /
|
|
756
|
-
* Java method: org.openremote.model.
|
|
577
|
+
* Returns active registrations marked as globally available across realms.
|
|
578
|
+
* Response code 200 - List of registered external services
|
|
579
|
+
* HTTP GET /service/global
|
|
580
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
757
581
|
*/
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
582
|
+
getGlobalServices(options?: O): RestResponse<Model.ExternalService[]>;
|
|
583
|
+
/**
|
|
584
|
+
* Registers a service visible in every realm. The caller must be a super-user service account and the request must use the master realm.
|
|
585
|
+
* Response code 200 - Service registered successfully
|
|
586
|
+
* Response code 400 - Invalid external service object
|
|
587
|
+
* Response code 409 - ExternalService instance already registered
|
|
588
|
+
* HTTP POST /service/global
|
|
589
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
590
|
+
*/
|
|
591
|
+
registerGlobalService(service: Model.ExternalService, options?: O): RestResponse<Model.ExternalService>;
|
|
592
|
+
/**
|
|
593
|
+
* Removes an active service registration. The caller must be the service account that registered it; global-service removal additionally requires a super user.
|
|
594
|
+
* Response code 204 - Service deregistered successfully
|
|
595
|
+
* Response code 404 - Service instance not found
|
|
596
|
+
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
597
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
598
|
+
*/
|
|
599
|
+
deregisterService(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
600
|
+
/**
|
|
601
|
+
* Returns one registered instance by stable service ID and numeric instance ID, after verifying access to the service's realm.
|
|
602
|
+
* Response code 200 - ExternalService retrieved successfully
|
|
603
|
+
* Response code 404 - ExternalService not found
|
|
604
|
+
* HTTP GET /service/{serviceId}/{instanceId}
|
|
605
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
606
|
+
*/
|
|
607
|
+
getService(serviceId: string, instanceId: number, options?: O): RestResponse<Model.ExternalService>;
|
|
608
|
+
/**
|
|
609
|
+
* 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.
|
|
610
|
+
* Response code 204 - Heartbeat sent successfully
|
|
611
|
+
* Response code 404 - Service instance not found
|
|
612
|
+
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
613
|
+
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
614
|
+
*/
|
|
615
|
+
heartbeat(serviceId: string, instanceId: number, options?: O): RestResponse<void>;
|
|
762
616
|
}
|
|
763
|
-
export declare class
|
|
617
|
+
export declare class MapResourceClient<O> {
|
|
764
618
|
protected httpClient: HttpClient<O>;
|
|
765
619
|
constructor(httpClient: HttpClient<O>);
|
|
766
620
|
/**
|
|
767
|
-
* Returns
|
|
768
|
-
* HTTP GET /
|
|
769
|
-
* Java method: org.openremote.model.
|
|
621
|
+
* Returns realm-aware public MapLibre settings with externally reachable URLs derived from proxy headers.
|
|
622
|
+
* HTTP GET /map
|
|
623
|
+
* Java method: org.openremote.model.map.MapResource.getSettings
|
|
770
624
|
*/
|
|
771
|
-
|
|
772
|
-
[
|
|
625
|
+
getSettings(options?: O): RestResponse<{
|
|
626
|
+
[id: string]: unknown;
|
|
773
627
|
}>;
|
|
774
628
|
/**
|
|
775
|
-
*
|
|
776
|
-
* HTTP
|
|
777
|
-
* Java method: org.openremote.model.
|
|
629
|
+
* Stores the map configuration and returns the resulting public MapLibre settings.
|
|
630
|
+
* HTTP PUT /map
|
|
631
|
+
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
778
632
|
*/
|
|
779
|
-
|
|
780
|
-
[
|
|
633
|
+
saveSettings(mapConfig: Model.MapConfig, options?: O): RestResponse<{
|
|
634
|
+
[id: string]: unknown;
|
|
781
635
|
}>;
|
|
636
|
+
/**
|
|
637
|
+
* Deletes the installed custom MBTiles database and returns the fallback public map settings.
|
|
638
|
+
* HTTP DELETE /map/deleteMap
|
|
639
|
+
* Java method: org.openremote.model.map.MapResource.deleteMap
|
|
640
|
+
*/
|
|
641
|
+
deleteMap(options?: O): RestResponse<{
|
|
642
|
+
[id: string]: unknown;
|
|
643
|
+
}>;
|
|
644
|
+
/**
|
|
645
|
+
* Reports whether custom MBTiles data is installed and the maximum accepted upload size.
|
|
646
|
+
* HTTP GET /map/getCustomMapInfo
|
|
647
|
+
* Java method: org.openremote.model.map.MapResource.getCustomMapInfo
|
|
648
|
+
*/
|
|
649
|
+
getCustomMapInfo(options?: O): RestResponse<{
|
|
650
|
+
[id: string]: unknown;
|
|
651
|
+
}>;
|
|
652
|
+
/**
|
|
653
|
+
* Returns a pre-compressed Mapbox vector tile for the requested zoom, column, and row coordinates.
|
|
654
|
+
* Response code 200 - Gzip-compressed vector tile
|
|
655
|
+
* Response code 204 - No tile exists at the requested coordinates
|
|
656
|
+
* HTTP GET /map/tile/{zoom}/{column}/{row}
|
|
657
|
+
* Java method: org.openremote.model.map.MapResource.getTile
|
|
658
|
+
*/
|
|
659
|
+
getTile(zoom: number, column: number, row: number, options?: O): RestResponse<any>;
|
|
660
|
+
/**
|
|
661
|
+
* Stores the raw request body as the realm's custom MBTiles database and returns the resulting public map settings.
|
|
662
|
+
* HTTP POST /map/upload
|
|
663
|
+
* Java method: org.openremote.model.map.MapResource.uploadMap
|
|
664
|
+
*/
|
|
665
|
+
uploadMap(queryParams?: {
|
|
666
|
+
filename?: string;
|
|
667
|
+
}, options?: O): RestResponse<{
|
|
668
|
+
[id: string]: unknown;
|
|
669
|
+
}>;
|
|
670
|
+
}
|
|
671
|
+
export declare class AssetDatapointResourceClient<O> {
|
|
672
|
+
protected httpClient: HttpClient<O>;
|
|
673
|
+
constructor(httpClient: HttpClient<O>);
|
|
674
|
+
/**
|
|
675
|
+
* 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.
|
|
676
|
+
* Response code 200 - A ZIP archive containing the exported data
|
|
677
|
+
* HTTP GET /asset/datapoint/export
|
|
678
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointExport
|
|
679
|
+
*/
|
|
680
|
+
getDatapointExport(queryParams?: {
|
|
681
|
+
attributeRefs?: string;
|
|
682
|
+
fromTimestamp?: number;
|
|
683
|
+
toTimestamp?: number;
|
|
684
|
+
format?: Model.DatapointExportFormat;
|
|
685
|
+
}, options?: O): RestResponse<any>;
|
|
686
|
+
/**
|
|
687
|
+
* 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.
|
|
688
|
+
* HTTP GET /asset/datapoint/periods
|
|
689
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapointPeriod
|
|
690
|
+
*/
|
|
691
|
+
getDatapointPeriod(queryParams?: {
|
|
692
|
+
assetId?: string;
|
|
693
|
+
attributeName?: string;
|
|
694
|
+
}, options?: O): RestResponse<Model.DatapointPeriod>;
|
|
695
|
+
/**
|
|
696
|
+
* 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.
|
|
697
|
+
* HTTP POST /asset/datapoint/{assetId}/{attributeName}
|
|
698
|
+
* Java method: org.openremote.model.datapoint.AssetDatapointResource.getDatapoints
|
|
699
|
+
*/
|
|
700
|
+
getDatapoints(assetId: string, attributeName: string, query: Model.AssetDatapointQueryUnion, options?: O): RestResponse<Model.ValueDatapoint<any>[]>;
|
|
701
|
+
}
|
|
702
|
+
export declare class SyslogResourceClient<O> {
|
|
703
|
+
protected httpClient: HttpClient<O>;
|
|
704
|
+
constructor(httpClient: HttpClient<O>);
|
|
705
|
+
/**
|
|
706
|
+
* Returns the current log-storage and retention configuration.
|
|
707
|
+
* HTTP GET /syslog/config
|
|
708
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getConfig
|
|
709
|
+
*/
|
|
710
|
+
getConfig(options?: O): RestResponse<Model.SyslogConfig>;
|
|
711
|
+
/**
|
|
712
|
+
* Validates and applies log-storage and retention settings.
|
|
713
|
+
* HTTP PUT /syslog/config
|
|
714
|
+
* Java method: org.openremote.model.syslog.SyslogResource.updateConfig
|
|
715
|
+
*/
|
|
716
|
+
updateConfig(config: Model.SyslogConfig, options?: O): RestResponse<void>;
|
|
717
|
+
/**
|
|
718
|
+
* Permanently removes all events from the configured syslog storage.
|
|
719
|
+
* HTTP DELETE /syslog/event
|
|
720
|
+
* Java method: org.openremote.model.syslog.SyslogResource.clearEvents
|
|
721
|
+
*/
|
|
722
|
+
clearEvents(options?: O): RestResponse<void>;
|
|
723
|
+
/**
|
|
724
|
+
* 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.
|
|
725
|
+
* Response code 200 - The requested page of syslog events
|
|
726
|
+
* HTTP GET /syslog/event
|
|
727
|
+
* Java method: org.openremote.model.syslog.SyslogResource.getEvents
|
|
728
|
+
*/
|
|
729
|
+
getEvents(queryParams?: {
|
|
730
|
+
level?: Model.SyslogLevel;
|
|
731
|
+
per_page?: number;
|
|
732
|
+
page?: number;
|
|
733
|
+
from?: number;
|
|
734
|
+
to?: number;
|
|
735
|
+
category?: Model.SyslogCategory[];
|
|
736
|
+
subCategory?: string[];
|
|
737
|
+
}, options?: O): RestResponse<any>;
|
|
738
|
+
}
|
|
739
|
+
export declare class FlowResourceClient<O> {
|
|
740
|
+
protected httpClient: HttpClient<O>;
|
|
741
|
+
constructor(httpClient: HttpClient<O>);
|
|
742
|
+
/**
|
|
743
|
+
* Returns every supported flow node definition except the internal LOG_OUTPUT node.
|
|
744
|
+
* HTTP GET /flow
|
|
745
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitions
|
|
746
|
+
*/
|
|
747
|
+
getAllNodeDefinitions(options?: O): RestResponse<Model.Node[]>;
|
|
748
|
+
/**
|
|
749
|
+
* Resolves one flow node definition by its model name.
|
|
750
|
+
* HTTP GET /flow/{name}
|
|
751
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getNodeDefinition
|
|
752
|
+
*/
|
|
753
|
+
getNodeDefinition(name: string, options?: O): RestResponse<Model.Node>;
|
|
754
|
+
/**
|
|
755
|
+
* Returns supported flow node definitions whose category matches the requested node type.
|
|
756
|
+
* HTTP GET /flow/{type}
|
|
757
|
+
* Java method: org.openremote.model.rules.flow.FlowResource.getAllNodeDefinitionsByType
|
|
758
|
+
*/
|
|
759
|
+
getAllNodeDefinitionsByType(type: Model.NodeType, options?: O): RestResponse<Model.Node[]>;
|
|
760
|
+
}
|
|
761
|
+
export declare class NotificationResourceClient<O> {
|
|
762
|
+
protected httpClient: HttpClient<O>;
|
|
763
|
+
constructor(httpClient: HttpClient<O>);
|
|
764
|
+
/**
|
|
765
|
+
* 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.
|
|
766
|
+
* HTTP GET /notification
|
|
767
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotifications
|
|
768
|
+
*/
|
|
769
|
+
getNotifications(queryParams?: {
|
|
770
|
+
id?: number;
|
|
771
|
+
type?: string;
|
|
772
|
+
from?: number;
|
|
773
|
+
to?: number;
|
|
774
|
+
realmId?: string;
|
|
775
|
+
userId?: string;
|
|
776
|
+
assetId?: string;
|
|
777
|
+
source?: Model.NotificationSource;
|
|
778
|
+
sort?: Model.SentNotificationSortField;
|
|
779
|
+
descending?: boolean;
|
|
780
|
+
offset?: number;
|
|
781
|
+
limit?: number;
|
|
782
|
+
}, options?: O): RestResponse<Model.SentNotification[]>;
|
|
783
|
+
/**
|
|
784
|
+
* Permanently removes all records matching the optional ID, type, time, realm, user, and asset filters. This bulk operation is restricted to a super user.
|
|
785
|
+
* HTTP DELETE /notification
|
|
786
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotifications
|
|
787
|
+
*/
|
|
788
|
+
removeNotifications(queryParams?: {
|
|
789
|
+
id?: number;
|
|
790
|
+
type?: string;
|
|
791
|
+
from?: number;
|
|
792
|
+
to?: number;
|
|
793
|
+
realmId?: string;
|
|
794
|
+
userId?: string;
|
|
795
|
+
assetId?: string;
|
|
796
|
+
}, options?: O): RestResponse<void>;
|
|
797
|
+
/**
|
|
798
|
+
* 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.
|
|
799
|
+
* HTTP POST /notification/alert
|
|
800
|
+
* Java method: org.openremote.model.notification.NotificationResource.sendNotification
|
|
801
|
+
*/
|
|
802
|
+
sendNotification(notification: Model.Notification, options?: O): RestResponse<void>;
|
|
803
|
+
/**
|
|
804
|
+
* Returns the count for the same realm-scoped type, time, target, and source filters supported by getNotifications without loading notification records.
|
|
805
|
+
* HTTP GET /notification/count
|
|
806
|
+
* Java method: org.openremote.model.notification.NotificationResource.getNotificationsCount
|
|
807
|
+
*/
|
|
808
|
+
getNotificationsCount(queryParams?: {
|
|
809
|
+
type?: string;
|
|
810
|
+
from?: number;
|
|
811
|
+
to?: number;
|
|
812
|
+
realmId?: string;
|
|
813
|
+
userId?: string;
|
|
814
|
+
assetId?: string;
|
|
815
|
+
source?: Model.NotificationSource;
|
|
816
|
+
}, options?: O): RestResponse<number>;
|
|
817
|
+
/**
|
|
818
|
+
* Permanently removes one sent-notification record. This operation is restricted to a super user and is idempotent when the ID does not exist.
|
|
819
|
+
* HTTP DELETE /notification/{notificationId}
|
|
820
|
+
* Java method: org.openremote.model.notification.NotificationResource.removeNotification
|
|
821
|
+
*/
|
|
822
|
+
removeNotification(notificationId: number, options?: O): RestResponse<void>;
|
|
823
|
+
/**
|
|
824
|
+
* Marks one target's notification as acknowledged and stores the optional JSON acknowledgement value. Access rules are identical to notificationDelivered.
|
|
825
|
+
* HTTP PUT /notification/{notificationId}/acknowledged
|
|
826
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationAcknowledged
|
|
827
|
+
*/
|
|
828
|
+
notificationAcknowledged(notificationId: number, acknowledgement: any, queryParams?: {
|
|
829
|
+
targetId?: string;
|
|
830
|
+
}, options?: O): RestResponse<void>;
|
|
831
|
+
/**
|
|
832
|
+
* 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.
|
|
833
|
+
* HTTP PUT /notification/{notificationId}/delivered
|
|
834
|
+
* Java method: org.openremote.model.notification.NotificationResource.notificationDelivered
|
|
835
|
+
*/
|
|
836
|
+
notificationDelivered(notificationId: number, queryParams?: {
|
|
837
|
+
targetId?: string;
|
|
838
|
+
}, options?: O): RestResponse<void>;
|
|
782
839
|
}
|
|
783
840
|
export declare class RulesResourceClient<O> {
|
|
784
841
|
protected httpClient: HttpClient<O>;
|
|
@@ -910,99 +967,66 @@ export declare class RulesResourceClient<O> {
|
|
|
910
967
|
*/
|
|
911
968
|
updateGlobalRuleset(id: number, ruleset: Model.GlobalRuleset, options?: O): RestResponse<void>;
|
|
912
969
|
}
|
|
913
|
-
export declare class
|
|
970
|
+
export declare class AssetModelResourceClient<O> {
|
|
914
971
|
protected httpClient: HttpClient<O>;
|
|
915
972
|
constructor(httpClient: HttpClient<O>);
|
|
916
973
|
/**
|
|
917
|
-
* Returns
|
|
918
|
-
* HTTP GET /
|
|
919
|
-
* Java method: org.openremote.model.
|
|
920
|
-
*/
|
|
921
|
-
getSettings(options?: O): RestResponse<{
|
|
922
|
-
[id: string]: unknown;
|
|
923
|
-
}>;
|
|
924
|
-
/**
|
|
925
|
-
* Stores the map configuration and returns the resulting public MapLibre settings.
|
|
926
|
-
* HTTP PUT /map
|
|
927
|
-
* Java method: org.openremote.model.map.MapResource.saveSettings
|
|
974
|
+
* Returns the descriptors used to construct supported asset types, using a gateway model when the optional parent context resolves below a gateway.
|
|
975
|
+
* HTTP GET /model/assetDescriptors
|
|
976
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetDescriptors
|
|
928
977
|
*/
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
978
|
+
getAssetDescriptors(queryParams?: {
|
|
979
|
+
parentId?: string;
|
|
980
|
+
parentType?: string;
|
|
981
|
+
}, options?: O): RestResponse<Model.AssetDescriptor[]>;
|
|
932
982
|
/**
|
|
933
|
-
*
|
|
934
|
-
*
|
|
935
|
-
*
|
|
983
|
+
* Returns metadata for one asset type from this Manager or, when parentId is below a gateway, from that gateway's model. An unknown or gateway-provided type that is not locally available returns no content.
|
|
984
|
+
* Response code 204 - No model information is available for the requested asset type
|
|
985
|
+
* HTTP GET /model/assetInfo/{assetType}
|
|
986
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfo
|
|
936
987
|
*/
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
}>;
|
|
988
|
+
getAssetInfo(assetType: string, queryParams?: {
|
|
989
|
+
parentId?: string;
|
|
990
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo>;
|
|
940
991
|
/**
|
|
941
|
-
*
|
|
942
|
-
* HTTP GET /
|
|
943
|
-
* Java method: org.openremote.model.
|
|
992
|
+
* Returns type metadata from this Manager by default. When parentId identifies an asset below a gateway, the gateway's model is used instead; parentType can provide type context for a new parent that does not yet exist.
|
|
993
|
+
* HTTP GET /model/assetInfos
|
|
994
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getAssetInfos
|
|
944
995
|
*/
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
|
|
996
|
+
getAssetInfos(queryParams?: {
|
|
997
|
+
parentId?: string;
|
|
998
|
+
parentType?: string;
|
|
999
|
+
}, options?: O): RestResponse<Model.AssetTypeInfo[]>;
|
|
948
1000
|
/**
|
|
949
|
-
* Returns
|
|
950
|
-
* Response code 200 -
|
|
951
|
-
* Response code
|
|
952
|
-
* HTTP GET /
|
|
953
|
-
* Java method: org.openremote.model.
|
|
1001
|
+
* Returns the JSON Schema and a weak ETag for the named value descriptor. Send If-None-Match on later requests to receive 304 when the schema has not changed.
|
|
1002
|
+
* Response code 200 - The current JSON Schema
|
|
1003
|
+
* Response code 304 - The supplied ETag still identifies the current schema
|
|
1004
|
+
* HTTP GET /model/getValueDescriptorSchema
|
|
1005
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptorSchema
|
|
954
1006
|
*/
|
|
955
|
-
|
|
1007
|
+
getValueDescriptorSchema(queryParams?: {
|
|
1008
|
+
name?: string;
|
|
1009
|
+
}, options?: O): RestResponse<any>;
|
|
956
1010
|
/**
|
|
957
|
-
*
|
|
958
|
-
* HTTP
|
|
959
|
-
* Java method: org.openremote.model.
|
|
1011
|
+
* Returns attribute metadata descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
1012
|
+
* HTTP GET /model/metaItemDescriptors
|
|
1013
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getMetaItemDescriptors
|
|
960
1014
|
*/
|
|
961
|
-
|
|
962
|
-
|
|
1015
|
+
getMetaItemDescriptors(queryParams?: {
|
|
1016
|
+
parentId?: string;
|
|
963
1017
|
}, options?: O): RestResponse<{
|
|
964
|
-
[
|
|
1018
|
+
[index: string]: Model.MetaItemDescriptor;
|
|
965
1019
|
}>;
|
|
966
|
-
}
|
|
967
|
-
export declare class DashboardResourceClient<O> {
|
|
968
|
-
protected httpClient: HttpClient<O>;
|
|
969
|
-
constructor(httpClient: HttpClient<O>);
|
|
970
|
-
/**
|
|
971
|
-
* Creates a dashboard in an accessible realm. The server assigns the authenticated user as owner and initially stores the dashboard with shared access.
|
|
972
|
-
* HTTP POST /dashboard
|
|
973
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.create
|
|
974
|
-
*/
|
|
975
|
-
create(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
976
|
-
/**
|
|
977
|
-
* Updates an existing dashboard when the authenticated user can modify it in the dashboard's realm.
|
|
978
|
-
* HTTP PUT /dashboard
|
|
979
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.update
|
|
980
|
-
*/
|
|
981
|
-
update(dashboard: Model.Dashboard, options?: O): RestResponse<Model.Dashboard>;
|
|
982
1020
|
/**
|
|
983
|
-
* Returns
|
|
984
|
-
* HTTP GET /
|
|
985
|
-
* Java method: org.openremote.model.
|
|
986
|
-
*/
|
|
987
|
-
getAllRealmDashboards(realm: string, options?: O): RestResponse<Model.Dashboard[]>;
|
|
988
|
-
/**
|
|
989
|
-
* 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.
|
|
990
|
-
* HTTP POST /dashboard/query
|
|
991
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.query
|
|
992
|
-
*/
|
|
993
|
-
query(dashboardQuery: Model.DashboardQuery, options?: O): RestResponse<Model.Dashboard[]>;
|
|
994
|
-
/**
|
|
995
|
-
* Permanently removes a dashboard when the authenticated user can modify it in the requested realm.
|
|
996
|
-
* HTTP DELETE /dashboard/{realm}/{dashboardId}
|
|
997
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.delete
|
|
998
|
-
*/
|
|
999
|
-
delete(realm: string, dashboardId: string, options?: O): RestResponse<void>;
|
|
1000
|
-
/**
|
|
1001
|
-
* Returns one dashboard only when it is visible to the caller. Inaccessible and nonexistent dashboards both return 404 to avoid disclosing their existence.
|
|
1002
|
-
* HTTP GET /dashboard/{realm}/{dashboardId}
|
|
1003
|
-
* Java method: org.openremote.model.dashboard.DashboardResource.get
|
|
1021
|
+
* Returns attribute value descriptors keyed by descriptor name, using a gateway model when parentId resolves below a gateway.
|
|
1022
|
+
* HTTP GET /model/valueDescriptors
|
|
1023
|
+
* Java method: org.openremote.model.asset.AssetModelResource.getValueDescriptors
|
|
1004
1024
|
*/
|
|
1005
|
-
|
|
1025
|
+
getValueDescriptors(queryParams?: {
|
|
1026
|
+
parentId?: string;
|
|
1027
|
+
}, options?: O): RestResponse<{
|
|
1028
|
+
[index: string]: Model.ValueDescriptor;
|
|
1029
|
+
}>;
|
|
1006
1030
|
}
|
|
1007
1031
|
export declare class GatewayServiceResourceClient<O> {
|
|
1008
1032
|
protected httpClient: HttpClient<O>;
|
|
@@ -1035,190 +1059,166 @@ export declare class GatewayServiceResourceClient<O> {
|
|
|
1035
1059
|
/**
|
|
1036
1060
|
* Returns the tunnel matching realm, gateway, target host, and target port, or null when no active tunnel matches.
|
|
1037
1061
|
* Response code 204 - No active tunnel matches the requested endpoint
|
|
1038
|
-
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
1039
|
-
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
1040
|
-
*/
|
|
1041
|
-
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
1042
|
-
}
|
|
1043
|
-
export declare class AlarmResourceClient<O> {
|
|
1044
|
-
protected httpClient: HttpClient<O>;
|
|
1045
|
-
constructor(httpClient: HttpClient<O>);
|
|
1046
|
-
/**
|
|
1047
|
-
* 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.
|
|
1048
|
-
* HTTP POST /alarm
|
|
1049
|
-
* Java method: org.openremote.model.alarm.AlarmResource.createAlarm
|
|
1050
|
-
*/
|
|
1051
|
-
createAlarm(alarm: Model.Alarm, queryParams?: {
|
|
1052
|
-
assetIds?: string[];
|
|
1053
|
-
}, options?: O): RestResponse<Model.SentAlarm>;
|
|
1054
|
-
/**
|
|
1055
|
-
* Returns alarms in the requested accessible realm, optionally filtered by status, linked asset, or assignee. When realm is omitted, the authenticated realm is used.
|
|
1056
|
-
* HTTP GET /alarm
|
|
1057
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarms
|
|
1058
|
-
*/
|
|
1059
|
-
getAlarms(queryParams?: {
|
|
1060
|
-
realm?: string;
|
|
1061
|
-
status?: Model.AlarmStatus;
|
|
1062
|
-
assetId?: string;
|
|
1063
|
-
assigneeId?: string;
|
|
1064
|
-
}, options?: O): RestResponse<Model.SentAlarm[]>;
|
|
1065
|
-
/**
|
|
1066
|
-
* Permanently removes all alarms identified by the request body after verifying access to every alarm's realm.
|
|
1067
|
-
* HTTP DELETE /alarm
|
|
1068
|
-
* Java method: org.openremote.model.alarm.AlarmResource.removeAlarms
|
|
1069
|
-
*/
|
|
1070
|
-
removeAlarms(ids: number[], options?: O): RestResponse<void>;
|
|
1071
|
-
/**
|
|
1072
|
-
* Adds links between assets and one existing alarm.
|
|
1073
|
-
|
|
1074
|
-
The request body is a list for backward compatibility, but this operation now has single-alarm semantics:
|
|
1075
|
-
every item must contain the same `id.realm` and the same `id.alarmId`. The alarm must exist in that realm,
|
|
1076
|
-
every asset must exist in the same realm, and the authenticated user must have access to that realm. Requests
|
|
1077
|
-
containing mixed alarm IDs or realms are rejected as bad requests.
|
|
1078
|
-
|
|
1079
|
-
Existing links are left unchanged; duplicate links in the request or links that already exist are ignored.
|
|
1080
|
-
This operation does not remove existing links from the alarm.
|
|
1081
|
-
|
|
1082
|
-
* HTTP PUT /alarm/assets
|
|
1083
|
-
* Java method: org.openremote.model.alarm.AlarmResource.setAssetLinks
|
|
1084
|
-
*/
|
|
1085
|
-
setAssetLinks(links: Model.AlarmAssetLink[], options?: O): RestResponse<void>;
|
|
1086
|
-
/**
|
|
1087
|
-
* Returns one alarm when its realm is active and accessible to the authenticated user.
|
|
1088
|
-
* HTTP GET /alarm/{alarmId}
|
|
1089
|
-
* Java method: org.openremote.model.alarm.AlarmResource.getAlarm
|
|
1062
|
+
* HTTP GET /gateway/tunnel/{realm}/{id}/{target}/{targetPort}
|
|
1063
|
+
* Java method: org.openremote.model.gateway.GatewayServiceResource.getActiveTunnelInfo
|
|
1090
1064
|
*/
|
|
1091
|
-
|
|
1065
|
+
getActiveTunnelInfo(realm: string, id: string, target: string, targetPort: number, options?: O): RestResponse<Model.GatewayTunnelInfo>;
|
|
1066
|
+
}
|
|
1067
|
+
export declare class AppResourceClient<O> {
|
|
1068
|
+
protected httpClient: HttpClient<O>;
|
|
1069
|
+
constructor(httpClient: HttpClient<O>);
|
|
1092
1070
|
/**
|
|
1093
|
-
*
|
|
1094
|
-
* HTTP
|
|
1095
|
-
* Java method: org.openremote.model.
|
|
1071
|
+
* Returns the identifiers of applications installed in the Manager web root.
|
|
1072
|
+
* HTTP GET /apps
|
|
1073
|
+
* Java method: org.openremote.model.apps.AppResource.getApps
|
|
1096
1074
|
*/
|
|
1097
|
-
|
|
1075
|
+
getApps(options?: O): RestResponse<string[]>;
|
|
1098
1076
|
/**
|
|
1099
|
-
*
|
|
1100
|
-
* HTTP
|
|
1101
|
-
* Java method: org.openremote.model.
|
|
1077
|
+
* Loads the public console_config.json document used to configure console clients before sign-in.
|
|
1078
|
+
* HTTP GET /apps/consoleConfig
|
|
1079
|
+
* Java method: org.openremote.model.apps.AppResource.getConsoleConfig
|
|
1102
1080
|
*/
|
|
1103
|
-
|
|
1081
|
+
getConsoleConfig(options?: O): RestResponse<any>;
|
|
1104
1082
|
/**
|
|
1105
|
-
*
|
|
1106
|
-
* HTTP GET /
|
|
1107
|
-
* Java method: org.openremote.model.
|
|
1083
|
+
* Loads each installed application's info.json file and returns the documents keyed by application identifier.
|
|
1084
|
+
* HTTP GET /apps/info
|
|
1085
|
+
* Java method: org.openremote.model.apps.AppResource.getAppInfos
|
|
1108
1086
|
*/
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
}
|
|
1087
|
+
getAppInfos(options?: O): RestResponse<{
|
|
1088
|
+
[index: string]: any;
|
|
1089
|
+
}>;
|
|
1112
1090
|
}
|
|
1113
|
-
export declare class
|
|
1091
|
+
export declare class RealmResourceClient<O> {
|
|
1114
1092
|
protected httpClient: HttpClient<O>;
|
|
1115
1093
|
constructor(httpClient: HttpClient<O>);
|
|
1116
1094
|
/**
|
|
1117
|
-
*
|
|
1118
|
-
*
|
|
1119
|
-
*
|
|
1120
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getServices
|
|
1095
|
+
* Creates and configures a realm in the identity provider. This operation is restricted to a super user.
|
|
1096
|
+
* HTTP POST /realm
|
|
1097
|
+
* Java method: org.openremote.model.security.RealmResource.create
|
|
1121
1098
|
*/
|
|
1122
|
-
|
|
1123
|
-
realm?: string;
|
|
1124
|
-
}, options?: O): RestResponse<Model.ExternalService[]>;
|
|
1099
|
+
create(realm: Model.Realm, options?: O): RestResponse<void>;
|
|
1125
1100
|
/**
|
|
1126
|
-
*
|
|
1127
|
-
*
|
|
1128
|
-
*
|
|
1129
|
-
* Response code 409 - ExternalService instance already registered
|
|
1130
|
-
* HTTP POST /service
|
|
1131
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerService
|
|
1101
|
+
* Returns complete realm records from the identity provider. This operation is restricted to a super user.
|
|
1102
|
+
* HTTP GET /realm
|
|
1103
|
+
* Java method: org.openremote.model.security.RealmResource.getAll
|
|
1132
1104
|
*/
|
|
1133
|
-
|
|
1105
|
+
getAll(options?: O): RestResponse<Model.Realm[]>;
|
|
1134
1106
|
/**
|
|
1135
|
-
* Returns
|
|
1136
|
-
*
|
|
1137
|
-
*
|
|
1138
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getGlobalServices
|
|
1107
|
+
* Returns only realm name and display name. Super users receive all realms; authenticated users receive their realm; anonymous callers receive the request realm.
|
|
1108
|
+
* HTTP GET /realm/accessible
|
|
1109
|
+
* Java method: org.openremote.model.security.RealmResource.getAccessible
|
|
1139
1110
|
*/
|
|
1140
|
-
|
|
1111
|
+
getAccessible(options?: O): RestResponse<Model.Realm[]>;
|
|
1141
1112
|
/**
|
|
1142
|
-
*
|
|
1143
|
-
* Response code
|
|
1144
|
-
* Response code
|
|
1145
|
-
*
|
|
1146
|
-
*
|
|
1147
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.registerGlobalService
|
|
1113
|
+
* Permanently deletes a realm from the identity provider. The master realm cannot be deleted; related Manager data is not automatically removed.
|
|
1114
|
+
* Response code 405 - The master realm cannot be deleted
|
|
1115
|
+
* Response code 409 - Realm cannot be deleted while it still contains assets
|
|
1116
|
+
* HTTP DELETE /realm/{name}
|
|
1117
|
+
* Java method: org.openremote.model.security.RealmResource.delete
|
|
1148
1118
|
*/
|
|
1149
|
-
|
|
1119
|
+
delete(name: string, options?: O): RestResponse<void>;
|
|
1150
1120
|
/**
|
|
1151
|
-
*
|
|
1152
|
-
*
|
|
1153
|
-
*
|
|
1154
|
-
* HTTP DELETE /service/{serviceId}/{instanceId}
|
|
1155
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.deregisterService
|
|
1121
|
+
* 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.
|
|
1122
|
+
* HTTP GET /realm/{name}
|
|
1123
|
+
* Java method: org.openremote.model.security.RealmResource.get
|
|
1156
1124
|
*/
|
|
1157
|
-
|
|
1125
|
+
get(name: string, options?: O): RestResponse<Model.Realm>;
|
|
1158
1126
|
/**
|
|
1159
|
-
*
|
|
1160
|
-
* Response code
|
|
1161
|
-
*
|
|
1162
|
-
*
|
|
1163
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.getService
|
|
1127
|
+
* Updates a realm through the identity provider. Super-user access is required; the master realm cannot be renamed or disabled.
|
|
1128
|
+
* Response code 405 - The requested mutation is not allowed for the master realm
|
|
1129
|
+
* HTTP PUT /realm/{name}
|
|
1130
|
+
* Java method: org.openremote.model.security.RealmResource.update
|
|
1164
1131
|
*/
|
|
1165
|
-
|
|
1132
|
+
update(name: string, realm: Model.Realm, options?: O): RestResponse<void>;
|
|
1133
|
+
}
|
|
1134
|
+
export declare class AgentResourceClient<O> {
|
|
1135
|
+
protected httpClient: HttpClient<O>;
|
|
1136
|
+
constructor(httpClient: HttpClient<O>);
|
|
1166
1137
|
/**
|
|
1167
|
-
*
|
|
1168
|
-
*
|
|
1169
|
-
*
|
|
1170
|
-
* HTTP PUT /service/{serviceId}/{instanceId}
|
|
1171
|
-
* Java method: org.openremote.model.services.ExternalServiceResource.heartbeat
|
|
1138
|
+
* 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.
|
|
1139
|
+
* HTTP GET /agent/assetDiscovery/{agentId}
|
|
1140
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetDiscovery
|
|
1172
1141
|
*/
|
|
1173
|
-
|
|
1142
|
+
doProtocolAssetDiscovery(agentId: string, queryParams?: {
|
|
1143
|
+
realm?: string;
|
|
1144
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
1145
|
+
/**
|
|
1146
|
+
* Decodes the supplied FileInfo, asks the agent protocol to import it, persists the returned asset tree below the agent, and returns that tree.
|
|
1147
|
+
* Response code 405 - The selected agent protocol does not support asset import
|
|
1148
|
+
* HTTP POST /agent/assetImport/{agentId}
|
|
1149
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolAssetImport
|
|
1150
|
+
*/
|
|
1151
|
+
doProtocolAssetImport(agentId: string, fileInfo: Model.FileInfo, queryParams?: {
|
|
1152
|
+
realm?: string;
|
|
1153
|
+
}, options?: O): RestResponse<Model.AssetTreeNode[]>;
|
|
1154
|
+
/**
|
|
1155
|
+
* 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.
|
|
1156
|
+
* Response code 415 - The selected agent protocol does not support instance discovery
|
|
1157
|
+
* HTTP GET /agent/instanceDiscovery/{agentType}
|
|
1158
|
+
* Java method: org.openremote.model.asset.agent.AgentResource.doProtocolInstanceDiscovery
|
|
1159
|
+
*/
|
|
1160
|
+
doProtocolInstanceDiscovery(agentType: string, queryParams?: {
|
|
1161
|
+
parentId?: string;
|
|
1162
|
+
realm?: string;
|
|
1163
|
+
}, options?: O): RestResponse<Model.Agent[]>;
|
|
1164
|
+
}
|
|
1165
|
+
export declare class ConsoleResourceClient<O> {
|
|
1166
|
+
protected httpClient: HttpClient<O>;
|
|
1167
|
+
constructor(httpClient: HttpClient<O>);
|
|
1168
|
+
/**
|
|
1169
|
+
* 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.
|
|
1170
|
+
* HTTP POST /console/register
|
|
1171
|
+
* Java method: org.openremote.model.console.ConsoleResource.register
|
|
1172
|
+
*/
|
|
1173
|
+
register(consoleRegistration: Model.ConsoleRegistration, options?: O): RestResponse<Model.ConsoleRegistration>;
|
|
1174
1174
|
}
|
|
1175
1175
|
export type RestResponse<R> = Promise<Axios.GenericAxiosResponse<R>>;
|
|
1176
1176
|
export declare class ApiClient {
|
|
1177
|
-
protected
|
|
1178
|
-
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1179
|
-
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1177
|
+
protected _statusResource: AxiosStatusResourceClient;
|
|
1180
1178
|
protected _userResource: AxiosUserResourceClient;
|
|
1181
|
-
protected _syslogResource: AxiosSyslogResourceClient;
|
|
1182
|
-
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1183
|
-
protected _flowResource: AxiosFlowResourceClient;
|
|
1184
1179
|
protected _provisioningResource: AxiosProvisioningResourceClient;
|
|
1185
1180
|
protected _assetPredictedDatapointResource: AxiosAssetPredictedDatapointResourceClient;
|
|
1186
|
-
protected _realmResource: AxiosRealmResourceClient;
|
|
1187
|
-
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
1188
|
-
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1189
|
-
protected _assetResource: AxiosAssetResourceClient;
|
|
1190
|
-
protected _appResource: AxiosAppResourceClient;
|
|
1191
|
-
protected _agentResource: AxiosAgentResourceClient;
|
|
1192
|
-
protected _statusResource: AxiosStatusResourceClient;
|
|
1193
|
-
protected _rulesResource: AxiosRulesResourceClient;
|
|
1194
|
-
protected _mapResource: AxiosMapResourceClient;
|
|
1195
1181
|
protected _dashboardResource: AxiosDashboardResourceClient;
|
|
1196
|
-
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
1197
1182
|
protected _alarmResource: AxiosAlarmResourceClient;
|
|
1183
|
+
protected _gatewayClientResource: AxiosGatewayClientResourceClient;
|
|
1184
|
+
protected _assetResource: AxiosAssetResourceClient;
|
|
1185
|
+
protected _configurationResource: AxiosConfigurationResourceClient;
|
|
1198
1186
|
protected _externalServiceResource: AxiosExternalServiceResourceClient;
|
|
1187
|
+
protected _mapResource: AxiosMapResourceClient;
|
|
1188
|
+
protected _assetDatapointResource: AxiosAssetDatapointResourceClient;
|
|
1189
|
+
protected _syslogResource: AxiosSyslogResourceClient;
|
|
1190
|
+
protected _flowResource: AxiosFlowResourceClient;
|
|
1191
|
+
protected _notificationResource: AxiosNotificationResourceClient;
|
|
1192
|
+
protected _rulesResource: AxiosRulesResourceClient;
|
|
1193
|
+
protected _assetModelResource: AxiosAssetModelResourceClient;
|
|
1194
|
+
protected _gatewayServiceResource: AxiosGatewayServiceResourceClient;
|
|
1195
|
+
protected _appResource: AxiosAppResourceClient;
|
|
1196
|
+
protected _realmResource: AxiosRealmResourceClient;
|
|
1197
|
+
protected _agentResource: AxiosAgentResourceClient;
|
|
1198
|
+
protected _consoleResource: AxiosConsoleResourceClient;
|
|
1199
1199
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1200
|
-
get
|
|
1201
|
-
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1202
|
-
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1200
|
+
get StatusResource(): AxiosStatusResourceClient;
|
|
1203
1201
|
get UserResource(): AxiosUserResourceClient;
|
|
1204
|
-
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1205
|
-
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1206
|
-
get FlowResource(): AxiosFlowResourceClient;
|
|
1207
1202
|
get ProvisioningResource(): AxiosProvisioningResourceClient;
|
|
1208
1203
|
get AssetPredictedDatapointResource(): AxiosAssetPredictedDatapointResourceClient;
|
|
1209
|
-
get RealmResource(): AxiosRealmResourceClient;
|
|
1210
|
-
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1211
|
-
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1212
|
-
get AssetResource(): AxiosAssetResourceClient;
|
|
1213
|
-
get AppResource(): AxiosAppResourceClient;
|
|
1214
|
-
get AgentResource(): AxiosAgentResourceClient;
|
|
1215
|
-
get StatusResource(): AxiosStatusResourceClient;
|
|
1216
|
-
get RulesResource(): AxiosRulesResourceClient;
|
|
1217
|
-
get MapResource(): AxiosMapResourceClient;
|
|
1218
1204
|
get DashboardResource(): AxiosDashboardResourceClient;
|
|
1219
|
-
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1220
1205
|
get AlarmResource(): AxiosAlarmResourceClient;
|
|
1206
|
+
get GatewayClientResource(): AxiosGatewayClientResourceClient;
|
|
1207
|
+
get AssetResource(): AxiosAssetResourceClient;
|
|
1208
|
+
get ConfigurationResource(): AxiosConfigurationResourceClient;
|
|
1221
1209
|
get ExternalServiceResource(): AxiosExternalServiceResourceClient;
|
|
1210
|
+
get MapResource(): AxiosMapResourceClient;
|
|
1211
|
+
get AssetDatapointResource(): AxiosAssetDatapointResourceClient;
|
|
1212
|
+
get SyslogResource(): AxiosSyslogResourceClient;
|
|
1213
|
+
get FlowResource(): AxiosFlowResourceClient;
|
|
1214
|
+
get NotificationResource(): AxiosNotificationResourceClient;
|
|
1215
|
+
get RulesResource(): AxiosRulesResourceClient;
|
|
1216
|
+
get AssetModelResource(): AxiosAssetModelResourceClient;
|
|
1217
|
+
get GatewayServiceResource(): AxiosGatewayServiceResourceClient;
|
|
1218
|
+
get AppResource(): AxiosAppResourceClient;
|
|
1219
|
+
get RealmResource(): AxiosRealmResourceClient;
|
|
1220
|
+
get AgentResource(): AxiosAgentResourceClient;
|
|
1221
|
+
get ConsoleResource(): AxiosConsoleResourceClient;
|
|
1222
1222
|
}
|
|
1223
1223
|
import * as Axios from "axios";
|
|
1224
1224
|
declare module "axios" {
|
|
@@ -1226,70 +1226,70 @@ declare module "axios" {
|
|
|
1226
1226
|
data: R;
|
|
1227
1227
|
}
|
|
1228
1228
|
}
|
|
1229
|
-
export declare class
|
|
1229
|
+
export declare class AxiosStatusResourceClient extends StatusResourceClient<Axios.AxiosRequestConfig> {
|
|
1230
1230
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1231
1231
|
}
|
|
1232
|
-
export declare class
|
|
1232
|
+
export declare class AxiosUserResourceClient extends UserResourceClient<Axios.AxiosRequestConfig> {
|
|
1233
1233
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1234
1234
|
}
|
|
1235
|
-
export declare class
|
|
1235
|
+
export declare class AxiosProvisioningResourceClient extends ProvisioningResourceClient<Axios.AxiosRequestConfig> {
|
|
1236
1236
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1237
1237
|
}
|
|
1238
|
-
export declare class
|
|
1238
|
+
export declare class AxiosAssetPredictedDatapointResourceClient extends AssetPredictedDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1239
1239
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1240
1240
|
}
|
|
1241
|
-
export declare class
|
|
1241
|
+
export declare class AxiosDashboardResourceClient extends DashboardResourceClient<Axios.AxiosRequestConfig> {
|
|
1242
1242
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1243
1243
|
}
|
|
1244
|
-
export declare class
|
|
1244
|
+
export declare class AxiosAlarmResourceClient extends AlarmResourceClient<Axios.AxiosRequestConfig> {
|
|
1245
1245
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1246
1246
|
}
|
|
1247
|
-
export declare class
|
|
1247
|
+
export declare class AxiosGatewayClientResourceClient extends GatewayClientResourceClient<Axios.AxiosRequestConfig> {
|
|
1248
1248
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1249
1249
|
}
|
|
1250
|
-
export declare class
|
|
1250
|
+
export declare class AxiosAssetResourceClient extends AssetResourceClient<Axios.AxiosRequestConfig> {
|
|
1251
1251
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1252
1252
|
}
|
|
1253
|
-
export declare class
|
|
1253
|
+
export declare class AxiosConfigurationResourceClient extends ConfigurationResourceClient<Axios.AxiosRequestConfig> {
|
|
1254
1254
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1255
1255
|
}
|
|
1256
|
-
export declare class
|
|
1256
|
+
export declare class AxiosExternalServiceResourceClient extends ExternalServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1257
1257
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1258
1258
|
}
|
|
1259
|
-
export declare class
|
|
1259
|
+
export declare class AxiosMapResourceClient extends MapResourceClient<Axios.AxiosRequestConfig> {
|
|
1260
1260
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1261
1261
|
}
|
|
1262
|
-
export declare class
|
|
1262
|
+
export declare class AxiosAssetDatapointResourceClient extends AssetDatapointResourceClient<Axios.AxiosRequestConfig> {
|
|
1263
1263
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1264
1264
|
}
|
|
1265
|
-
export declare class
|
|
1265
|
+
export declare class AxiosSyslogResourceClient extends SyslogResourceClient<Axios.AxiosRequestConfig> {
|
|
1266
1266
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1267
1267
|
}
|
|
1268
|
-
export declare class
|
|
1268
|
+
export declare class AxiosFlowResourceClient extends FlowResourceClient<Axios.AxiosRequestConfig> {
|
|
1269
1269
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1270
1270
|
}
|
|
1271
|
-
export declare class
|
|
1271
|
+
export declare class AxiosNotificationResourceClient extends NotificationResourceClient<Axios.AxiosRequestConfig> {
|
|
1272
1272
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1273
1273
|
}
|
|
1274
|
-
export declare class
|
|
1274
|
+
export declare class AxiosRulesResourceClient extends RulesResourceClient<Axios.AxiosRequestConfig> {
|
|
1275
1275
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1276
1276
|
}
|
|
1277
|
-
export declare class
|
|
1277
|
+
export declare class AxiosAssetModelResourceClient extends AssetModelResourceClient<Axios.AxiosRequestConfig> {
|
|
1278
1278
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1279
1279
|
}
|
|
1280
|
-
export declare class
|
|
1280
|
+
export declare class AxiosGatewayServiceResourceClient extends GatewayServiceResourceClient<Axios.AxiosRequestConfig> {
|
|
1281
1281
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1282
1282
|
}
|
|
1283
|
-
export declare class
|
|
1283
|
+
export declare class AxiosAppResourceClient extends AppResourceClient<Axios.AxiosRequestConfig> {
|
|
1284
1284
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1285
1285
|
}
|
|
1286
|
-
export declare class
|
|
1286
|
+
export declare class AxiosRealmResourceClient extends RealmResourceClient<Axios.AxiosRequestConfig> {
|
|
1287
1287
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1288
1288
|
}
|
|
1289
|
-
export declare class
|
|
1289
|
+
export declare class AxiosAgentResourceClient extends AgentResourceClient<Axios.AxiosRequestConfig> {
|
|
1290
1290
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1291
1291
|
}
|
|
1292
|
-
export declare class
|
|
1292
|
+
export declare class AxiosConsoleResourceClient extends ConsoleResourceClient<Axios.AxiosRequestConfig> {
|
|
1293
1293
|
constructor(baseURL: string, axiosInstance?: Axios.AxiosInstance);
|
|
1294
1294
|
}
|
|
1295
1295
|
//# sourceMappingURL=restclient.d.ts.map
|