Skip to main content
POST
Create an asset meter

Authorizations

X-API-KEY
string
header
required
OW-KEY
string
header
required

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Body

application/json

Fields not listed here (e.g. valueType, valueUnit, locationId) are ignored if sent.

name
string
required
assetId
integer
required
meterTypeId
integer
required
readingMode
enum<string>

Optional; defaults to direct_reading.

Available options:
direct_reading,
change_from_baseline,
compare_to_target
defaultExpectedValue
string | null
isArchived
boolean | null

Response

Success.

type
string
required

Entity type marker, e.g. "AssetMeter".

data
object
required

Asset meter. Hydrated asset/meterType/location objects may also appear in responses.

status
enum<string>
required
Available options:
ok