Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Meters

Update meter

patch/meters/{id}

Path parameters

idinteger required

ID of the meter

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Request body

assetIdinteger nullable

Global ID of the asset tied to the meter

locationIdinteger nullable

Global ID of the location tied to the meter

descriptionstring nullable

Description of the meter

namestring

Name of the meters

unitstring

Measurement unit for the readings. Any string is accepted. However, if applicable, we recommed you to use the following units as it may carry extra functionality: <br><ul> <li>Distance: <ul> <li><code>Miles</code></li><li><code>Feet</code></li><li><code>Inches</code></li><li><code>Kilometers</code></li><li><code>Meters</code></li><li><code>Centimeters</code></li><li><code>Millimeters</code></li> </ul> </li> <li>Volume: <ul> <li><code>Gallons</code></li><li><code>Liters</code></li><li><code>Milliliters</code></li><li><code>Cubic Meters</code></li> </ul> </li> <li>Temperature: <ul> <li><code>Celsius</code></li><li><code>Fahrenheit</code></li><li><code>Kelvin</code></li> </ul> </li> <li>Other: <ul> <li><code>Hours</code></li><li><code>Cycles</code></li><li><code>PSI</code></li><li><code>Kilograms</code></li><li><code>Grams</code></li><li><code>dBm</code></li><li><code>Nm</code></li> </ul> </li> <li>Velocity: <ul> <li><code>MetersPerSecond</code></li><li><code>InchesPerSecond</code></li><li><code>MillimetersPerSecond</code></li> </ul> </li> <li>Acceleration: <ul> <li><code>G-Force</code></li><li><code>MetersPerSecondSquared</code></li><li><code>FeetPerSecondSquared</code></li> </ul> </li> <li>Electrical: <ul> <li><code>Volts</code></li><li><code>Amps</code></li> </ul> </li> </ul>

Example request

{
  "assetId": 123,
  "locationId": 123,
  "description": "This meter is used for monitoring the temperature of the boiler",
  "unit": "Celsius"
}

Response

Successfully edited meter

Example response

{
  "meter": {
    "id": 123,
    "assetId": 123,
    "locationId": 123,
    "creatorId": 123,
    "updaterId": 123,
    "uuid": "cd6fdffd-c9e2-4a40-9715-a182a6e5b557",
    "description": "This meter is used for monitoring the temperature of the boiler",
    "measurementType": "AUTOMATED_SENSOR",
    "unit": "Celsius",
    "createdAt": "2022-01-01T00:00:00.000Z",
    "updatedAt": "2022-01-01T00:00:00.000Z",
    "deletedAt": "2022-01-01T00:00:00.000Z"
  }
}