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