Get cabinet output line consumption

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

This endpoint returns the consumption data for a single cabinet output line.

Request

Path Parameters

workspace_id stringrequired

Workspace ID

resource_id stringrequired

Asset ID

line_index int64required

Cabinet line index

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 line

cabinet_id stringrequired

ID of the cabinet line

cabinet_line_name string

Name of the cabinet line

cabinet_name stringrequired

Name of the cabinet

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

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

h_alarm_line

object[]

Historical alarm status of the cabinet line

Array [

end string

End date of the data

start stringrequired

Start date of the data

value doublerequired

Value of the data

]

h_consumption

object[]

Historical total consumption in kWh for the cabinet line

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 [

ts stringrequired

Date of the data

value doublerequired

Value of the data

]

h_status_line

object[]

Historical status of the cabinet line

Array [

end string

End date of the data

start stringrequired

Start date of the data

value stringrequired

Value of the data

]

index int64required

Index of the cabinet line

last_data_ts string

Last data timestamp

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

state_contributions

object[]

State contributions to the line consumption

Array [

key stringrequired

Key of the data

value doublerequired

Value of the data

]

status stringrequired

Status of the cabinet line

Example (from schema)

{
  "alarm": true,
  "cabinet_id": "string",
  "cabinet_line_name": "string",
  "cabinet_name": "string",
  "carbon_footprint": 0,
  "consumption": 0,
  "cost": 0,
  "d_carbon_footprint": 0,
  "d_consumption": 0,
  "d_cost": 0,
  "d_power_avg": 0,
  "d_power_max": 0,
  "d_power_min": 0,
  "h_alarm_line": [
    {
      "end": "string",
      "start": "string",
      "value": 0
    }
  ],
  "h_consumption": [
    {
      "ts": "string",
      "value": 0
    }
  ],
  "h_power": [
    {
      "ts": "string",
      "value": 0
    }
  ],
  "h_status_line": [
    {
      "end": "string",
      "start": "string",
      "value": "string"
    }
  ],
  "index": 0,
  "last_data_ts": "string",
  "power_avg": 0,
  "power_max": 0,
  "power_min": 0,
  "state_contributions": [
    {
      "key": "string",
      "value": 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...