v1

latestOpenAPI 3.0.02026-07-14643983.3 KB
FolderSettings

Gets the settings of a folder or meter

get/api/folder/settings/{id}

Path parameters

idstring required

Response

OK

Descriptionstring

The Description of the folder or meter

Enableboolean

Flag if the meter is enabled (folder not supported yet)

FolderType'Folder' | 'Location' | 'Factory' | 'House' | 'Office' | 'Machine' | 'VirtualMeter' | 'ElecticityFolder' | 'WaterFolder' | 'HeatFolder' | 'GasFolder' | 'TemperatureFolder' | 'Sun' | 'Light' | 'Ice' | 'Sofa' | 'Food' | 'Coffee' | 'Car' | 'ChargingStation' | 'Meter' | 'User' | 'Trash' | 'GridPhotovoltaicPowerSystem'

The Type of the folder

Namestring

The Name of the folder or meter

ParentFolderIdstring

The parent folder ID of this item

SerialNumberinteger

The serial number (meter only)

UseableForVirtualBillingMetersboolean

Flag if the meter is usable for virtual billing meters (e.g. washroom)

ValueCorrectionnumber double

The value correction on this meter

ValueCorrectionParentFoldernumber double

The value correction on all parent folders. but not on the meter itself

VisualizationNamestring

The name of the visualization of the folder