Update a feature | Solvimon

curl -X PATCH https://test.api.solvimon.com/v1/features/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "reference": "feature-12345"
}'

{
  "reference": "feature-12345",
  "object_type": "feature",
  "id": "f8a1c2d4-3b6e-4f9a-9c2d-7e8f9a123456",
  "name": "Main Entrance Light Switch",
  "description": "Controls the lighting for the main entrance area",
  "type": "SWITCH",
  "enum_values": [
    "ON",
    "OFF"
  ],
  "meter_value_calculation_id": "calc-98765",
  "meter_value_calculation": {
    "reference": "calc-main-entrance",
    "object_type": "calculation",
    "id": "calc-98765",
    "name": "Total Energy Consumption",
    "description": "Sum of all energy usage readings for the main entrance",
    "calculation_type": "SUM",
    "persist": true,
    "meter_id": "meter-54321",
    "meter": {
      "reference": "meter-main-entrance",
      "object_type": "meter",
      "id": "meter-54321",
      "name": "Main Entrance Energy Meter",
      "description": "Measures energy consumption at the main entrance",
      "status": "DRAFT",
      "meter_values": [
        {
          "id": "mv-001",
          "object": {
            "reference": "mv-energy-001",
            "object_type": "meter_value",
            "id": "mv-001",
            "name": "Energy Reading 1",
            "description": "First energy reading",
            "status": "DRAFT",
            "type": "NUMBER"
          },
          "required": true
        }
      ],
      "meter_properties": [
        {
          "id": "mp-001",
          "object": {
            "reference": "mp-unit",
            "status": "DRAFT",
            "object_type": "meter_property",
            "id": "mp-001",
            "name": "Unit of Measurement",
            "description": "Unit for energy readings",
            "type": "NUMBER",
            "enum_values": [
              "kWh",
              "Wh"
            ]
          },
          "required": true
        }
      ]
    },
    "meter_value_id": "mv-001",
    "meter_value": {
      "reference": "mv-energy-001",
      "object_type": "meter_value",
      "id": "mv-001",
      "name": "Energy Reading 1",
      "description": "First energy reading",
      "status": "DRAFT",
      "type": "NUMBER"
    },
    "meter_property_id": "mp-001",
    "meter_property": {
      "reference": "mp-unit",
      "status": "DRAFT",
      "object_type": "meter_property",
      "id": "mp-001",
      "name": "Unit of Measurement",
      "description": "Unit for energy readings",
      "type": "NUMBER",
      "enum_values": [
        "kWh",
        "Wh"
      ]
    }
  }
}

Requires the FEATURE.UPDATE 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.

Request

This endpoint expects an object.

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

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

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

typeenum or nullOptional

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

Allowed values:

enum_valueslist of strings or nullOptional

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

meter_value_calculation_idstring or nullOptional

The linked meter value calculation

meter_value_calculationobject or nullOptional

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

Request

Response

Errors