OMomniapp
Models

Read branch dbt environment

Changed on

Read the dbt environment a branch resolves to, including the dbt git branch it compiles against. A branch with no environment of its own resolves to the connection's default (production) environment, reported with is_default_environment: true.

get/api/v1/models/{modelId}/branch/{branchName}/dbt

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/models/{modelId}/branch/{branchName}/dbt
  • Auth
    HTTP bearer

Path parameters

modelIdstring uuid required

Model UUID

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

Branch name

Example:feature/new-metrics

Response

The dbt environment the branch resolves to

git_branchstring required

The dbt git branch the environment compiles against. When none is pinned, this is the resolved default: for a non-production environment on a branch, a git branch named after the Omni branch; otherwise the dbt repo's default branch. If the named branch doesn't exist in the dbt repo, compilation falls back to the repo's default branch.

idstring uuid required

ID of the dbt environment the branch resolves to

is_default_environmentboolean required

True when the branch resolves to the connection's default (production) environment — typically because the branch has no dbt environment of its own.

is_deferral_enabledboolean required
manifest_status'NOT_FOUND' | 'OUTDATED' | 'UP_TO_DATE' required

Whether the environment's compiled dbt manifest is up to date

namestring nullable required
owner_idstring uuid nullable required

User id the environment belongs to (a personal development environment), or null

target_databasestring nullable required
target_namestring nullable required
target_rolestring nullable required
target_schemastring required

Example response

{
  "git_branch": "feature/new-metrics",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Production"
}

Changes