HOhotglue

Poll job status

Changed on

Check on the status of a job using exactly one of job_root, job_id, or external_job_id. Read about the possible job statuses here.

get/{env_id}/{flow_id}/{tenant}/jobs/status

Request

Path parameters

env_idstring required

ID of environment

flow_idstring required

ID of flow

tenantstring required

ID of tenant

Query parameters

job_rootstring

S3 root of this job

job_idstring

ID of this job

external_job_idstring

External ID of this job

Response

200

job_idstring
env_idstring
job_namestring
tenantstring
started_bystring
flowstring
s3_rootstring
start_timestring
stateobject
tapstring
status'JOB_CREATED' | 'PROVISION_FAILED' | 'DISCOVER_STARTED' | 'DISCOVER_SUCCESS' | 'DISCOVER_FAILED' | 'SYNC_STARTED' | 'SYNC_FAILED' | 'SYNC_SUCCESS' | 'ETL_STARTED' | 'ETL_FAILED' | 'ETL_SUCCESS' | 'EXPORT_STARTED' | 'EXPORT_FAILED' | 'JOB_COMPLETED'
messagestring
last_updatedstring

Example response

{
  "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",
  "tap": "quickbooks:sandbox",
  "status": "ETL_FAILED",
  "message": "ETL error...",
  "last_updated": "2020-12-30T20:31:00.081282+00:00"
}

Changes

  • 00870a66a550Revision changes
    • warning

      added the new DISCOVER_SUCCESS enum value to the response property for the response status

    • warning

      added the new PROVISION_FAILED enum value to the response property for the response status

  • 90c0c21398ccRevision changes
    • info

      added the new optional query request parameter external_job_id

    • info

      added the new optional query request parameter job_id

    • info

      the query request parameter job_root became optional