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