Write

Write a point value on a given source.

POST /v1/write

curl https://api.novant.io/v1/write \
  -X POST \
  -u ak_sample_123: \
  -d point_id=s.1.3 \
  -d value=25.0 \
  --compressed

Parameters

point_id Required

Point ID for point to write.

value Required

The value to write for point as a floating point number or "null" string to clear a priority hold.

level

The priority level for Bacnet sources. If not specified, it will default to 16.

expires

Optional duration after which the write should be automatically released, formatted as a duration string (e.g. "1hr", "30min", "1day"). When omitted, the write persists until explicitly released.

Returns

Returns with a status of "ok".

{
  "status": "ok",
}

Batch Writes

Up to 25 writes can be submitted in a single request using bracket notation. Each entry takes the same point_id / value / level / expires fields as a single write, indexed by position.

curl https://api.novant.io/v1/write \
  -X POST \
  -u ak_sample_123: \
  -d 'writes[0][point_id]=s.1.3' \
  -d 'writes[0][value]=25.0' \
  -d 'writes[0][level]=8' \
  -d 'writes[1][point_id]=s.1.4' \
  -d 'writes[1][value]=20.0' \
  -d 'writes[1][expires]=1hr' \
  --compressed

Validation is all-or-nothing: if any entry is invalid the entire request is rejected and no writes are committed. Indices must be sequential and start at 0.

Returns

Returns with a status of "ok".

{
  "status": "ok"
}