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