Sign in

v1

latestOpenAPI 3.0.02026-07-14643983.3 KB
FolderSettings

Add or edit a folder or a meter. To add a new folder use and empty ID

post/api/folder/settings/{id}

Path parameters

idstring required

The ID of the folder or meter to edit. Use and empty ID to add a new folder

Request body

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

Response

OK

Descriptionstring

The Description of the folder

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 folder type of the item

Iconstring

The path to the Icon of this folder

Idstring

The id of the folder menu item

MeterSerialNumberstring

The serial number if the folder menu item is a meter. Serial number is handled as a string, as javascript on client side cannot handle long integers properly.

Namestring

The Name of the item

UserIdstring

The ID of the user of this folder (only for foldertype user)