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