Skip to main content
GET
Get point write state
The level in effect is the lowest level number that holds a value. KODE OS reads it from the data source on each request, the same way as Get point priority array. The response has one of three shapes:
  • A level is in effect: supported is true, and activeLevel, value, and who describe that level.
  • No level holds a value: supported and relinquishDefault are true, and the other fields are null. The point is at its relinquish default. The default value itself is not returned.
  • Not supported: supported is false when the point is not writable, or its connector cannot write to points or has been deleted. The other fields are null or false.
A connector that does not keep a priority array for the point also returns relinquishDefault: true. This endpoint only reads. It does not write a value or release a level.

Authorizations

Authorization
string
header
required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Path Parameters

buildingId
string
required

Building identifier from List buildings.

pointId
string
required

Point identifier.

Response

The write state of the point.

supported
boolean

false when the point is not writable, or its connector cannot write to points or has been deleted.

Example:

true

activeLevel
integer<int32> | null

The level in effect. null when no level holds a value or the point is not supported.

Example:

8

value
string | null

Value held at the level in effect.

Example:

"72"

who
string | null

Who set the value at the level in effect.

Example:

"KODE OS"

relinquishDefault
boolean

true when no level holds a value, so the point is at its relinquish default.

Example:

false