Skip to main content
GET
List mass write operations
The list shows the stored state of each operation. It does not recount points, so an operation can show RUNNING after its points are done. Get a mass write operation refreshes it.
A service account sees only the operations it started. An operation that covers several buildings appears under each of them. Use state, buildingId, from, and to to narrow the list. from and to filter on the creation date, in UTC. KODE API ignores q, asc, and dsc.

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.

Query Parameters

buildingId
string

Return only operations that write in this building.

Pattern: [^\p{C}\p{Z}]{1,128}
from
string<date>

Return operations created on or after this date (YYYY-MM-DD, UTC).

Example:

"2022-03-10"

limit
integer<int32>
default:50

Number of items per page, from 1 to 200. The default is 50.

Required range: 1 <= x <= 200
page
integer<int32>
default:1

Page number to return. The first page is 1.

Required range: x >= 1
state
enum<string>

Return only operations in this state.

Available options:
QUEUED,
RUNNING,
SUCCEEDED,
FAILED
to
string<date>

Return operations created on or before this date (YYYY-MM-DD, UTC).

Example:

"2022-03-10"

Response

A page of operations. itemCount is the total number that match the filters.

data
object[]
page
integer<int32>
limit
integer<int32>
pageCount
integer<int32>
itemCount
integer<int32>