Skip to main content
GET
Get a mass write operation
Use the last segment of operation.name from Validate or apply a mass write as the operationId. This response is the operation itself. It is not wrapped in operation.
Each read recounts the points. The read that finds every point done completes the operation. An operation you never read stays RUNNING and blocks the next mass write in its buildings. Poll every metadata.pollAfterSeconds until done is true.
metadata.state is one of:
  • QUEUED and RUNNING: The write has not finished. metadata.counts shows how many points are pending, succeeded, and failed.
  • SUCCEEDED: Every point has an outcome. response holds total, succeeded, and failed. Some points can still have failed, so check response.failed.
  • FAILED: The write could not run to its end. error holds a code and a message.
A point with no outcome two hours after the start is marked FAILED with the code TIMEOUT. Read the outcome of each point with List mass write results.

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

operationId
string
required

Identifier of the operation.

Pattern: [^\p{C}\p{Z}]{1,128}

Query Parameters

fields
string

Comma-separated top-level fields to return. One or more of name, done, metadata, response, and error. The default is every field. An unknown name returns 400.

Response

The operation.

name
string

Resource name of the operation. The last segment is the operationId.

Example:

"mass-write/operations/6acf8bcf8564cb8ad4ccf8f3"

done
boolean

Whether the operation has finished.

metadata
object

Progress and identifying data. Always present.

response
object

Outcome counts. Present when the state is SUCCEEDED.

error
object

Present when the state is FAILED.