Configuration APIMeter Values

Update a meter value

Requires the METER_VALUE.UPDATE permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdOrReferencestringRequiredDefaults to
The ID or reference of the resource.

Headers

x-platform-idstringOptional
Platform ID.

Request

This endpoint expects an object.
referencestringRequiredformat: "^\S+$"0-256 characters
namestring or nullOptionalformat: "^.*$"0-256 characters
descriptionstring or nullOptionalformat: "^.*$"0-256 characters
statusenum or nullOptional
The status of the meter value indicating the activity and the ability to update properties.
Allowed values:
typeenum or nullOptional
The type of the meter value.
Allowed values:

Response

OK
referencestringformat: "^\S+$"0-256 characters
object_typestring or nullRead-only
idstring or nullRead-only
namestring or nullformat: "^.*$"0-256 characters
descriptionstring or nullformat: "^.*$"0-256 characters
statusenum or null
The status of the meter value indicating the activity and the ability to update properties.
Allowed values:
typeenum or null
The type of the meter value.
Allowed values:

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error