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