Get a feature by resource ID | Solvimon

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

{
  "reference": "feature-001",
  "object_type": "feature",
  "id": "f3a1c9d2-7b4e-4a6f-9d3e-2b8f1a7c9e5d",
  "name": "Energy Saver Mode",
  "description": "Enables energy saving by reducing power consumption during off-peak hours.",
  "type": "SWITCH",
  "enum_values": [
    "ON",
    "OFF"
  ],
  "meter_value_calculation_id": "calc-1234abcd",
  "meter_value_calculation": {
    "reference": "calc-energy-sum",
    "object_type": "calculation",
    "id": "calc-1234abcd",
    "name": "Total Energy Consumption",
    "description": "Calculates the sum of energy consumed over a period.",
    "calculation_type": "SUM",
    "persist": true,
    "meter_id": "meter-5678efgh",
    "meter": {
      "reference": "meter-energy-01",
      "object_type": "meter",
      "id": "meter-5678efgh",
      "name": "Main Energy Meter",
      "description": "Measures total energy consumption in kWh.",
      "status": "ACTIVE",
      "meter_values": [
        {
          "id": "mv-001",
          "object": {
            "reference": "energy-value-01",
            "object_type": "meter_value",
            "id": "mv-001",
            "name": "Energy Value",
            "description": "Current energy reading in kWh.",
            "status": "ACTIVE",
            "type": "NUMBER"
          },
          "required": true
        }
      ],
      "meter_properties": [
        {
          "id": "mp-001",
          "object": {
            "reference": "property-unit",
            "status": "ACTIVE",
            "object_type": "meter_property",
            "id": "mp-001",
            "name": "Unit",
            "description": "Measurement unit for the meter values.",
            "type": "NUMBER",
            "enum_values": [
              "kWh",
              "MWh"
            ]
          },
          "required": true
        }
      ]
    },
    "meter_value_id": "mv-001",
    "meter_value": {
      "reference": "energy-value-01",
      "object_type": "meter_value",
      "id": "mv-001",
      "name": "Energy Value",
      "description": "Current energy reading in kWh.",
      "status": "ACTIVE",
      "type": "NUMBER"
    },
    "meter_property_id": "mp-001",
    "meter_property": {
      "reference": "property-unit",
      "status": "ACTIVE",
      "object_type": "meter_property",
      "id": "mp-001",
      "name": "Unit",
      "description": "Measurement unit for the meter values.",
      "type": "NUMBER",
      "enum_values": [
        "kWh",
        "MWh"
      ]
    }
  }
}

Requires the FEATURE.VIEW permission.

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

typeenum or null

The indication of the type of feature associated with the pricing plan.

Allowed values:

enum_valueslist of strings or null

If the feature type is ENUM, these fields provide additional information on the values used.

meter_value_calculation_idstring or null

The linked meter value calculation

meter_value_calculationobject 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