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