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