Get cabinet consumption

GET 
/workspaces/:workspace_id/consumption/cabinets/:resource_id

This endpoint returns the consumption data for a single cabinet.

Request

Path Parameters

workspace_id stringrequired

Workspace ID

resource_id stringrequired

Asset ID

Query Parameters

start date-timerequired

Start date of the data range

end date-timerequired

End date of the data range

s string

Shift ID

Responses

200

OK response.

application/json

Schema

Schema

alarm booleanrequired

Alarm status of the cabinet

asset_type stringrequired

Type of the cabinet

carbon_footprint double

Carbon footprint of the cabinet

consumption double

Total consumption in kWh for the cabinet output lines

cost double

Total energy cost for the cabinet output lines

current_power double

Current power consumption in kW for the cabinet output lines

d_carbon_footprint double

Carbon footprint change of the cabinet

d_consumption double

Percentage change of the total consumption in kWh for the cabinet output lines in the previous period

d_cost double

Percentage change of the total energy cost for the cabinet output lines in the previous period

h_alarm

object[]

Historical alarm status of the cabinet input lines

Array [

alarm doublerequired

Value of the alarm data

ts stringrequired

Date of the data

]

h_consumption

object[]

Historical total consumption in kWh for the cabinet output lines

Array [

line_in_0 double

Value of the data for line 0

line_in_1 double

Value of the data for line 1

line_in_2 double

Value of the data for line 2

line_out_0 double

Value of the data for line 0

line_out_1 double

Value of the data for line 1

line_out_2 double

Value of the data for line 2

line_out_3 double

Value of the data for line 3

line_out_4 double

Value of the data for line 4

ts string

Date of the data

]

h_phase_unbalance

object[]

Historical phase unbalance of the cabinet input lines

Array [

ts stringrequired

Date of the data

value doublerequired

Value of the data

]

h_power

object[]

Historical max power draw in kW for the asset

Array [

line_in_0 double

Value of the data for line 0

line_in_1 double

Value of the data for line 1

line_in_2 double

Value of the data for line 2

line_out_0 double

Value of the data for line 0

line_out_1 double

Value of the data for line 1

line_out_2 double

Value of the data for line 2

line_out_3 double

Value of the data for line 3

line_out_4 double

Value of the data for line 4

ts string

Date of the data

]

h_status

object[]

Historical status of the cabinet input lines

Array [

idle doublerequired

Value of the idle data

offline doublerequired

Value of the offline data

ts stringrequired

Date of the data

working doublerequired

Value of the working data

]

id stringrequired

ID of the cabinet

input_cabinet_lines

object[]

Input cabinet lines data

Array [

alarm booleanrequired

Alarm status of the cabinet line

cabinet_line_name stringrequired

Name of the cabinet line

carbon_footprint double

Carbon footprint of the cabinet line

consumption double

Total consumption in kWh for the cabinet line

cost double

Total energy cost for the cabinet line

current_power double

Current power consumption in kW for the cabinet line

d_carbon_footprint double

Percentage change of the carbon footprint for the cabinet line in the previous period

d_consumption double

Percentage change of the total consumption for the cabinet line in the previous period

d_cost double

Percentage change of the total energy cost for the cabinet line in the previous period

d_power_avg double

Percentage change of the power consumption for the cabinet line in the previous period

d_power_max double

Percentage change of the max power consumption for the cabinet line in the previous period

d_power_min double

Percentage change of the min power consumption for the cabinet line in the previous period

index int64required

Index of the cabinet line

power_avg double

Power consumption in kW for the cabinet line

power_max double

Max power consumption in kW for the cabinet line

power_min double

Min power consumption in kW for the cabinet line

status stringrequired

Status of the cabinet line

]

last_data_ts string

Last data timestamp

name stringrequired

Name of the cabinet

output_cabinet_lines

object[]

Output cabinet lines data

Array [

alarm booleanrequired

Alarm status of the cabinet line

cabinet_line_name stringrequired

Name of the cabinet line

carbon_footprint double

Carbon footprint of the cabinet line

consumption double

Total consumption in kWh for the cabinet line

cost double

Total energy cost for the cabinet line

current_power double

Current power consumption in kW for the cabinet line

d_carbon_footprint double

Percentage change of the carbon footprint for the cabinet line in the previous period

d_consumption double

Percentage change of the total consumption for the cabinet line in the previous period

d_cost double

Percentage change of the total energy cost for the cabinet line in the previous period

d_power_avg double

Percentage change of the power consumption for the cabinet line in the previous period

d_power_max double

Percentage change of the max power consumption for the cabinet line in the previous period

d_power_min double

Percentage change of the min power consumption for the cabinet line in the previous period

index int64required

Index of the cabinet line

power_avg double

Power consumption in kW for the cabinet line

power_max double

Max power consumption in kW for the cabinet line

power_min double

Min power consumption in kW for the cabinet line

status stringrequired

Status of the cabinet line

]

phase_unbalance double

Phase unbalance of the cabinet input lines

status stringrequired

Status of the cabinet

Example (from schema)

{
  "alarm": true,
  "asset_type": "string",
  "carbon_footprint": 0,
  "consumption": 0,
  "cost": 0,
  "current_power": 0,
  "d_carbon_footprint": 0,
  "d_consumption": 0,
  "d_cost": 0,
  "h_alarm": [
    {
      "alarm": 0,
      "ts": "string"
    }
  ],
  "h_consumption": [
    {
      "line_in_0": 0,
      "line_in_1": 0,
      "line_in_2": 0,
      "line_out_0": 0,
      "line_out_1": 0,
      "line_out_2": 0,
      "line_out_3": 0,
      "line_out_4": 0,
      "ts": "string"
    }
  ],
  "h_phase_unbalance": [
    {
      "ts": "string",
      "value": 0
    }
  ],
  "h_power": [
    {
      "line_in_0": 0,
      "line_in_1": 0,
      "line_in_2": 0,
      "line_out_0": 0,
      "line_out_1": 0,
      "line_out_2": 0,
      "line_out_3": 0,
      "line_out_4": 0,
      "ts": "string"
    }
  ],
  "h_status": [
    {
      "idle": 0,
      "offline": 0,
      "ts": "string",
      "working": 0
    }
  ],
  "id": "string",
  "input_cabinet_lines": [
    {
      "alarm": true,
      "cabinet_line_name": "string",
      "carbon_footprint": 0,
      "consumption": 0,
      "cost": 0,
      "current_power": 0,
      "d_carbon_footprint": 0,
      "d_consumption": 0,
      "d_cost": 0,
      "d_power_avg": 0,
      "d_power_max": 0,
      "d_power_min": 0,
      "index": 0,
      "power_avg": 0,
      "power_max": 0,
      "power_min": 0,
      "status": "string"
    }
  ],
  "last_data_ts": "string",
  "name": "string",
  "output_cabinet_lines": [
    {
      "alarm": true,
      "cabinet_line_name": "string",
      "carbon_footprint": 0,
      "consumption": 0,
      "cost": 0,
      "current_power": 0,
      "d_carbon_footprint": 0,
      "d_consumption": 0,
      "d_cost": 0,
      "d_power_avg": 0,
      "d_power_max": 0,
      "d_power_min": 0,
      "index": 0,
      "power_avg": 0,
      "power_max": 0,
      "power_min": 0,
      "status": "string"
    }
  ],
  "phase_unbalance": 0,
  "status": "string"
}

400

bad_request: Invalid request

application/json

Schema

Schema

message stringrequired

Message of error

Example (from schema)

{
  "message": "invalid request"
}

500

internal_error: Internal server error

application/json

Schema

Schema

message stringrequired

Message of error

Example (from schema)

{
  "message": "invalid request"
}

Loading...