Get a templating operation
Returns the state, progress, and result of an apply or clear run. Poll it until done is true.
operation.name from Apply a templating plan or Clear a templating plan as the operationId. This response is the operation itself. It is not wrapped in operation.
metadata.state is one of:
QUEUEDandRUNNING: The run has not finished.SUCCEEDED: The run finished.responseholdsmatchedPointsanddevicesAffected.FAILED: The run stopped with an error.errorholds the engine’scodeandmessage.STALLED: The run isRUNNINGbut has not reported progress for a while. It is not finished, sodonestaysfalse. KODE API works this state out when you read the operation.
metadata.progress is a percentage that updates after each batch. Do not use it to detect completion. Use done.
When the run is SUCCEEDED, graphics, device references, and device linking update in the background afterwards. They can lag behind the point data for a short time.Authorizations
Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.
Path Parameters
Building identifier from List buildings.
The operation id.
[^\p{C}\p{Z}]{1,128}Query Parameters
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.
Operation resource name.
"buildings/66f1a2b3c4d5e6f7a8b9c0d1/templating/operations/66f1a2b3c4d5e6f7a8b9c0d3"
Whether the operation has finished (successfully or not).
false
Progress and identifying metadata, always present.
Present only once done and successful.
Present only once done and failed.

