---
title: "Trigger a job run"
method: POST
path: "/jobs/{jobName}/run"
tags: ["Job Runs"]
---

# Trigger a job run

`POST /jobs/{jobName}/run`

## Request

- Base URL: `/rest/2.0` (relative, and the document’s source URL is not known)
- URL: `/rest/2.0/jobs/{jobName}/run`
- Auth: one of:
  - HTTP basic
  - HTTP bearer
  - OAuth 2
    - Client credentials
    - Token URL: `/rest/oauth/v2/token` scopes: `sys.admin`
  - OAuth 2
    - Client credentials
    - Token URL: `/rest/oauth/v2/token`
- TypeScript: <https://skmtc.dev/collibra/apis/collibra-data-governance-center-core-api/docs/jobs/:jobName/run/post.ts> (a function with typed inputs; its response is checked against the schema)

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`

## Path parameters

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

## Request body

- JobRunRequest: Parameters for a single job run. If omitted, defaults apply (now as a runDate, no backrun).
  - `runDate` union
    - object, nullable: 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
      - `kind` string, required
      - `value` string, date, required
    - object, nullable: 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
      - `kind` string, required
      - `value` string, date-time, required
  - `runDateEnd` union: **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.
    - DateOnly: Calendar date, format yyyy-MM-dd.
      - `kind` string, required
      - `value` string, date, required
    - Rfc3339DateTime: RFC 3339 timestamp with timezone offset. The server normalizes all inputs to UTC and responses are returned in UTC (trailing 'Z'), seconds precision.
      - `kind` string, required
      - `value` string, date-time, required
  - `backrun` object, nullable: Optional historical backfill: trigger additional runs for prior periods based on `timeBin` and `binValue`.
    - `timeBin` string, required: Time bin used when defining backruns. Current possible values include: * `DAY` – backrun by day. * `MONTH` – backrun by month. * `YEAR` – backrun by year. Additional values may be introduced in the future
    - `binValue` integer, required: Number of past bins to backfill

## Response `202`

Accepted. Run created and queued.

- JobSubmission
  - `jobRunId` string, uuid

## Other responses

- `400`: Bad request — invalid input or validation error.
- `401`: Unauthorized — authentication is required or the provided credentials are invalid.
- `403`: Forbidden — insufficient permissions.
- `404`: Resource not found.
- `500`: Internal Server Error

---

[API](https://skmtc.dev/collibra/apis/collibra-data-governance-center-core-api.md) - [All operations](https://skmtc.dev/collibra/apis/collibra-data-governance-center-core-api/llms.txt) - [OpenAPI document](https://skmtc.dev/collibra/apis/collibra-data-governance-center-core-api/revisions/6d091bc86a33?raw)