Get workspace status and alarms
GET/workspaces/:workspace_id/status-and-alarms
This endpoint returns the status and alarms data for the workspace.
Request
Path Parameters
Workspace ID
Query Parameters
Start date of the data range
End date of the data range
Responses
- 200
- 400
- 500
OK response.
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
machines
object[]
required
Industrial machines of the workspace
Alarm status of the machine
ID of the machine
Type of the machine
Carbon footprint of the machine
Carbon footprint change of the machine
Total alarm time change of the machine in seconds
Total energy cost change of the machine
Total idle time change of the machine in seconds
Total offline time change of the machine in seconds
Total power consumption change of the machine in kWh
Total working time change of the machine in seconds
Utilization rate change of the machine
h_alarm
object[]
required
Historical alarm status of the machine
Value of the alarm data
Date of the data
h_status
object[]
required
Historical status of the machine
Value of the idle data
Value of the offline data
Date of the data
Value of the working data
Name of the machine
Status of the machine
Total alarm time of the machine in seconds
Total energy cost of the machine
Total idle time of the machine in seconds
Total offline time of the machine in seconds
Total power consumption of the machine in kWh
Total working time of the machine in seconds
Utilization rate of the machine
{
"machines": [
{
"alarm": true,
"asset_id": "string",
"asset_type": "string",
"carbon_footprint": 0,
"d_carbon_footprint": 0,
"d_total_alarm_time": 0,
"d_total_energy_cost": 0,
"d_total_idle_time": 0,
"d_total_offline_time": 0,
"d_total_power_consumption": 0,
"d_total_working_time": 0,
"d_utilization_rate": 0,
"h_alarm": [
{
"alarm": 0,
"ts": "string"
}
],
"h_status": [
{
"idle": 0,
"offline": 0,
"ts": "string",
"working": 0
}
],
"name": "string",
"status": "string",
"total_alarm_time": 0,
"total_energy_cost": 0,
"total_idle_time": 0,
"total_offline_time": 0,
"total_power_consumption": 0,
"total_working_time": 0,
"utilization_rate": 0
}
]
}
bad_request: Invalid request
- application/json
- Schema
- Example (from schema)
Schema
Message of error
{
"message": "invalid request"
}
internal_error: Internal server error
- application/json
- Schema
- Example (from schema)
Schema
Message of error
{
"message": "invalid request"
}