Clear a templating plan
Removes ontology fields and enum maps from points. It takes the same request as apply. Without mappings, it clears every templated point of the canonical type on the devices you select.
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
canonicalTypeon the selected devices is cleared. A dry run with no mappings reports insummary.matchedPointsandsummary.devicesAffectedhow many points and devices a real clear would reach.
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
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.
Body
Canonical type this plan is scoped to.
255(?s)(?=.*[^\p{C}\p{Z}])[\P{Cc}\n\r\t]*"AHU"
Explicit device ids to scope this plan to.
1 - 2000 elements255[^\p{C}\p{Z}]{1,128}Client-chosen idempotency key, unique per building. Repeating it with the same plan returns the existing operation; with a different plan it is rejected.
128[^\p{C}\p{Z}]{1,128}"ahu-1-apply-2026-09-30"
The plan's mappings. Empty or omitted on :clear clears the whole device selection for this canonical type.
1000Etag from a previous validation. If it no longer matches, the request fails with 400; validate again for a fresh etag. Omitted means no check.
128[^\p{C}\p{Z}]{1,128}"sha256:9f86d0818..."
Dry run: true returns the validation report and writes nothing.
false
Response
The started operation in operation, or the validation report in validationReport when validateOnly is true. Exactly one of the two is present.

