Jobs
Collibra REST API authentication using Basic Authentication.
Fuzzy, case-insensitive name filter. Uses SQL LIKE semantics: %jobName% Blank or omitted returns all jobs
""Example: public.nyseEdge Site Name
k8s-edge-site-1Edge connection name
Finance-Postgres-GCPData source (database/catalog) name
postgresFilter by schema name
publicFilter by table or view name
nyseExecution mode for Data Quality job. Pullup jobs are available only when the Pullup preview feature is enabled. Allowed values: "PUSHDOWN", "PULLUP".
PUSHDOWNNumber of results per page
100Example: 100Result offset
0Example: 0Successfully retrieved jobs
Paged list of jobs
Total number of matching items.
237Current offset.
0Page size.
100Unauthorized
Forbidden
Internal Server Error
Collibra REST API authentication using Basic Authentication.
Indicates whether the created job should be queued to run immediately after creation.
Currently queueRun will always treated as true, whether the client provides a value or omits the field. Create-only behavior is not supported yet. In future versions, this field will become fully optional and will default to false.
trueJob name. Allowed characters by default: letters, digits, _, ., -. Configurable via the server env variable VALIDATION_PATTERN_JOB_NAME. Default pattern: ^[a-zA-Z0-9_.-]+$.
crm_raw.DimAccountPattern: ^[a-zA-Z0-9_.-]+$Execution mode for Data Quality job. Pullup jobs are available only when the Pullup preview feature is enabled. Allowed values: "PUSHDOWN", "PULLUP".
PUSHDOWNSource 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 therunDate/runDateEndfields of the request.
Example pattern:WHERE "trade_date" >= '${rd}' AND "trade_date" < '${rdEnd}' - The engine will substitute
${rd}/${rdEnd}based on your chosendateFormat(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>"
SELECT * FROM "public"."nyse" WHERE "trade_date" >= '${rd}' AND "trade_date" < '${rdEnd}'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).
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. May be omitted or set to null. If not provided, the system will use the current date/time as the run date.
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.
Controls when a scheduled job runs and how runDate is adjusted. Exactly one schedule mode is allowed. Optional If omitted or null, the job will not be scheduled.
{"daily":{"summary":"Weekdays at 04:00 am UTC, no offset","value":{"isActive":true,"scheduledRunTime":"04:00:00","schedulerMode":"DAILY","daily":{"dailyOffset":"SCHEDULED","daysOfWeek":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"]}}}}Controls when a scheduled job runs and how the runDate is adjusted by schedule-specific offsets. The scheduler runs at the given UTC time and applies the selected mode (HOURLY/DAILY/MONTHLY).
Optional. May be omitted or set to null. If not provided, no scheduling settings will be applied.
Job created and run queued.
Response for job creation. Contains all fields of JobDefinition
plus an optional identifier of the queued run when queueRun = true.
Job name. Allowed characters by default: letters, digits, _, ., -. Configurable via the server env variable VALIDATION_PATTERN_JOB_NAME. Default pattern: ^[a-zA-Z0-9_.-]+$.
crm_raw.DimAccountPattern: ^[a-zA-Z0-9_.-]+$Execution mode for Data Quality job. Pullup jobs are available only when the Pullup preview feature is enabled. Allowed values: "PUSHDOWN", "PULLUP".
PUSHDOWNSource 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 therunDate/runDateEndfields of the request.
Example pattern:WHERE "trade_date" >= '${rd}' AND "trade_date" < '${rdEnd}' - The engine will substitute
${rd}/${rdEnd}based on your chosendateFormat(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>"
SELECT * FROM "public"."nyse" WHERE "trade_date" >= '${rd}' AND "trade_date" < '${rdEnd}'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).
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.
Controls when a scheduled job runs and how runDate is adjusted. Exactly one schedule mode is allowed. Optional If omitted or null, the job will not be scheduled.
{"daily":{"summary":"Weekdays at 04:00 am UTC, no offset","value":{"isActive":true,"scheduledRunTime":"04:00:00","schedulerMode":"DAILY","daily":{"dailyOffset":"SCHEDULED","daysOfWeek":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"]}}}}Identifier of the queued job run, if the job was scheduled to run immediately after creation.
- Present when
queueRun = trueand the run was successfully queued. falsewhen the job was created without an immediate run (future state).
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Collibra REST API authentication using Basic Authentication.
Job name. Allowed characters by default: letters, digits, _, ., -. Configurable via the server env variable VALIDATION_PATTERN_JOB_NAME. Default pattern: ^[a-zA-Z0-9_.-]+$.
crm_raw.DimAccountPattern: ^[a-zA-Z0-9_.-]+$OK
Job name. Allowed characters by default: letters, digits, _, ., -. Configurable via the server env variable VALIDATION_PATTERN_JOB_NAME. Default pattern: ^[a-zA-Z0-9_.-]+$.
crm_raw.DimAccountPattern: ^[a-zA-Z0-9_.-]+$Execution mode for Data Quality job. Pullup jobs are available only when the Pullup preview feature is enabled. Allowed values: "PUSHDOWN", "PULLUP".
PUSHDOWNSource 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 therunDate/runDateEndfields of the request.
Example pattern:WHERE "trade_date" >= '${rd}' AND "trade_date" < '${rdEnd}' - The engine will substitute
${rd}/${rdEnd}based on your chosendateFormat(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>"
SELECT * FROM "public"."nyse" WHERE "trade_date" >= '${rd}' AND "trade_date" < '${rdEnd}'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).
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.
Controls when a scheduled job runs and how runDate is adjusted. Exactly one schedule mode is allowed. Optional If omitted or null, the job will not be scheduled.
{"daily":{"summary":"Weekdays at 04:00 am UTC, no offset","value":{"isActive":true,"scheduledRunTime":"04:00:00","schedulerMode":"DAILY","daily":{"dailyOffset":"SCHEDULED","daysOfWeek":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"]}}}}Unauthorized
Forbidden
Not Found
Internal Server Error
Collibra REST API authentication using Basic Authentication.
Job name. Allowed characters by default: letters, digits, _, ., -. Configurable via the server env variable VALIDATION_PATTERN_JOB_NAME. Default pattern: ^[a-zA-Z0-9_.-]+$.
crm_raw.DimAccountPattern: ^[a-zA-Z0-9_.-]+$Job successfully deleted
No content
Unauthorized
Forbidden
Internal Server Error
No content
Collibra REST API authentication using Basic Authentication.
Job name. Allowed characters by default: letters, digits, _, ., -. Configurable via the server env variable VALIDATION_PATTERN_JOB_NAME. Default pattern: ^[a-zA-Z0-9_.-]+$.
crm_raw.DimAccountPattern: ^[a-zA-Z0-9_.-]+$The name of an existing job definition to update
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 therunDate/runDateEndfields of the request.
Example pattern:WHERE "trade_date" >= '${rd}' AND "trade_date" < '${rdEnd}' - The engine will substitute
${rd}/${rdEnd}based on your chosendateFormat(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>"
SELECT * FROM "public"."nyse" WHERE "trade_date" >= '${rd}' AND "trade_date" < '${rdEnd}'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).
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. May be omitted or set to null. If not provided, no updates will be made to existing run date.
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.
Controls when a scheduled job runs and how runDate is adjusted. Exactly one schedule mode is allowed. Optional If omitted or null, the job will not be scheduled.
{"daily":{"summary":"Weekdays at 04:00 am UTC, no offset","value":{"isActive":true,"scheduledRunTime":"04:00:00","schedulerMode":"DAILY","daily":{"dailyOffset":"SCHEDULED","daysOfWeek":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY"]}}}}Controls when a scheduled job runs and how the runDate is adjusted by schedule-specific offsets. The scheduler runs at the given UTC time and applies the selected mode (HOURLY/DAILY/MONTHLY).
Optional. May be omitted or set to null. If not provided, no updates will be made to existing scheduling settings.
OK. Job updated successfully. No response body.
No content
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
No content
Last updated
Was this helpful?