Update a job

PATCH

/jobs/{id}

Parameters

Path Parameters

id

required

string

Job ID

Query Parameters

workspaceId

required

string

Workspace ID for access check

Request Body ^required

object

id

required

string

name

required

string

dimensions

required

Array<string>

measures

required

Array<object>

object

name

required

string

aggregation

required

string

Allowed values: SUM COUNT COUNT_DISTINCT COUNT_STAR AVG MIN MAX VARIANCE STD_DEV

connections

required

Array<object>

object

connection_id

required

string

source_database

The source database or spreadsheet identifier (e.g. spreadsheet ID for Google Sheets, site ID for Excel/SharePoint)

string

source_schema

required

The database schema to extract from (e.g. “public”, “customers”)

string

source_table

required

The database table to extract from (e.g. “customers”, “orders”)

string

column_mapping

required

object

filters

Array<object>

object

column

required

string

operator

required

string

values

Array<string>

alias

User-defined display label for this data source

string

stages

required

Array<object>

object

dimensions

required

Array<string>

tolerances

required

Array<object>

object

measure_name

required

string

type

required

string

Allowed values: PERCENT ABSOLUTE

value

required

number

notification_emails

Email addresses to receive job result notifications. Validated against tenant recipient rules.

Array<string>

max_email_rows

Max result rows in FULL_DATA emails for this job. Capped at tenant max_email_rows.

number

email_detail_level

Per-job email detail level override. Can only lower the tenant/workspace level, never raise it.

string

Allowed values: DISABLED STATUS_ONLY STAGE_SUMMARY FULL_DATA

stage_execution_strategy

required

string

default: DRILL_DOWN_ON_FAILURE

Allowed values: SEQUENTIAL PARALLEL DRILL_DOWN_ON_FAILURE

max_stage_concurrency

Maximum number of stages to run concurrently (only used when stage_execution_strategy is PARALLEL)

number

Responses

200

Job updated successfully

object

created_at

required

string format: date-time

created_by

required

string

updated_at

required

string format: date-time

updated_by

required

string

is_soft_deleted

required

boolean

version

required

number

encryption_key_name

required

string

encryption_key_version

number

vault_key_version

number

id

required

string

name

required

string

workspace_id

required

string

dimensions

required

Array<string>

measures

required

Array<object>

object

name

required

string

aggregation

required

string

Allowed values: SUM COUNT COUNT_DISTINCT COUNT_STAR AVG MIN MAX VARIANCE STD_DEV

connections

required

Array<object>

object

connection_id

required

string

source_database

The source database or spreadsheet identifier (e.g. spreadsheet ID for Google Sheets, site ID for Excel/SharePoint)

string

source_schema

required

The database schema to extract from (e.g. “public”, “customers”)

string

source_table

required

The database table to extract from (e.g. “customers”, “orders”)

string

column_mapping

required

object

filters

Array<object>

object

column

required

string

operator

required

string

values

Array<string>

alias

User-defined display label for this data source

string

stages

required

Array<object>

object

dimensions

required

Array<string>

tolerances

required

Array<object>

object

measure_name

required

string

type

required

string

Allowed values: PERCENT ABSOLUTE

value

required

number

notification_emails

Email addresses to receive job result notifications. Validated against tenant recipient rules.

Array<string>

max_email_rows

Max result rows in FULL_DATA emails for this job. Capped at tenant max_email_rows.

number

email_detail_level

Per-job email detail level override. Can only lower the tenant/workspace level, never raise it.

string

Allowed values: DISABLED STATUS_ONLY STAGE_SUMMARY FULL_DATA

stage_execution_strategy

required

string

default: DRILL_DOWN_ON_FAILURE

Allowed values: SEQUENTIAL PARALLEL DRILL_DOWN_ON_FAILURE

max_stage_concurrency

Maximum number of stages to run concurrently (only used when stage_execution_strategy is PARALLEL)

number

last_run_at

ISO-8601 timestamp of the most recent run of this job (any status). Server-computed; read-only.

string

last_run_status

Status of the most recent run of this job. Server-computed; read-only.

string

Allowed values: QUEUED RUNNING COMPLETED ERRORED CANCELLED

last_successful_run_at

ISO-8601 timestamp of the most recent successful (COMPLETED) run of this job. Server-computed; read-only.

string

404

Job not found or version mismatch