POST
/
{env_id}
/
{flow_id}
/
{tenant}
/
jobs
Run a V1 job
curl --request POST \
  --url https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/jobs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "state": {},
  "tap": "<string>",
  "job_name": "<string>",
  "override_start_date": "2023-11-07T05:31:56Z",
  "reset_source_state": true,
  "streaming_job": true,
  "override_selected_tables": {},
  "override_field_map": {},
  "override_end_date": "2023-11-07T05:31:56Z",
  "override_source_config": {},
  "override_target_config": {},
  "ignore_parallel_jobs": true,
  "environment_variables": {}
}'
{
  "job_id": "37g_DK",
  "env_id": "mydomain.hotglue.xyz",
  "flow_id": "l8odS2mce",
  "job_name": "l8odS2mce-chargebee-20220119-153011",
  "tenant": "12598713",
  "started_by": "12598713",
  "s3_root": "12598713/flows/l8odS2mce/jobs/2022/01/4/19/15/37g_DK",
  "start_time": "2022-01-19T15:30:11.731333+00:00",
  "state": {},
  "tap": "chargebee",
  "status": "JOB_CREATED",
  "scheduled_job": true,
  "message": "...",
  "last_updated": "2022-01-19T15:35:13.982380+00:00",
  "processed_rows": 0
}

Authorizations

x-api-key
string
header
required

Path Parameters

env_id
string
required

ID of environment

flow_id
string
required

ID of flow

tenant
string
required

ID of tenant

Body

application/json
state
object

Pass extra context to be used in the job. Often used with the unified schema for write jobs. Note that this is different from the source state.

tap
string

The source of the job. For write jobs, this is usually "api."

job_name
string

Name for job. If not provided, name is autogenerated

override_start_date
string<date-time>

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

reset_source_state
boolean

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

streaming_job
boolean

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

override_selected_tables
object

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_field_map
object

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

override_end_date
string<date-time>

Date to sync data until (e.g. 2022-08-08T00:00:00.000Z). Note that end_date is only supported for certain connectors.

override_source_config
object

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

override_target_config
object

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

ignore_parallel_jobs
boolean

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

environment_variables
object

Override environment variables for the job execution. Does not affect saved configuration.

Response

200

job_id
string
Example:

"37g_DK"

env_id
string
Example:

"mydomain.hotglue.xyz"

flow_id
string
Example:

"l8odS2mce"

job_name
string
Example:

"l8odS2mce-chargebee-20220119-153011"

tenant
string
Example:

12598713

started_by
string
Example:

12598713

s3_root
string
Example:

"12598713/flows/l8odS2mce/jobs/2022/01/4/19/15/37g_DK"

start_time
string
Example:

"2022-01-19T15:30:11.731333+00:00"

state
object
tap
string
Example:

"chargebee"

status
enum<string>
Available options:
JOB_CREATED,
DISCOVER_STARTED,
DISCOVER_FAILED,
SYNC_STARTED,
SYNC_FAILED,
SYNC_SUCCESS,
ETL_STARTED,
ETL_FAILED,
ETL_SUCCESS,
EXPORT_STARTED,
EXPORT_FAILED,
JOB_COMPLETED
Example:

"JOB_CREATED"

scheduled_job
boolean
default:true
Example:

true

message
string
Example:

"..."

last_updated
string
Example:

"2022-01-19T15:35:13.982380+00:00"

processed_rows
integer
default:0
Example:

0