Get a meter value calculation by resource ID | Solvimon

curl https://test.api.solvimon.com/v1/meter-value-calculations/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json"

{
  "reference": "calc-20240601",
  "object_type": "meter_value_calculation",
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
  "name": "Total Energy Consumption",
  "description": "Calculation summing all energy meter values for the current month",
  "calculation_type": "SUM",
  "persist": true,
  "meter_id": "meter-1234abcd",
  "meter": {
    "reference": "energy-meter-01",
    "object_type": "meter",
    "id": "meter-1234abcd",
    "name": "Main Building Energy Meter",
    "description": "Measures total electricity consumption in kWh",
    "status": "ACTIVE",
    "meter_values": [
      {
        "id": "mv-5678efgh",
        "object": {
          "reference": "energy-usage-01",
          "object_type": "meter_value",
          "id": "mv-5678efgh",
          "name": "Energy Usage",
          "description": "Hourly energy consumption reading",
          "status": "ACTIVE",
          "type": "NUMBER"
        },
        "required": true
      }
    ],
    "meter_properties": [
      {
        "id": "mp-9012ijkl",
        "object": {
          "reference": "unit-type",
          "status": "ACTIVE",
          "object_type": "meter_property",
          "id": "mp-9012ijkl",
          "name": "Unit Type",
          "description": "Measurement unit for the meter values",
          "type": "NUMBER",
          "enum_values": [
            "kWh",
            "MWh"
          ]
        },
        "required": true
      }
    ]
  },
  "meter_value_id": "mv-5678efgh",
  "meter_value": {
    "reference": "energy-usage-01",
    "object_type": "meter_value",
    "id": "mv-5678efgh",
    "name": "Energy Usage",
    "description": "Hourly energy consumption reading",
    "status": "ACTIVE",
    "type": "NUMBER"
  },
  "meter_property_id": "mp-9012ijkl",
  "meter_property": {
    "reference": "unit-type",
    "status": "ACTIVE",
    "object_type": "meter_property",
    "id": "mp-9012ijkl",
    "name": "Unit Type",
    "description": "Measurement unit for the meter values",
    "type": "NUMBER",
    "enum_values": [
      "kWh",
      "MWh"
    ]
  }
}

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Query parameters

expand[]list of stringsOptional

The id fields of the resources that are going to be expanded.

Response

referencestringformat: "^\S+$"0-256 characters

object_typestring or nullRead-only

idstring or nullRead-only

namestring or nullformat: "^.*$"0-256 characters

descriptionstring or nullformat: "^.*$"0-256 characters

calculation_typeenum or null

The type of calculation used for this billable metric.

Allowed values:

persistboolean or null

Indicate if the data of the billable metric must be persisted to the next billing period of the schedule (default is false).

meter_idstring or null

The ID of the meter.

meterobject or null

meter_value_idstring or null

The ID of the meter value.

meter_valueobject or null

meter_property_idstring or null

The ID of the meter property.

meter_propertyobject or null

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors