OMomni
Jobs

Get job status

<Note> Currently, this endpoint only supports schema refresh jobs. Job IDs from other job types will return an error. </Note>

Retrieves the current status of an asynchronous job. The user authenticating the request must have read permissions on the connection.

This endpoint is used to check the status of jobs initiated by other API calls, such as schema refreshes. Poll this endpoint to determine when the job has completed.

get/v1/jobs/{jobId}/status

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/jobs/{jobId}/status
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The job ID returned from an asynchronous operation such as Refresh schema

Response

Job status retrieved successfully

job_typestring

The type of job

job_idstring uuid

The unique identifier of the job

status'RUNNING' | 'COMPLETED' | 'FAILED'

Current status of the job

Example response

{
  "job_type": "refresh_schema"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.