latestOpenAPI 3.1.02026-08-15211332773.5 KB

cddcef5fd216

Models

Replace content references

post/api/v1/models/{modelId}/content-validator

Path parameters

modelIdstring uuid required

Model UUID

Example:123e4567-e89b-12d3-a456-426614174000

Model UUID

Query parameters

userIdstring uuid

Target user membership ID (for org-scoped API keys)

Request body

branch_idstring

Optional branch ID

creator_idstring uuid

Restrict replacement to documents created by this user (user ID). Unknown IDs return 400.

findstring required

The string to find

find_or_replace_type'FIELD' | 'TOPIC' | 'VIEW' required

Type of find/replace operation. A FIELD replacement also rewrites references to the field through the join aliases of its view (with users joined as sellers, users.age → users.age2 also rewrites sellers.age → sellers.age2); an alias that names a different view in some other topic is only rewritten in content known to be in the topic that aliases it. VIEW replacements do not touch aliases.

folder_pathsstring[]

Restrict replacement to documents in matching folder paths (prefix match). Documents with no folder are excluded unless "" is specified.

include_personal_foldersboolean

Whether to include personal folders

labelsstring

Comma-separated label names to scope replacement. Unknown labels return 400.

only_in_workbook_idstring

Optional workbook ID to limit the replace scope

replacementstring required

The replacement string

Response

Replace operation completed

replaced_dashboard_filters_countinteger required

Number of dashboard filters replaced

replaced_documents_countinteger required

Number of documents modified

replaced_input_column_keys_countinteger required

Number of input columns whose key references were replaced

replaced_queries_countinteger required

Number of queries replaced

replaced_workbook_models_countinteger required

Number of workbook models replaced

skipped_pr_required_countinteger required

Number of documents skipped due to pull request requirements