v4

OpenAPI 3.1.02026-08-01207318738.7 KB
Documents

Unbind a tile from its query model

Unbind a query-presentation tile from its query model on a draft, keeping the tile’s query. No request body.

The query-model binding (query.model_extension_id) is server-owned on the whole-document PATCH surface — a supplied value there is ignored and the tile keeps its stored binding. This draft-scoped route is the way to change it, addressing one tile by its stable record key. The binding shifts on every draft (each draft re-clones its query models), so work against a draft you have already read.

delete/api/v2/documents/{identifier}/draft/{draftIdentifier}/queries/{queryKey}/query-model

Path parameters

draftIdentifierstring required

Draft workbook identifier (see PATCH /api/v2/documents/{identifier}/draft).

Example:def456

Draft workbook identifier (see PATCH /api/v2/documents/{identifier}/draft).

identifierstring required

Published document identifier.

Example:abc123

Published document identifier.

queryKeystring required

Record key of the tile, as it appears in queryPresentations.data.

Example:1

Record key of the tile, as it appears in queryPresentations.data.

Response

Tile unbound from its query model; the response carries the draftIdentifier.

descriptionstring nullable required

Document description.

draftIdentifierstring required

Identifier of the draft the patch was applied to.

identifierstring required

Published document identifier the draft targets.

namestring required

Document name.