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