@ourskyai/node_platform-api 1.4.133 → 1.4.188
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.
- package/.openapi-generator/FILES +13 -1
- package/README.md +25 -4
- package/api.ts +1099 -50
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +635 -39
- package/dist/api.js +691 -31
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +635 -39
- package/dist/esm/api.js +690 -30
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/DefaultApi.md +506 -9
- package/docs/OpticalTrainComponentType.md +17 -0
- package/docs/SystemEventData.md +4 -0
- package/docs/V1CreateOpticalTrainRequest.md +31 -0
- package/docs/V1MotorStatus.md +2 -0
- package/docs/V1MountModel.md +2 -0
- package/docs/V1MountModelErrors.md +31 -0
- package/docs/V1MountModelPoint.md +6 -0
- package/docs/V1OpticalTrain.md +31 -0
- package/docs/V1OpticalTrainStatus.md +31 -0
- package/docs/V1OpticalTrainStatuses.md +21 -0
- package/docs/V1OpticalTrains.md +21 -0
- package/docs/V1OpticalTubeCoverSelectorRequest.md +3 -3
- package/docs/V1OpticalTubeStatus.md +1 -1
- package/docs/{V1OpticalTubeTemperatureSensorStatuses.md → V1OpticalTubeTemperatureSensorGroupStatus.md} +6 -4
- package/docs/V1OpticalTubeTemperatureSensorGroupStatuses.md +21 -0
- package/docs/V1SystemMetricsCollection.md +1 -1
- package/docs/V1TaskType.md +3 -1
- package/docs/V1UnassociatedOpticalTrainComponent.md +23 -0
- package/docs/V1UnassociatedOpticalTrainComponents.md +21 -0
- package/docs/V1UpdateOpticalTrainRequest.md +31 -0
- package/docs/V2SystemEventType.md +4 -0
- package/docs/V2SystemStatus.md +37 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/docs/DefaultApi.md
CHANGED
|
@@ -5,7 +5,7 @@ All URIs are relative to *https://api.prod.oursky.ai*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**v1AddMountModelPointHere**](#v1addmountmodelpointhere) | **POST** /node-platform/v1/mount/model/point | |
|
|
8
|
-
|[**
|
|
8
|
+
|[**v1AddMountModelPointUsingImage**](#v1addmountmodelpointusingimage) | **POST** /node-platform/v1/mount/model/add-point-using-image | |
|
|
9
9
|
|[**v1AppendMountTrackPath**](#v1appendmounttrackpath) | **PUT** /node-platform/v1/mount/track-path | |
|
|
10
10
|
|[**v1CancelAllTasks**](#v1cancelalltasks) | **POST** /node-platform/v1/tasks/cancel-all | |
|
|
11
11
|
|[**v1CancelTask**](#v1canceltask) | **DELETE** /node-platform/v1/tasks | |
|
|
@@ -14,6 +14,7 @@ All URIs are relative to *https://api.prod.oursky.ai*
|
|
|
14
14
|
|[**v1CaptureImage**](#v1captureimage) | **POST** /node-platform/v1/camera/capture-image | |
|
|
15
15
|
|[**v1CaptureImageAndPlateSolve**](#v1captureimageandplatesolve) | **POST** /node-platform/v1/camera/plate-solve | |
|
|
16
16
|
|[**v1CaptureImagesContinuously**](#v1captureimagescontinuously) | **POST** /node-platform/v1/camera/capture-images-continuously | |
|
|
17
|
+
|[**v1ClearEnclosureRotatorMotorLockout**](#v1clearenclosurerotatormotorlockout) | **POST** /node-platform/v1/enclosure/rotator/clear-motor-lockout | |
|
|
17
18
|
|[**v1ClearMountModel**](#v1clearmountmodel) | **DELETE** /node-platform/v1/mount/model | |
|
|
18
19
|
|[**v1ClearRoofError**](#v1clearrooferror) | **PUT** /node-platform/v1/roof/clear-error | |
|
|
19
20
|
|[**v1CloseEnclosureShutters**](#v1closeenclosureshutters) | **POST** /node-platform/v1/enclosure/shutters/close | |
|
|
@@ -21,9 +22,11 @@ All URIs are relative to *https://api.prod.oursky.ai*
|
|
|
21
22
|
|[**v1CloseRoof**](#v1closeroof) | **PUT** /node-platform/v1/roof/close | |
|
|
22
23
|
|[**v1CreateElevationMask**](#v1createelevationmask) | **POST** /node-platform/v1/mount/elevation-mask | |
|
|
23
24
|
|[**v1CreateMountModel**](#v1createmountmodel) | **POST** /node-platform/v1/mount/model | |
|
|
25
|
+
|[**v1CreateOpticalTrain**](#v1createopticaltrain) | **POST** /node-platform/v1/optical-trains | |
|
|
24
26
|
|[**v1CycleRelays**](#v1cyclerelays) | **POST** /node-platform/v1/relays/cycle | |
|
|
25
27
|
|[**v1DeleteImage**](#v1deleteimage) | **POST** /node-platform/v1/image/delete | |
|
|
26
28
|
|[**v1DeleteImageProcessingPlugin**](#v1deleteimageprocessingplugin) | **DELETE** /node-platform/v1/image-processing/plugin | |
|
|
29
|
+
|[**v1DeleteOpticalTrain**](#v1deleteopticaltrain) | **DELETE** /node-platform/v1/optical-train | |
|
|
27
30
|
|[**v1DeleteVideo**](#v1deletevideo) | **POST** /node-platform/v1/video/delete | |
|
|
28
31
|
|[**v1DiagnoseSystem**](#v1diagnosesystem) | **POST** /node-platform/v1/system/diagnose | |
|
|
29
32
|
|[**v1DisableDerotationCompensation**](#v1disablederotationcompensation) | **POST** /node-platform/v1/rotator/disable-derotation-compensation | |
|
|
@@ -78,6 +81,8 @@ All URIs are relative to *https://api.prod.oursky.ai*
|
|
|
78
81
|
|[**v1GetMountStatus**](#v1getmountstatus) | **GET** /node-platform/v1/mount/status | |
|
|
79
82
|
|[**v1GetMountTrackPathStatus**](#v1getmounttrackpathstatus) | **GET** /node-platform/v1/mount/track-path | |
|
|
80
83
|
|[**v1GetNetworkInterfaces**](#v1getnetworkinterfaces) | **GET** /node-platform/v1/network/interfaces | |
|
|
84
|
+
|[**v1GetOpticalTrain**](#v1getopticaltrain) | **GET** /node-platform/v1/optical-train | |
|
|
85
|
+
|[**v1GetOpticalTrains**](#v1getopticaltrains) | **GET** /node-platform/v1/optical-trains | |
|
|
81
86
|
|[**v1GetOpticalTubeCoverStatus**](#v1getopticaltubecoverstatus) | **GET** /node-platform/v1/optical-tube/cover/status | |
|
|
82
87
|
|[**v1GetOpticalTubeCoverStatuses**](#v1getopticaltubecoverstatuses) | **GET** /node-platform/v1/optical-tubes/cover/status | |
|
|
83
88
|
|[**v1GetOpticalTubeFanGroupStatus**](#v1getopticaltubefangroupstatus) | **GET** /node-platform/v1/optical-tube/fans/status | |
|
|
@@ -88,6 +93,8 @@ All URIs are relative to *https://api.prod.oursky.ai*
|
|
|
88
93
|
|[**v1GetOpticalTubeM3Statuses**](#v1getopticaltubem3statuses) | **GET** /node-platform/v1/optical-tubes/m3/status | |
|
|
89
94
|
|[**v1GetOpticalTubeStatus**](#v1getopticaltubestatus) | **GET** /node-platform/v1/optical-tube/status | |
|
|
90
95
|
|[**v1GetOpticalTubeStatuses**](#v1getopticaltubestatuses) | **GET** /node-platform/v1/optical-tubes/status | |
|
|
96
|
+
|[**v1GetOpticalTubeTemperatureSensorGroupStatus**](#v1getopticaltubetemperaturesensorgroupstatus) | **GET** /node-platform/v1/optical-tube/temperature-sensors/status | |
|
|
97
|
+
|[**v1GetOpticalTubeTemperatureSensorGroupStatuses**](#v1getopticaltubetemperaturesensorgroupstatuses) | **GET** /node-platform/v1/optical-tubes/temperature-sensors/status | |
|
|
91
98
|
|[**v1GetRelays**](#v1getrelays) | **GET** /node-platform/v1/relay | |
|
|
92
99
|
|[**v1GetRoof**](#v1getroof) | **GET** /node-platform/v1/roof | |
|
|
93
100
|
|[**v1GetRotatorStatus**](#v1getrotatorstatus) | **GET** /node-platform/v1/rotator/status | |
|
|
@@ -183,6 +190,7 @@ All URIs are relative to *https://api.prod.oursky.ai*
|
|
|
183
190
|
|[**v1UpdateElevationMask**](#v1updateelevationmask) | **PUT** /node-platform/v1/mount/elevation-mask | |
|
|
184
191
|
|[**v1UpdateFilter**](#v1updatefilter) | **POST** /node-platform/v1/filter-wheel/update-filter | |
|
|
185
192
|
|[**v1UpdateImageProcessingPlugin**](#v1updateimageprocessingplugin) | **PUT** /node-platform/v1/image-processing/plugin | |
|
|
193
|
+
|[**v1UpdateOpticalTrain**](#v1updateopticaltrain) | **POST** /node-platform/v1/optical-train | |
|
|
186
194
|
|[**v1UpdateSystemSettings**](#v1updatesystemsettings) | **POST** /node-platform/v1/system/settings | |
|
|
187
195
|
|[**v1UploadImageProcessingPlugin**](#v1uploadimageprocessingplugin) | **POST** /node-platform/v1/image-processing/plugin | |
|
|
188
196
|
|[**v2CaptureImage**](#v2captureimage) | **POST** /node-platform/v2/camera/capture-image | |
|
|
@@ -192,6 +200,7 @@ All URIs are relative to *https://api.prod.oursky.ai*
|
|
|
192
200
|
|[**v2GetMountStatus**](#v2getmountstatus) | **GET** /node-platform/v2/mount/status | |
|
|
193
201
|
|[**v2GetRelayStatuses**](#v2getrelaystatuses) | **GET** /node-platform/v2/relays/status | |
|
|
194
202
|
|[**v2GetSystemEvents**](#v2getsystemevents) | **GET** /node-platform/v2/system/events | |
|
|
203
|
+
|[**v2GetSystemStatus**](#v2getsystemstatus) | **GET** /node-platform/v2/system/status | |
|
|
195
204
|
|[**v2TurnOffRelay**](#v2turnoffrelay) | **POST** /node-platform/v2/relay/turn-off | |
|
|
196
205
|
|[**v2TurnOnRelay**](#v2turnonrelay) | **POST** /node-platform/v2/relay/turn-on | |
|
|
197
206
|
|
|
@@ -250,10 +259,10 @@ const { status, data } = await apiInstance.v1AddMountModelPointHere(
|
|
|
250
259
|
|
|
251
260
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
252
261
|
|
|
253
|
-
# **
|
|
254
|
-
> EmptySuccess
|
|
262
|
+
# **v1AddMountModelPointUsingImage**
|
|
263
|
+
> EmptySuccess v1AddMountModelPointUsingImage(body)
|
|
255
264
|
|
|
256
|
-
Adds a single manual calibration point to the pointing model. The node will attempt to plate-solve the supplied image to determine J2000 right ascension and declination and pair it with the mount
|
|
265
|
+
Adds a single manual calibration point to the pointing model. The node will attempt to plate-solve the supplied image to determine J2000 right ascension and declination and pair it with the mount mechanical position to record a new correction point. Use this to refine the model with a known sky position without running a full automated survey. Returns an empty success response when the point is added.
|
|
257
266
|
|
|
258
267
|
### Example
|
|
259
268
|
|
|
@@ -268,10 +277,16 @@ const apiInstance = new DefaultApi(configuration);
|
|
|
268
277
|
|
|
269
278
|
let body: File; //
|
|
270
279
|
let lineageId: string; //Lineage ID required when requesting data from the cloud platform (optional) (default to undefined)
|
|
280
|
+
let motorAEncoderPositionDegrees: number; //Motor A encoder position in degrees at the time the supplied image was captured. (optional) (default to undefined)
|
|
281
|
+
let motorBEncoderPositionDegrees: number; //Motor B encoder position in degrees at the time the supplied image was captured. (optional) (default to undefined)
|
|
282
|
+
let timestamp: string; //ISO 8601 timestamp when the supplied encoder positions were measured. (optional) (default to undefined)
|
|
271
283
|
|
|
272
|
-
const { status, data } = await apiInstance.
|
|
284
|
+
const { status, data } = await apiInstance.v1AddMountModelPointUsingImage(
|
|
273
285
|
body,
|
|
274
|
-
lineageId
|
|
286
|
+
lineageId,
|
|
287
|
+
motorAEncoderPositionDegrees,
|
|
288
|
+
motorBEncoderPositionDegrees,
|
|
289
|
+
timestamp
|
|
275
290
|
);
|
|
276
291
|
```
|
|
277
292
|
|
|
@@ -281,6 +296,9 @@ const { status, data } = await apiInstance.v1AddMountModelPointHereUsingImage(
|
|
|
281
296
|
|------------- | ------------- | ------------- | -------------|
|
|
282
297
|
| **body** | **File**| | |
|
|
283
298
|
| **lineageId** | [**string**] | Lineage ID required when requesting data from the cloud platform | (optional) defaults to undefined|
|
|
299
|
+
| **motorAEncoderPositionDegrees** | [**number**] | Motor A encoder position in degrees at the time the supplied image was captured. | (optional) defaults to undefined|
|
|
300
|
+
| **motorBEncoderPositionDegrees** | [**number**] | Motor B encoder position in degrees at the time the supplied image was captured. | (optional) defaults to undefined|
|
|
301
|
+
| **timestamp** | [**string**] | ISO 8601 timestamp when the supplied encoder positions were measured. | (optional) defaults to undefined|
|
|
284
302
|
|
|
285
303
|
|
|
286
304
|
### Return type
|
|
@@ -737,6 +755,57 @@ const { status, data } = await apiInstance.v1CaptureImagesContinuously(
|
|
|
737
755
|
- **Accept**: application/json
|
|
738
756
|
|
|
739
757
|
|
|
758
|
+
### HTTP response details
|
|
759
|
+
| Status code | Description | Response headers |
|
|
760
|
+
|-------------|-------------|------------------|
|
|
761
|
+
|**200** | Successful action | - |
|
|
762
|
+
|
|
763
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
764
|
+
|
|
765
|
+
# **v1ClearEnclosureRotatorMotorLockout**
|
|
766
|
+
> EmptySuccess v1ClearEnclosureRotatorMotorLockout()
|
|
767
|
+
|
|
768
|
+
Clears a latched dome rotator motor lockout condition after the underlying cause has been investigated and it is safe to permit rotator motion again. To recover from the lockout zone, the edge controller temporarily disables the limiter, moves the enclosure rotator back into the valid range, and then re-enables the limiter. This operation is a no-op when no motor lockout is active.
|
|
769
|
+
|
|
770
|
+
### Example
|
|
771
|
+
|
|
772
|
+
```typescript
|
|
773
|
+
import {
|
|
774
|
+
DefaultApi,
|
|
775
|
+
Configuration
|
|
776
|
+
} from '@ourskyai/node_platform-api';
|
|
777
|
+
|
|
778
|
+
const configuration = new Configuration();
|
|
779
|
+
const apiInstance = new DefaultApi(configuration);
|
|
780
|
+
|
|
781
|
+
let lineageId: string; //Lineage ID required when requesting data from the cloud platform (optional) (default to undefined)
|
|
782
|
+
|
|
783
|
+
const { status, data } = await apiInstance.v1ClearEnclosureRotatorMotorLockout(
|
|
784
|
+
lineageId
|
|
785
|
+
);
|
|
786
|
+
```
|
|
787
|
+
|
|
788
|
+
### Parameters
|
|
789
|
+
|
|
790
|
+
|Name | Type | Description | Notes|
|
|
791
|
+
|------------- | ------------- | ------------- | -------------|
|
|
792
|
+
| **lineageId** | [**string**] | Lineage ID required when requesting data from the cloud platform | (optional) defaults to undefined|
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
### Return type
|
|
796
|
+
|
|
797
|
+
**EmptySuccess**
|
|
798
|
+
|
|
799
|
+
### Authorization
|
|
800
|
+
|
|
801
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
802
|
+
|
|
803
|
+
### HTTP request headers
|
|
804
|
+
|
|
805
|
+
- **Content-Type**: Not defined
|
|
806
|
+
- **Accept**: application/json
|
|
807
|
+
|
|
808
|
+
|
|
740
809
|
### HTTP response details
|
|
741
810
|
| Status code | Description | Response headers |
|
|
742
811
|
|-------------|-------------|------------------|
|
|
@@ -1109,6 +1178,61 @@ const { status, data } = await apiInstance.v1CreateMountModel(
|
|
|
1109
1178
|
|
|
1110
1179
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1111
1180
|
|
|
1181
|
+
# **v1CreateOpticalTrain**
|
|
1182
|
+
> V1OpticalTrain v1CreateOpticalTrain(v1CreateOpticalTrainRequest)
|
|
1183
|
+
|
|
1184
|
+
Creates an optical train configuration by assigning optical train components to a human-readable label.
|
|
1185
|
+
|
|
1186
|
+
### Example
|
|
1187
|
+
|
|
1188
|
+
```typescript
|
|
1189
|
+
import {
|
|
1190
|
+
DefaultApi,
|
|
1191
|
+
Configuration,
|
|
1192
|
+
V1CreateOpticalTrainRequest
|
|
1193
|
+
} from '@ourskyai/node_platform-api';
|
|
1194
|
+
|
|
1195
|
+
const configuration = new Configuration();
|
|
1196
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1197
|
+
|
|
1198
|
+
let v1CreateOpticalTrainRequest: V1CreateOpticalTrainRequest; //
|
|
1199
|
+
let lineageId: string; //Lineage ID required when requesting data from the cloud platform (optional) (default to undefined)
|
|
1200
|
+
|
|
1201
|
+
const { status, data } = await apiInstance.v1CreateOpticalTrain(
|
|
1202
|
+
v1CreateOpticalTrainRequest,
|
|
1203
|
+
lineageId
|
|
1204
|
+
);
|
|
1205
|
+
```
|
|
1206
|
+
|
|
1207
|
+
### Parameters
|
|
1208
|
+
|
|
1209
|
+
|Name | Type | Description | Notes|
|
|
1210
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1211
|
+
| **v1CreateOpticalTrainRequest** | **V1CreateOpticalTrainRequest**| | |
|
|
1212
|
+
| **lineageId** | [**string**] | Lineage ID required when requesting data from the cloud platform | (optional) defaults to undefined|
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
### Return type
|
|
1216
|
+
|
|
1217
|
+
**V1OpticalTrain**
|
|
1218
|
+
|
|
1219
|
+
### Authorization
|
|
1220
|
+
|
|
1221
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1222
|
+
|
|
1223
|
+
### HTTP request headers
|
|
1224
|
+
|
|
1225
|
+
- **Content-Type**: application/json
|
|
1226
|
+
- **Accept**: application/json
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
### HTTP response details
|
|
1230
|
+
| Status code | Description | Response headers |
|
|
1231
|
+
|-------------|-------------|------------------|
|
|
1232
|
+
|**200** | V1OpticalTrain | - |
|
|
1233
|
+
|
|
1234
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1235
|
+
|
|
1112
1236
|
# **v1CycleRelays**
|
|
1113
1237
|
> EmptySuccess v1CycleRelays(v1CycleRelaysRequest)
|
|
1114
1238
|
|
|
@@ -1267,6 +1391,60 @@ const { status, data } = await apiInstance.v1DeleteImageProcessingPlugin(
|
|
|
1267
1391
|
- **Accept**: application/json
|
|
1268
1392
|
|
|
1269
1393
|
|
|
1394
|
+
### HTTP response details
|
|
1395
|
+
| Status code | Description | Response headers |
|
|
1396
|
+
|-------------|-------------|------------------|
|
|
1397
|
+
|**200** | Successful action | - |
|
|
1398
|
+
|
|
1399
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
1400
|
+
|
|
1401
|
+
# **v1DeleteOpticalTrain**
|
|
1402
|
+
> EmptySuccess v1DeleteOpticalTrain()
|
|
1403
|
+
|
|
1404
|
+
Deletes one optical train configuration by label.
|
|
1405
|
+
|
|
1406
|
+
### Example
|
|
1407
|
+
|
|
1408
|
+
```typescript
|
|
1409
|
+
import {
|
|
1410
|
+
DefaultApi,
|
|
1411
|
+
Configuration
|
|
1412
|
+
} from '@ourskyai/node_platform-api';
|
|
1413
|
+
|
|
1414
|
+
const configuration = new Configuration();
|
|
1415
|
+
const apiInstance = new DefaultApi(configuration);
|
|
1416
|
+
|
|
1417
|
+
let label: string; //Human-readable label of the optical train to delete. (default to undefined)
|
|
1418
|
+
let lineageId: string; //Lineage ID required when requesting data from the cloud platform (optional) (default to undefined)
|
|
1419
|
+
|
|
1420
|
+
const { status, data } = await apiInstance.v1DeleteOpticalTrain(
|
|
1421
|
+
label,
|
|
1422
|
+
lineageId
|
|
1423
|
+
);
|
|
1424
|
+
```
|
|
1425
|
+
|
|
1426
|
+
### Parameters
|
|
1427
|
+
|
|
1428
|
+
|Name | Type | Description | Notes|
|
|
1429
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1430
|
+
| **label** | [**string**] | Human-readable label of the optical train to delete. | defaults to undefined|
|
|
1431
|
+
| **lineageId** | [**string**] | Lineage ID required when requesting data from the cloud platform | (optional) defaults to undefined|
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
### Return type
|
|
1435
|
+
|
|
1436
|
+
**EmptySuccess**
|
|
1437
|
+
|
|
1438
|
+
### Authorization
|
|
1439
|
+
|
|
1440
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
1441
|
+
|
|
1442
|
+
### HTTP request headers
|
|
1443
|
+
|
|
1444
|
+
- **Content-Type**: Not defined
|
|
1445
|
+
- **Accept**: application/json
|
|
1446
|
+
|
|
1447
|
+
|
|
1270
1448
|
### HTTP response details
|
|
1271
1449
|
| Status code | Description | Response headers |
|
|
1272
1450
|
|-------------|-------------|------------------|
|
|
@@ -2182,9 +2360,11 @@ const configuration = new Configuration();
|
|
|
2182
2360
|
const apiInstance = new DefaultApi(configuration);
|
|
2183
2361
|
|
|
2184
2362
|
let lineageId: string; //Lineage ID required when requesting data from the cloud platform (optional) (default to undefined)
|
|
2363
|
+
let id: string; //Optional focuser ID. If provided, finds limits for that focuser instead of the default focuser. (optional) (default to undefined)
|
|
2185
2364
|
|
|
2186
2365
|
const { status, data } = await apiInstance.v1FindFocuserLimits(
|
|
2187
|
-
lineageId
|
|
2366
|
+
lineageId,
|
|
2367
|
+
id
|
|
2188
2368
|
);
|
|
2189
2369
|
```
|
|
2190
2370
|
|
|
@@ -2193,6 +2373,7 @@ const { status, data } = await apiInstance.v1FindFocuserLimits(
|
|
|
2193
2373
|
|Name | Type | Description | Notes|
|
|
2194
2374
|
|------------- | ------------- | ------------- | -------------|
|
|
2195
2375
|
| **lineageId** | [**string**] | Lineage ID required when requesting data from the cloud platform | (optional) defaults to undefined|
|
|
2376
|
+
| **id** | [**string**] | Optional focuser ID. If provided, finds limits for that focuser instead of the default focuser. | (optional) defaults to undefined|
|
|
2196
2377
|
|
|
2197
2378
|
|
|
2198
2379
|
### Return type
|
|
@@ -4126,6 +4307,111 @@ const { status, data } = await apiInstance.v1GetNetworkInterfaces(
|
|
|
4126
4307
|
|
|
4127
4308
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
4128
4309
|
|
|
4310
|
+
# **v1GetOpticalTrain**
|
|
4311
|
+
> V1OpticalTrain v1GetOpticalTrain()
|
|
4312
|
+
|
|
4313
|
+
Retrieves one optical train configuration by label.
|
|
4314
|
+
|
|
4315
|
+
### Example
|
|
4316
|
+
|
|
4317
|
+
```typescript
|
|
4318
|
+
import {
|
|
4319
|
+
DefaultApi,
|
|
4320
|
+
Configuration
|
|
4321
|
+
} from '@ourskyai/node_platform-api';
|
|
4322
|
+
|
|
4323
|
+
const configuration = new Configuration();
|
|
4324
|
+
const apiInstance = new DefaultApi(configuration);
|
|
4325
|
+
|
|
4326
|
+
let label: string; //Human-readable label of the optical train to retrieve. (default to undefined)
|
|
4327
|
+
let lineageId: string; //Lineage ID required when requesting data from the cloud platform (optional) (default to undefined)
|
|
4328
|
+
|
|
4329
|
+
const { status, data } = await apiInstance.v1GetOpticalTrain(
|
|
4330
|
+
label,
|
|
4331
|
+
lineageId
|
|
4332
|
+
);
|
|
4333
|
+
```
|
|
4334
|
+
|
|
4335
|
+
### Parameters
|
|
4336
|
+
|
|
4337
|
+
|Name | Type | Description | Notes|
|
|
4338
|
+
|------------- | ------------- | ------------- | -------------|
|
|
4339
|
+
| **label** | [**string**] | Human-readable label of the optical train to retrieve. | defaults to undefined|
|
|
4340
|
+
| **lineageId** | [**string**] | Lineage ID required when requesting data from the cloud platform | (optional) defaults to undefined|
|
|
4341
|
+
|
|
4342
|
+
|
|
4343
|
+
### Return type
|
|
4344
|
+
|
|
4345
|
+
**V1OpticalTrain**
|
|
4346
|
+
|
|
4347
|
+
### Authorization
|
|
4348
|
+
|
|
4349
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
4350
|
+
|
|
4351
|
+
### HTTP request headers
|
|
4352
|
+
|
|
4353
|
+
- **Content-Type**: Not defined
|
|
4354
|
+
- **Accept**: application/json
|
|
4355
|
+
|
|
4356
|
+
|
|
4357
|
+
### HTTP response details
|
|
4358
|
+
| Status code | Description | Response headers |
|
|
4359
|
+
|-------------|-------------|------------------|
|
|
4360
|
+
|**200** | V1OpticalTrain | - |
|
|
4361
|
+
|
|
4362
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
4363
|
+
|
|
4364
|
+
# **v1GetOpticalTrains**
|
|
4365
|
+
> V1OpticalTrains v1GetOpticalTrains()
|
|
4366
|
+
|
|
4367
|
+
Retrieves all configured optical trains and the optical train components assigned to each train.
|
|
4368
|
+
|
|
4369
|
+
### Example
|
|
4370
|
+
|
|
4371
|
+
```typescript
|
|
4372
|
+
import {
|
|
4373
|
+
DefaultApi,
|
|
4374
|
+
Configuration
|
|
4375
|
+
} from '@ourskyai/node_platform-api';
|
|
4376
|
+
|
|
4377
|
+
const configuration = new Configuration();
|
|
4378
|
+
const apiInstance = new DefaultApi(configuration);
|
|
4379
|
+
|
|
4380
|
+
let lineageId: string; //Lineage ID required when requesting data from the cloud platform (optional) (default to undefined)
|
|
4381
|
+
|
|
4382
|
+
const { status, data } = await apiInstance.v1GetOpticalTrains(
|
|
4383
|
+
lineageId
|
|
4384
|
+
);
|
|
4385
|
+
```
|
|
4386
|
+
|
|
4387
|
+
### Parameters
|
|
4388
|
+
|
|
4389
|
+
|Name | Type | Description | Notes|
|
|
4390
|
+
|------------- | ------------- | ------------- | -------------|
|
|
4391
|
+
| **lineageId** | [**string**] | Lineage ID required when requesting data from the cloud platform | (optional) defaults to undefined|
|
|
4392
|
+
|
|
4393
|
+
|
|
4394
|
+
### Return type
|
|
4395
|
+
|
|
4396
|
+
**V1OpticalTrains**
|
|
4397
|
+
|
|
4398
|
+
### Authorization
|
|
4399
|
+
|
|
4400
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
4401
|
+
|
|
4402
|
+
### HTTP request headers
|
|
4403
|
+
|
|
4404
|
+
- **Content-Type**: Not defined
|
|
4405
|
+
- **Accept**: application/json
|
|
4406
|
+
|
|
4407
|
+
|
|
4408
|
+
### HTTP response details
|
|
4409
|
+
| Status code | Description | Response headers |
|
|
4410
|
+
|-------------|-------------|------------------|
|
|
4411
|
+
|**200** | V1OpticalTrains | - |
|
|
4412
|
+
|
|
4413
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
4414
|
+
|
|
4129
4415
|
# **v1GetOpticalTubeCoverStatus**
|
|
4130
4416
|
> V1OpticalTubeCoverStatus v1GetOpticalTubeCoverStatus()
|
|
4131
4417
|
|
|
@@ -4651,6 +4937,111 @@ const { status, data } = await apiInstance.v1GetOpticalTubeStatuses(
|
|
|
4651
4937
|
|
|
4652
4938
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
4653
4939
|
|
|
4940
|
+
# **v1GetOpticalTubeTemperatureSensorGroupStatus**
|
|
4941
|
+
> V1OpticalTubeTemperatureSensorGroupStatus v1GetOpticalTubeTemperatureSensorGroupStatus()
|
|
4942
|
+
|
|
4943
|
+
Retrieves the current temperature sensor status for an optical tube assembly. Returns V1OpticalTubeTemperatureSensorGroupStatus containing the temperature reading from each sensor.
|
|
4944
|
+
|
|
4945
|
+
### Example
|
|
4946
|
+
|
|
4947
|
+
```typescript
|
|
4948
|
+
import {
|
|
4949
|
+
DefaultApi,
|
|
4950
|
+
Configuration
|
|
4951
|
+
} from '@ourskyai/node_platform-api';
|
|
4952
|
+
|
|
4953
|
+
const configuration = new Configuration();
|
|
4954
|
+
const apiInstance = new DefaultApi(configuration);
|
|
4955
|
+
|
|
4956
|
+
let lineageId: string; //Lineage ID required when requesting data from the cloud platform (optional) (default to undefined)
|
|
4957
|
+
let id: string; //Optional optical tube ID. If provided, returns temperature sensor statuses for that optical tube instead of the default optical tube. (optional) (default to undefined)
|
|
4958
|
+
|
|
4959
|
+
const { status, data } = await apiInstance.v1GetOpticalTubeTemperatureSensorGroupStatus(
|
|
4960
|
+
lineageId,
|
|
4961
|
+
id
|
|
4962
|
+
);
|
|
4963
|
+
```
|
|
4964
|
+
|
|
4965
|
+
### Parameters
|
|
4966
|
+
|
|
4967
|
+
|Name | Type | Description | Notes|
|
|
4968
|
+
|------------- | ------------- | ------------- | -------------|
|
|
4969
|
+
| **lineageId** | [**string**] | Lineage ID required when requesting data from the cloud platform | (optional) defaults to undefined|
|
|
4970
|
+
| **id** | [**string**] | Optional optical tube ID. If provided, returns temperature sensor statuses for that optical tube instead of the default optical tube. | (optional) defaults to undefined|
|
|
4971
|
+
|
|
4972
|
+
|
|
4973
|
+
### Return type
|
|
4974
|
+
|
|
4975
|
+
**V1OpticalTubeTemperatureSensorGroupStatus**
|
|
4976
|
+
|
|
4977
|
+
### Authorization
|
|
4978
|
+
|
|
4979
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
4980
|
+
|
|
4981
|
+
### HTTP request headers
|
|
4982
|
+
|
|
4983
|
+
- **Content-Type**: Not defined
|
|
4984
|
+
- **Accept**: application/json
|
|
4985
|
+
|
|
4986
|
+
|
|
4987
|
+
### HTTP response details
|
|
4988
|
+
| Status code | Description | Response headers |
|
|
4989
|
+
|-------------|-------------|------------------|
|
|
4990
|
+
|**200** | V1OpticalTubeTemperatureSensorGroupStatus | - |
|
|
4991
|
+
|
|
4992
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
4993
|
+
|
|
4994
|
+
# **v1GetOpticalTubeTemperatureSensorGroupStatuses**
|
|
4995
|
+
> V1OpticalTubeTemperatureSensorGroupStatuses v1GetOpticalTubeTemperatureSensorGroupStatuses()
|
|
4996
|
+
|
|
4997
|
+
Retrieves the current temperature sensor statuses grouped by optical tube. Use this endpoint to discover optical tube IDs and temperature readings before addressing a specific optical tube.
|
|
4998
|
+
|
|
4999
|
+
### Example
|
|
5000
|
+
|
|
5001
|
+
```typescript
|
|
5002
|
+
import {
|
|
5003
|
+
DefaultApi,
|
|
5004
|
+
Configuration
|
|
5005
|
+
} from '@ourskyai/node_platform-api';
|
|
5006
|
+
|
|
5007
|
+
const configuration = new Configuration();
|
|
5008
|
+
const apiInstance = new DefaultApi(configuration);
|
|
5009
|
+
|
|
5010
|
+
let lineageId: string; //Lineage ID required when requesting data from the cloud platform (optional) (default to undefined)
|
|
5011
|
+
|
|
5012
|
+
const { status, data } = await apiInstance.v1GetOpticalTubeTemperatureSensorGroupStatuses(
|
|
5013
|
+
lineageId
|
|
5014
|
+
);
|
|
5015
|
+
```
|
|
5016
|
+
|
|
5017
|
+
### Parameters
|
|
5018
|
+
|
|
5019
|
+
|Name | Type | Description | Notes|
|
|
5020
|
+
|------------- | ------------- | ------------- | -------------|
|
|
5021
|
+
| **lineageId** | [**string**] | Lineage ID required when requesting data from the cloud platform | (optional) defaults to undefined|
|
|
5022
|
+
|
|
5023
|
+
|
|
5024
|
+
### Return type
|
|
5025
|
+
|
|
5026
|
+
**V1OpticalTubeTemperatureSensorGroupStatuses**
|
|
5027
|
+
|
|
5028
|
+
### Authorization
|
|
5029
|
+
|
|
5030
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
5031
|
+
|
|
5032
|
+
### HTTP request headers
|
|
5033
|
+
|
|
5034
|
+
- **Content-Type**: Not defined
|
|
5035
|
+
- **Accept**: application/json
|
|
5036
|
+
|
|
5037
|
+
|
|
5038
|
+
### HTTP response details
|
|
5039
|
+
| Status code | Description | Response headers |
|
|
5040
|
+
|-------------|-------------|------------------|
|
|
5041
|
+
|**200** | V1OpticalTubeTemperatureSensorGroupStatuses | - |
|
|
5042
|
+
|
|
5043
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
5044
|
+
|
|
4654
5045
|
# **v1GetRelays**
|
|
4655
5046
|
> Array<V1Relay> v1GetRelays()
|
|
4656
5047
|
|
|
@@ -5287,7 +5678,7 @@ const { status, data } = await apiInstance.v1GetSystemMetricNames(
|
|
|
5287
5678
|
# **v1GetSystemMetrics**
|
|
5288
5679
|
> V1SystemMetrics v1GetSystemMetrics()
|
|
5289
5680
|
|
|
5290
|
-
Retrieves time-series metrics data from the telescope system for performance monitoring and analysis. This endpoint returns telemetry data such as temperatures, positions, and operational statistics over a specified time range. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is
|
|
5681
|
+
Retrieves time-series metrics data from the telescope system for performance monitoring and analysis. This endpoint returns telemetry data such as temperatures, positions, and operational statistics over a specified time range. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is dynamically calculated based on the requested time window and the number of metrics queried to ensure system stability and optimal network performance. Wider time windows or queries with many metrics will automatically apply a coarser roll-up resolution. **Default time window behavior:** - If neither `after` nor `before` is specified, the time window defaults to the last **24 hours**. - If only one bound is provided, the other bound is inferred to create a 24-hour window.
|
|
5291
5682
|
|
|
5292
5683
|
### Example
|
|
5293
5684
|
|
|
@@ -5347,7 +5738,7 @@ const { status, data } = await apiInstance.v1GetSystemMetrics(
|
|
|
5347
5738
|
# **v1GetSystemMetricsCollections**
|
|
5348
5739
|
> V1SystemMetricsCollections v1GetSystemMetricsCollections()
|
|
5349
5740
|
|
|
5350
|
-
Retrieves time-series metrics data from the telescope system for performance monitoring and analysis, grouped into compact metric collections to reduce response size over the wire. This endpoint returns the same metric data as `/node-platform/v1/system/metrics`, but each collection contains shared metric identity fields once (`name`, `type`, and `tags`) and stores measurements as compact `[measuredAt, value]` arrays. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is
|
|
5741
|
+
Retrieves time-series metrics data from the telescope system for performance monitoring and analysis, grouped into compact metric collections to reduce response size over the wire. This endpoint returns the same metric data as `/node-platform/v1/system/metrics`, but each collection contains shared metric identity fields once (`name`, `type`, and `tags`) and stores measurements as compact `[measuredAt, value]` arrays. **Metric selection:** - If `metricName` is omitted, all available metrics in the time window are returned. - If `metricName` is provided, only the specified metric is returned. **Automatic metric roll-ups:** To ensure efficient queries and bounded response sizes, metric data is automatically aggregated (\"rolled up\") based on the **requested time window length** (`before - after`). Roll-ups are applied uniformly across the entire response. Measurements are grouped into fixed UTC time buckets and aggregated using the **mean (average)** value per bucket. Returned timestamps represent the **start of each roll-up interval**, truncated to the bucket boundary in UTC. The roll-up interval is dynamically calculated based on the requested time window and the number of metrics queried to ensure system stability and optimal network performance. Wider time windows or queries with many metrics will automatically apply a coarser roll-up resolution. **Default time window behavior:** - If neither `after` nor `before` is specified, the time window defaults to the last **24 hours**. - If only one bound is provided, the other bound is inferred to create a 24-hour window.
|
|
5351
5742
|
|
|
5352
5743
|
### Example
|
|
5353
5744
|
|
|
@@ -9748,6 +10139,61 @@ const { status, data } = await apiInstance.v1UpdateImageProcessingPlugin(
|
|
|
9748
10139
|
|
|
9749
10140
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
9750
10141
|
|
|
10142
|
+
# **v1UpdateOpticalTrain**
|
|
10143
|
+
> V1OpticalTrain v1UpdateOpticalTrain(v1UpdateOpticalTrainRequest)
|
|
10144
|
+
|
|
10145
|
+
Updates an optical train configuration by replacing the component assignments for the provided label.
|
|
10146
|
+
|
|
10147
|
+
### Example
|
|
10148
|
+
|
|
10149
|
+
```typescript
|
|
10150
|
+
import {
|
|
10151
|
+
DefaultApi,
|
|
10152
|
+
Configuration,
|
|
10153
|
+
V1UpdateOpticalTrainRequest
|
|
10154
|
+
} from '@ourskyai/node_platform-api';
|
|
10155
|
+
|
|
10156
|
+
const configuration = new Configuration();
|
|
10157
|
+
const apiInstance = new DefaultApi(configuration);
|
|
10158
|
+
|
|
10159
|
+
let v1UpdateOpticalTrainRequest: V1UpdateOpticalTrainRequest; //
|
|
10160
|
+
let lineageId: string; //Lineage ID required when requesting data from the cloud platform (optional) (default to undefined)
|
|
10161
|
+
|
|
10162
|
+
const { status, data } = await apiInstance.v1UpdateOpticalTrain(
|
|
10163
|
+
v1UpdateOpticalTrainRequest,
|
|
10164
|
+
lineageId
|
|
10165
|
+
);
|
|
10166
|
+
```
|
|
10167
|
+
|
|
10168
|
+
### Parameters
|
|
10169
|
+
|
|
10170
|
+
|Name | Type | Description | Notes|
|
|
10171
|
+
|------------- | ------------- | ------------- | -------------|
|
|
10172
|
+
| **v1UpdateOpticalTrainRequest** | **V1UpdateOpticalTrainRequest**| | |
|
|
10173
|
+
| **lineageId** | [**string**] | Lineage ID required when requesting data from the cloud platform | (optional) defaults to undefined|
|
|
10174
|
+
|
|
10175
|
+
|
|
10176
|
+
### Return type
|
|
10177
|
+
|
|
10178
|
+
**V1OpticalTrain**
|
|
10179
|
+
|
|
10180
|
+
### Authorization
|
|
10181
|
+
|
|
10182
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
10183
|
+
|
|
10184
|
+
### HTTP request headers
|
|
10185
|
+
|
|
10186
|
+
- **Content-Type**: application/json
|
|
10187
|
+
- **Accept**: application/json
|
|
10188
|
+
|
|
10189
|
+
|
|
10190
|
+
### HTTP response details
|
|
10191
|
+
| Status code | Description | Response headers |
|
|
10192
|
+
|-------------|-------------|------------------|
|
|
10193
|
+
|**200** | V1OpticalTrain | - |
|
|
10194
|
+
|
|
10195
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
10196
|
+
|
|
9751
10197
|
# **v1UpdateSystemSettings**
|
|
9752
10198
|
> EmptySuccess v1UpdateSystemSettings(v1SystemSettings)
|
|
9753
10199
|
|
|
@@ -10244,6 +10690,57 @@ const { status, data } = await apiInstance.v2GetSystemEvents(
|
|
|
10244
10690
|
|
|
10245
10691
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
10246
10692
|
|
|
10693
|
+
# **v2GetSystemStatus**
|
|
10694
|
+
> V2SystemStatus v2GetSystemStatus()
|
|
10695
|
+
|
|
10696
|
+
Retrieves the comprehensive status of all connected hardware components in the telescope system, grouped by optical train and including optical train components that are not currently associated with an optical train.
|
|
10697
|
+
|
|
10698
|
+
### Example
|
|
10699
|
+
|
|
10700
|
+
```typescript
|
|
10701
|
+
import {
|
|
10702
|
+
DefaultApi,
|
|
10703
|
+
Configuration
|
|
10704
|
+
} from '@ourskyai/node_platform-api';
|
|
10705
|
+
|
|
10706
|
+
const configuration = new Configuration();
|
|
10707
|
+
const apiInstance = new DefaultApi(configuration);
|
|
10708
|
+
|
|
10709
|
+
let lineageId: string; //Lineage ID required when requesting data from the cloud platform (optional) (default to undefined)
|
|
10710
|
+
|
|
10711
|
+
const { status, data } = await apiInstance.v2GetSystemStatus(
|
|
10712
|
+
lineageId
|
|
10713
|
+
);
|
|
10714
|
+
```
|
|
10715
|
+
|
|
10716
|
+
### Parameters
|
|
10717
|
+
|
|
10718
|
+
|Name | Type | Description | Notes|
|
|
10719
|
+
|------------- | ------------- | ------------- | -------------|
|
|
10720
|
+
| **lineageId** | [**string**] | Lineage ID required when requesting data from the cloud platform | (optional) defaults to undefined|
|
|
10721
|
+
|
|
10722
|
+
|
|
10723
|
+
### Return type
|
|
10724
|
+
|
|
10725
|
+
**V2SystemStatus**
|
|
10726
|
+
|
|
10727
|
+
### Authorization
|
|
10728
|
+
|
|
10729
|
+
[Roles](../README.md#Roles), [BearerToken](../README.md#BearerToken)
|
|
10730
|
+
|
|
10731
|
+
### HTTP request headers
|
|
10732
|
+
|
|
10733
|
+
- **Content-Type**: Not defined
|
|
10734
|
+
- **Accept**: application/json
|
|
10735
|
+
|
|
10736
|
+
|
|
10737
|
+
### HTTP response details
|
|
10738
|
+
| Status code | Description | Response headers |
|
|
10739
|
+
|-------------|-------------|------------------|
|
|
10740
|
+
|**200** | Returns the aggregated status of all hardware components in the system. | - |
|
|
10741
|
+
|
|
10742
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
10743
|
+
|
|
10247
10744
|
# **v2TurnOffRelay**
|
|
10248
10745
|
> EmptySuccess v2TurnOffRelay(v2TurnOffRelayRequest)
|
|
10249
10746
|
|