Skip to main content
POST
Clear a templating plan
A clear changes live data on every matched point and cannot be undone. It resets each point’s name and display name to the connector name and its unit to the connector unit, and it removes the ontology fields, enum maps, and graphing defaults. A request without mappings clears the whole device selection for the canonical type. Validate first and check summary.matchedPoints.
Send the same body as Apply a templating plan: canonicalType, deviceIds, requestId, and optionally etag and validateOnly. The same rules for validation, etag, and requestId replay apply. A clear mapping needs only match. Leave out field, overrides, and enumMapping.
  • With mappings, only the points the mappings match are cleared. If no mapping matches a point, nothing is cleared.
  • Without mappings, or with an empty list, every point templated under canonicalType on the selected devices is cleared. A dry run with no mappings reports in summary.matchedPoints and summary.devicesAffected how many points and devices a real clear would reach.
When a clear leaves a device with no templated point, the device and its points also lose the canonicalType, so you can template the device again under another type. A point that is cleared while its device still has other templated points keeps the canonical type. Clear does not remove dataInterval or the write capabilities that apply set on points. Virtual points are not touched. Points on platform-managed connectors are skipped.

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.

Body

application/json
canonicalType
string
required

Canonical type this plan is scoped to.

Maximum string length: 255
Pattern: (?s)(?=.*[^\p{C}\p{Z}])[\P{Cc}\n\r\t]*
Example:

"AHU"

deviceIds
string[]
required

Explicit device ids to scope this plan to.

Required array length: 1 - 2000 elements
Maximum string length: 255
Pattern: [^\p{C}\p{Z}]{1,128}
requestId
string
required

Client-chosen idempotency key, unique per building. Repeating it with the same plan returns the existing operation; with a different plan it is rejected.

Maximum string length: 128
Pattern: [^\p{C}\p{Z}]{1,128}
Example:

"ahu-1-apply-2026-09-30"

mappings
object[]

The plan's mappings. Empty or omitted on :clear clears the whole device selection for this canonical type.

Maximum array length: 1000
etag
string

Etag from a previous validation. If it no longer matches, the request fails with 400; validate again for a fresh etag. Omitted means no check.

Maximum string length: 128
Pattern: [^\p{C}\p{Z}]{1,128}
Example:

"sha256:9f86d0818..."

validateOnly
boolean

Dry run: true returns the validation report and writes nothing.

Example:

false

Response

The started operation in operation, or the validation report in validationReport when validateOnly is true. Exactly one of the two is present.

validationReport
object

Present only for validateOnly: true. The plan's validation report; nothing was written.

operation
object

Present only when validateOnly is false. The started operation, or the existing one when the requestId is replayed with the same plan.