v4

OpenAPI 3.1.02026-08-01207318738.7 KB
Documents

Bind a tile to a query model

Bind a query-presentation tile to a query model on a draft.

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.

The queryModelId must be a live query model layered on this draft’s workbook model, and not already bound to another tile — a query model is dedicated to a single query. A LINKED tile inherits its query model from its source and can’t be bound directly.

put/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.

Request body

queryModelIdstring uuid required

The query model to bind this tile to. Must be a query model layered on this draft’s workbook model, not already bound to another tile.

Response

Tile bound to the 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.