OMomni
Content validator

Validate content

Changed on

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

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/models/{modelId}/content-validator
  • Auth
    HTTP bearer

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.

force_full_validationboolean

By default, validation of a large set of queries only checks field, view, and topic references, which can miss breakage in sorts, pivots, or totals. Enable this parameter to validate every query at full depth. Validation is slower on large models.

content_filter_mode'ALL' | 'WITH_ISSUES' | 'NO_ISSUES'

Filter documents by validation status.

  • ALL - Return all documents with at least one query.
  • WITH_ISSUES - Return only documents with at least one query issue, dashboard filter issue, or document error.
  • NO_ISSUES - Return only documents with zero issues and no document errors.
labelsstring

Comma-separated list of label names. Documents with any of the specified labels are included.

folder_pathsstring
Example:["/Finance","/Marketing"]

An array of folder paths to restrict validation to. Paths are prefix-matched, so /Finance also matches /Finance/Reports.

Documents that aren't in a folder are excluded unless you include an empty string ("") in the array.

creator_idstring uuid

Return only documents created by this user. This value is the membership ID, not the user ID. Use the List users endpoint to retrieve membership IDs.

Response

Content validation results

model_idstring uuid

The ID of the model that was validated.

Changes

  • 43290040f88fRevision changes
    • info

      added the new optional query request parameter content_filter_mode

    • info

      added the new optional query request parameter creator_id

    • info

      added the new optional query request parameter folder_paths

    • info

      added the new optional query request parameter force_full_validation

    • info

      added the new optional query request parameter labels