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