system.mes.meter.deleteMeterConfiguration
Description
By ID:
Deletes a Meter Configuration record by its ID.
By Equipment and Name:
Deletes a Meter Configuration record by the equipment ID and the configuration name.
Permissions
This method requires the METERING.WRITE.DELETE permission.
Syntax
system.mes.meter.deleteMeterConfiguration(id)
system.mes.meter.deleteMeterConfiguration(equipmentId, name)
Parameters
By ID:
| Parameter | Type | Nullable | Description |
|---|---|---|---|
id | String (ULID) | False | The ID of the Meter Configuration to delete. |
By Equipment and Name:
| Parameter | Type | Nullable | Description |
|---|---|---|---|
equipmentId | String (ULID) | False | The ID of the equipment. |
name | String | False | The name of the Meter Configuration to delete. |
Returns
If successful, an ApiResponse object is returned with the success bool set to True.
| Name | Type | Description |
|---|---|---|
success | Boolean | Indicates if the delete was successful. |
message | String | The reason why the deletion was successful or unsuccessful. |
data | String | The data associated with the deletion. |
error | String | The errors associated with the deletion. |
Code Examples
# Delete a Meter Configuration by ID
response = system.mes.meter.deleteMeterConfiguration('01J9YP3JBR-WQ8GWRR2-8Y879V2F')
print(response)
# Delete a Meter Configuration by equipment ID and name
response = system.mes.meter.deleteMeterConfiguration('01J9YP3JBR-WQ8GWRR2-8Y879V2D', 'Main Panel kWh')
print(response)