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