Jobs

post
Create a job

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/jobs
This endpoint creates a new job and queues it for execution.
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Body Parameters
state
optional
object
Any extra state information to pass
tap
optional
string
Tap to sync
job_name
optional
string
Name for job. If not provided, name is autogenerated
Response
200: OK
Job queued.
{
"job_id": "kIhYt"
}

get
Get jobs

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/jobs
This endpoint returns most recent jobs, sorted.
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Response
200: OK
List of jobs
[{
"job_id": "lmaEbA",
"env_id": "dev.example-env.hotglue.xyz",
"job_name": "test_job:_V-vgdlLN",
"tenant": "default",
"started_by": "default",
"flow": "l8odS2mce",
"s3_root": "default/flows/l8odS2mce/jobs/lmaEbA",
"start_time": "2020-12-30T18:01:01.828266+00:00",
"state": {},
"tap": "quickbooks:sandbox",
"status": "ETL_FAILED",
"message": "ETL error...",
"last_updated": "2020-12-30T20:31:00.081282+00:00"
}]

get
Get latest job

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/jobs/latest
This endpoint returns the most recent job this tenant ran for this flow
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Response
200: OK
Most recent job
{
"job_id": "lmaEbA",
"env_id": "dev.example-env.hotglue.xyz",
"job_name": "test_job:_V-vgdlLN",
"tenant": "default",
"started_by": "default",
"flow": "l8odS2mce",
"s3_root": "default/flows/l8odS2mce/jobs/lmaEbA",
"start_time": "2020-12-30T18:01:01.828266+00:00",
"state": {},
"tap": "quickbooks:sandbox",
"status": "ETL_FAILED",
"message": "ETL error...",
"last_updated": "2020-12-30T20:31:00.081282+00:00"
}

get
Get job status

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/jobs/status
This endpoint returns the status for specified job
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Query Parameters
job_root
optional
string
S3 root of this job
Response
200: OK
The job state
{
"job_id": "lmaEbA",
"env_id": "dev.example-env.hotglue.xyz",
"job_name": "test_job:_V-vgdlLN",
"tenant": "default",
"started_by": "default",
"flow": "l8odS2mce",
"s3_root": "default/flows/l8odS2mce/jobs/lmaEbA",
"start_time": "2020-12-30T18:01:01.828266+00:00",
"state": {},
"tap": "quickbooks:sandbox",
"status": "ETL_FAILED",
"message": "ETL error...",
"last_updated": "2020-12-30T20:31:00.081282+00:00"
}
500: Internal Server Error
If invalid params provided an error object is returned
{
"Code": "Error",
"Message": "Invalid job_root supplied - job does not exist!"
}

post
Rollback to job

https://client-api.hotglue.xyz/{env_id}/{flow_id}/{tenant}/jobs/rollback
This endpoint rolls the tenant state back to before this job ran
Request
Response
Request
Path Parameters
env_id
required
string
ID of environment
flow_id
required
string
ID of flow
tenant
required
string
ID of tenant
Headers
x-api-key
required
string
API key
Body Parameters
job_root
required
string
S3 root for job
tap
required
string
ID of tap
job_id
required
string
ID of job
Response
200: OK
Rollback success
{
"Code": "Success"
}