Objects

Get facility configuration

Changed on

Return the facility's energy reporting settings (the same shape accepted by the matching PATCH).

This property group applies to Facility objects only; requesting it for any other object class returns 400.

get/v1/objects/{object-id}/facility

Request

  • Base URL
    http://127.0.0.1:8000
  • URL
    http://127.0.0.1:8000/v1/objects/{object-id}/facility
  • Auth
    HTTP bearer

Path parameters

object-idinteger required

Response

Facility configuration.

settlementLaginteger

Number of days a provisional day waits before settlement.

providerIdstring nullable

Selected KPI computation provider. Empty or null disables the engine for this facility.

engineEnabledboolean

True when a computation provider is selected.

Changes