v2

latestOpenAPI 3.1.02026-07-31822441.6 KB

Run a V2 Job

Kicks off a job for a given tenant. Can be used to write data in target flows by passing a payload in the state object. When queue_if_active_job is set to true in the request body, hotglue queues the job if another job is already running for the same tenant or flow.

post/v2/{env_id}/{flow_id}/{tenant}/jobs

Path parameters

env_idstring required

ID of environment

flow_idstring required

ID of flow

tenantstring required

ID of tenant

Request body

connector_idstring required

The ID of the connector to run a job for. Note that in V2 flows, you do not pass a tap or target

job_type'read' | 'write' required

The schedule expression to sync on

job_namestring

Name for job. If not provided, name is autogenerated

override_start_datestring date

Date to start syncing data from (e.g. 2022-08-08T00:00:00.000Z)

override_end_datestring date

Date to sync data until. Only supported on some connectors. (e.g. 2022-08-10T00:00:00.000Z)

reset_source_stateboolean

Runs the job as a "full_sync" by clearing the state on the linkedSource

override_selected_tablesobject

For use with the unified schema. Define a temporary selection of unified schema objects to override the default selection. Does not affect your selection for future jobs. E.G. {"Vendors":true}

override_source_configobject

Override the source connector configuration for this job only. Does not affect the saved configuration.

override_target_configobject

Override the target connector configuration for this job only. Does not affect the saved configuration.

override_connector_configobject

Override the bidirectional connector-level configuration for this job only.

override_field_mapobject

Define a temporary field map to be used in the job, different from the configured field map.

environment_variablesobject

Override environment variables for the job execution.

stateobject

Optional extra context to be used by the job. Often used for write jobs. Note that this is different from the source state.

streaming_jobboolean

If true, the job will run in streaming mode and skip the ETL step. This feature is in beta.

ignore_parallel_jobsboolean

If true, the job will ignore restrictions on parallel job execution for this connector.

queue_if_active_jobboolean

If set to true, queues the job when another job is already running for the same tenant or flow. If omitted or set to false, the API returns an error when an active job blocks creation.

Response

200

job_idstring

env_idstring

flow_idstring

job_namestring

tenantstring

started_bystring

s3_rootstring

start_timestring

stateobject

tapstring

scheduled_jobboolean

messagestring

last_updatedstring

processed_rowsinteger

Example response

{
  "job_id": "37g_DK",
  "env_id": "mydomain.hotglue.xyz",
  "flow_id": "l8odS2mce",
  "job_name": "l8odS2mce-chargebee-20220119-153011",
  "s3_root": "12598713/flows/l8odS2mce/jobs/2022/01/4/19/15/37g_DK",
  "start_time": "2022-01-19T15:30:11.731333+00:00",
  "tap": "chargebee",
  "status": "JOB_CREATED",
  "scheduled_job": true,
  "message": "...",
  "last_updated": "2022-01-19T15:35:13.982380+00:00"
}