curl --request POST \
--url https://client-api.hotglue.xyz/v2/{env_id}/{flow_id}/{tenant}/jobs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"connector_id": "<string>",
"job_type": "read",
"job_name": "<string>",
"override_start_date": "2023-12-25",
"override_end_date": "2023-12-25",
"reset_source_state": true,
"override_selected_tables": {},
"override_source_config": {},
"override_target_config": {},
"override_connector_config": {},
"override_field_map": {},
"environment_variables": {},
"state": "<string>",
"streaming_job": true,
"ignore_parallel_jobs": true
}'
{
"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
}
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.
curl --request POST \
--url https://client-api.hotglue.xyz/v2/{env_id}/{flow_id}/{tenant}/jobs \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"connector_id": "<string>",
"job_type": "read",
"job_name": "<string>",
"override_start_date": "2023-12-25",
"override_end_date": "2023-12-25",
"reset_source_state": true,
"override_selected_tables": {},
"override_source_config": {},
"override_target_config": {},
"override_connector_config": {},
"override_field_map": {},
"environment_variables": {},
"state": "<string>",
"streaming_job": true,
"ignore_parallel_jobs": true
}'
{
"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
}
ID of environment
ID of flow
ID of tenant
200
The response is of type object
.