v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Content validator

Validate content

Validate all content against the model and return documents with queries and any validation issues.

This endpoint scans all documents associated with the model and identifies any fields, views, or other model elements referenced in queries that are no longer valid.

You can optionally scope validation to only content that references a specific model element (view, field, or topic) using the find and find_type parameters. This is useful when you only need to validate content using a specific element, avoiding the overhead of validating all documents.

get/v1/models/{modelId}/content-validator

Path parameters

modelIdstring uuid required

The ID of the model to validate content against.

Query parameters

branch_idstring uuid

The ID of the branch to validate against. If not provided, validates against the main model.

userIdstring uuid

The user ID to act on behalf of. Only valid when using an organization API key.

User-scoped API keys cannot use this parameter and will receive a 403 error if provided.

include_personal_foldersboolean

When enabled, include personal folders in the search.

findstring

The name of the model element to find content references for. Must be used together with find_type.

For FIELD type, the value must be fully qualified with the view name (e.g., orders.status).

find_type'VIEW' | 'FIELD' | 'TOPIC'

The type of model element to search for. Must be used together with find.

When both parameters are provided, only content that references the specified element will be validated and included in the response.

Response

Content validation results

model_idstring uuid

The ID of the model that was validated.