POST
/
{env_id}
/
{flow_id}
/
{tenant}
/
jobs
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-12-25",
  "reset_source_state": true,
  "override_selected_tables": {},
  "override_field_map": {}
}'
{
  "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
headerrequired

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

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.

Response

200 - application/json
job_id
string
env_id
string
flow_id
string
job_name
string
tenant
string
started_by
string
s3_root
string
start_time
string
state
object
tap
string
status
string
scheduled_job
boolean
default: true
message
string
last_updated
string
processed_rows
integer
default: 0
IntroductionSupported sources