Ctrlk
Request a demo
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Job Runs

Trigger a job run

post

Starts a run of the specified job. Supports an optional backrun to backfill prior periods. Returns a receipt with the generated run ID.

Permissions

  • Required: DATA_QUALITY and DATA_QUALITY_JOB_RUN

  • Global bypass:

    • DATA_QUALITY and RESOURCE_MANAGE_ALL

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
jobNamestring · min: 1 · max: 255Required

Job name. Allowed characters by default: letters, digits, _, ., -. Configurable via the server env variable VALIDATION_PATTERN_JOB_NAME. Default pattern: ^[a-zA-Z0-9_.-]+$.

Example: crm_raw.DimAccountPattern: ^[a-zA-Z0-9_.-]+$
Body

Parameters for a single job run. If omitted, defaults apply (now as a runDate, no backrun).

runDateall of · nullableOptional
anyOptional

Start of the time slice used only when the sourceQuery contains the ${rd} placeholder. The engine substitutes ${rd} using jobSettings.dateFormat:

  • DATE → yyyy-MM-dd
  • TIMESTAMP → RFC 3339 yyyy-MM-dd'T'HH:mm:ss'Z'

If sourceQuery omits ${rd}, this value does not restrict the data scan and only affects the run’s date (e.g., run metadata/labeling, scheduling context).

or
and
anyOptional

Start of the time slice used only when the sourceQuery contains the ${rd} placeholder. The engine substitutes ${rd} using jobSettings.dateFormat:

  • DATE → yyyy-MM-dd
  • TIMESTAMP → RFC 3339 yyyy-MM-dd'T'HH:mm:ss'Z'

If sourceQuery omits ${rd}, this value does not restrict the data scan and only affects the run’s date (e.g., run metadata/labeling, scheduling context).

Optional. If omitted, the service uses the current date/time

runDateEndone of · nullableOptional

Exclusive end of the time slice, used only when the sourceQuery contains the ${rdEnd} placeholder. Must be greater than runDate when both are provided. Formatted per jobSettings.dateFormat:

  • DATE → yyyy-MM-dd
  • TIMESTAMP → RFC 3339 yyyy-MM-dd'T'HH:mm:ss'Z'

If sourceQuery omits ${rdEnd}, this value does not restrict the data scan and is ignored for run timing.

or
Responses
202

Accepted. Run created and queued.

application/json
post/jobs/{jobName}/run

Search job runs

get

Returns job runs that user has permission to view with pagination and filters. Results are sorted by the last updated timestamp in descending order.

Permissions

  • Required: DATA_QUALITY and DATA_QUALITY_JOB_VIEW

  • Global bypass:

    • DATA_QUALITY and VIEW_PERMISSIONS_VIEW_ALL

    • DATA_QUALITY and RESOURCE_MANAGE_ALL

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters
jobNamestring · max: 255Optional

Name filter. Behavior depends on nameMatchMode. Blank or omitted returns all runs.

Default: ""Example: nyse
nameMatchModestring · enumOptional

How to compare jobName:

  • EXACT - case-sensitive exact match
  • CONTAINS - case-insensitive substring match (default)
Default: CONTAINSExample: EXACTPossible values:
jobTypestringOptional

Execution mode for Data Quality job. Pullup jobs are available only when the Pullup preview feature is enabled. Allowed values: "PUSHDOWN", "PULLUP".

Example: PUSHDOWN
statusstring[] · max: 20Optional

Filter by job run status. Pass multiple values using repeated params. If omitted, all statuses are returned.

Example: {"value":["INIT","RUNNING"]}
limitinteger · max: 1000Optional

Number of results per page.

Default: 100Example: 100
offsetintegerOptional

Result offset.

Default: 0Example: 0
Responses
200

Successfully retrieved job runs

application/json

Paged list of job runs

totalinteger · int64Required

Total number of matching items

Example: 728
offsetinteger · int64Required

Current offset

Example: 0
limitinteger · int64Required

Page size

Example: 100
get/jobRuns

Get job run

get

Returns the job run identified by the given run id.

Permissions

  • Required: DATA_QUALITY and DATA_QUALITY_JOB_VIEW

  • Global bypass:

    • DATA_QUALITY and VIEW_PERMISSIONS_VIEW_ALL

    • DATA_QUALITY and RESOURCE_MANAGE_ALL

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
jobRunIdstring · uuidRequired

Job run id

Responses
200

OK

application/json

Individual job run.

Fields fall into three populated-when buckets:

  • Always populated (run lifecycle): jobRunId, jobName, status, runDate, activity, startedBy, startTime, updatedAt.
  • Populated for terminal states (FINISHED, CANCELLED, FAILED) where data is available, otherwise null: endTime, executionTimeSeconds, score, activeMonitors, breakingMonitors, rowCount, executedQuery.
  • Populated when configured / on failure: sourceQuery (only if the job defines one), exception (only on FAILED).
jobRunIdstring · uuidOptional

Id of the individual job run

Example: 9c1d1e3a-2b4f-4a6c-8d90-111213141516
jobNamestring · min: 1 · max: 255Optional

Job name. Allowed characters by default: letters, digits, _, ., -. Configurable via the server env variable VALIDATION_PATTERN_JOB_NAME. Default pattern: ^[a-zA-Z0-9_.-]+$.

Example: crm_raw.DimAccountPattern: ^[a-zA-Z0-9_.-]+$
runDateone ofOptional

Start of the time slice used only when the sourceQuery contains the ${rd} placeholder. The engine substitutes ${rd} using jobSettings.dateFormat:

  • DATE → yyyy-MM-dd
  • TIMESTAMP → RFC 3339 yyyy-MM-dd'T'HH:mm:ss'Z'

If sourceQuery omits ${rd}, this value does not restrict the data scan and only affects the run’s date (e.g., run metadata/labeling, scheduling context).

or
statusstring · max: 255Optional

Status of an individual job run.

Current possible values include:

  • WAITING
  • DISPATCHED
  • SETUP
  • RUNNING
  • SENDING
  • FINISHED
  • CANCELLED
  • FAILED
  • UNKNOWN

Additional statuses may be introduced in the future.

Example: RUNNING
activitystringOptional

Current activity within the job run.

Current possible values include:

  • INIT
  • SCHEMA
  • LOAD
  • DISCOVERY
  • PROFILE
  • RULES
  • HISTOGRAMS
  • CORRELATION
  • LAYERS
  • RESULTS
  • ALERTS
  • "" – no activity / idle (legacy representation).

Additional activities may be introduced in the future. Clients SHOULD treat unknown values as “implementation detail” and not fail on them.

Example: PROFILE
exceptionstring · nullableOptional

Job exception message if the run failed

Example: Connection timeout to source
startedBystring · uuidOptional

User id who run the job

Example: d6973b7c-383a-4bf3-b29e-1b664bb2162e
updatedAtstring · date-timeOptional

Last updated timestamp (UTC)

Example: 2025-10-23T13:52:10Z
startTimestring · date-timeOptional

Job start timestamp (UTC)

Example: 2025-10-23T13:50:05Z
endTimestring · date-time · nullableOptional

Timestamp (UTC, ISO 8601) when the run reached a terminal state. Null while in progress.

Example: 2025-10-23T13:54:42Z
executionTimeSecondsinteger · int64 · nullableOptional

Wall-clock duration in seconds (endTime - startTime). Null while in progress.

Example: 277
scorenumber · double · max: 100 · nullableOptional

Overall data quality score for the run, as a percentage in [0, 100]. Null if scoring did not complete.

Example: 95
activeMonitorsinteger · int32 · nullableOptional

Count of monitors evaluated during the run. Null if evaluation did not complete.

Example: 20
breakingMonitorsinteger · int32 · nullableOptional

Count of monitors that reported a breaking status. Null if evaluation did not complete.

Example: 1
rowCountinteger · int64 · nullableOptional

Number of rows scanned or processed by the run. Null if the data scan did not complete.

Example: 150000
sourceQuerystring · nullableOptional

Source SQL for the job.

  • If you want to limit the data slice by date/time, do not hard-code literal dates in the SQL. Always use the placeholders ${rd} (start) and ${rdEnd} (exclusive end), and pass the actual values via the runDate / runDateEnd fields of the request.
    Example pattern: WHERE "trade_date" >= '${rd}' AND "trade_date" < '${rdEnd}'
  • The engine will substitute ${rd} / ${rdEnd} based on your chosen dateFormat (DATE or TIMESTAMP).
  • Keep the placeholders inside single quotes in SQL (e.g. '${rd}').
  • If you do not include a date predicate, the job will scan the full table (or whatever the query returns).
  • If omitted, the platform will generate a default(vendor compatible) SELECT * FROM "<schema>"."<table>"
Example: SELECT * FROM "public"."nyse" WHERE "trade_date" >= '${rd}' AND "trade_date" < '${rdEnd}'
executedQuerystring · nullableOptional

The query actually executed for this run, with ${rd} / ${rdEnd} substituted using the job's configured dateFormat. This is the post-substitution form of sourceQuery — the schema/table names, predicates, and any literal values it contains are the same surface already exposed via sourceQuery on JobDefinition.

Null if the run failed before substitution.

Example: SELECT * FROM "public"."nyse" WHERE "trade_date" >= '2025-10-22T13:00:00Z' AND "trade_date" < '2025-10-23T13:00:00Z'
get/jobRuns/{jobRunId}

Cancel job run

post

Cancels the job identified by job run id.

Permissions

  • Required: DATA_QUALITY and DATA_QUALITY_JOB_RUN

  • Global bypass:

    • DATA_QUALITY and RESOURCE_MANAGE_ALL

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
jobRunIdstring · uuidRequired

Job run identifier

Responses
200

Job cancelled successfully. No response body.

No content
post/jobRuns/{jobRunId}/cancel
No content

Get job-run profile results

get

Returns detailed column-level profiling statistics produced by a single job run. Use this to understand the data distribution, type inconsistencies, and format anomalies observed during the run.

Permissions

  • Required:

    • DATA_QUALITY (global)

    • DATA_QUALITY_JOB_VIEW (resource on the job)

  • Global bypass (either of the following):

    • DATA_QUALITY and VIEW_PERMISSIONS_VIEW_ALL

    • DATA_QUALITY and RESOURCE_MANAGE_ALL

Authorizations
AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters
jobRunIdstring · uuidRequired

Job run identifier

Query parameters
limitinteger · max: 500Optional

Maximum number of column profiles per page.

Default: 100Example: 100
offsetintegerOptional

Index of the first column profile to return.

Default: 0Example: 0
includeTotalbooleanOptional

When true, the response includes total (the count of columns available across all pages). Omitted by default to avoid the additional count query.

Default: false
Responses
200

OK

application/json

Paginated per-column profiling results captured during a single job run. The header fields (jobRunId, jobName, runDate) identify the run; results carries one entry per profiled column for the requested page. Results are returned in deterministic order, ascending by column name.

jobRunIdstring · uuidOptional

Unique identifier of the job run that produced these results.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
jobNamestring · min: 1 · max: 255Optional

Job name. Allowed characters by default: letters, digits, _, ., -. Configurable via the server env variable VALIDATION_PATTERN_JOB_NAME. Default pattern: ^[a-zA-Z0-9_.-]+$.

Example: crm_raw.DimAccountPattern: ^[a-zA-Z0-9_.-]+$
runDateall ofOptional
anyOptional

Start of the time slice used only when the sourceQuery contains the ${rd} placeholder. The engine substitutes ${rd} using jobSettings.dateFormat:

  • DATE → yyyy-MM-dd
  • TIMESTAMP → RFC 3339 yyyy-MM-dd'T'HH:mm:ss'Z'

If sourceQuery omits ${rd}, this value does not restrict the data scan and only affects the run’s date (e.g., run metadata/labeling, scheduling context).

or
and
anyOptional

The run window of the run that produced these results. Shape follows the job's configured dateFormat:

  • DATE – { "kind": "DATE", "value": "yyyy-MM-dd" }
  • TIMESTAMP – { "kind": "TIMESTAMP", "value": "<RFC 3339 in UTC>" }
offsetinteger · int64Optional

Index of the first column profile in this page.

Example: 0
limitinteger · int64Optional

Maximum number of column profiles in this page.

Example: 100
totalinteger · int64Optional

Total number of column profiles available for this run, across all pages. Only present when the request included includeTotal=true.

Example: 35
get/jobRuns/{jobRunId}/profile
PreviousJobsNextModels

Last updated

Was this helpful?