Check Job Status Using Oracle Managed Storage

When the extract job is scheduled using the Job Scheduler API, the job status must be checked through the Job Scheduler service.

Use the job ID returned by the Job Scheduler API to retrieve the current execution status, completion details, and any failure information.

Endpoint

Attribute Value
URL /api/saas-batch/jobscheduler/v1/jobRequests/{{jobRequestId}}
HTTP Method GET

Response

Example Responses

Accepted / Enqueued

{
  "jobDetails": {
    "jobRequestId": 44046,
    "jobRequest": {
      "serviceName": "boss",
      "jobDefinitionName": "DataExport",
      "systemDerivedVersion": "1260",
      "jobSubmitter": "RODS_EXTRACTION_USER",
      "description": "ExtractMostLabels-Test-OMS::ExtractMostLabels::Full::Immediate",
      "requestParameters": {
        "submit.argument1": "ExtractMostLabels",
        "submit.argument2": "Full Data Extract"
      },
      "jobRetryNumber": 0,
      "timeoutThreshold": 36000,
      "type": "BATCH"
    },
    "jobStatus": "ENQUEUED",
    "jobProgress": {
      "jobRequestId": 44046,
      "status": "ENQUEUED",
      "message": "Job Request has been enqueued",
      "startTime": "2025-12-18T07:38:58Z",
      "endTime": "2025-12-18T07:38:59Z",
      "completedPercentage": "0",
      "completed": false
    }
  }
}

Running

{
  "jobDetails": {
    "jobRequestId": 44046,
    "jobStatus": "RUNNING",
    "jobProgress": {
      "status": "RUNNING",
      "message": "Job status is changed to RUNNING",
      "completedPercentage": "50",
      "completed": false
    }
  }
}

In Progress

{
  "jobDetails": {
    "jobRequestId": 31682,
    "jobStatus": "IN_PROGRESS",
    "jobProgress": {
      "status": "IN_PROGRESS",
      "message": "Job Request is in progress",
      "completedPercentage": "0",
      "completed": false
    }
  }
}

Successfully Completed

{
  "jobDetails": {
    "jobRequestId": 31664,
    "jobStatus": "SUCCEEDED",
    "jobProgress": {
      "status": "SUCCEEDED",
      "message": "Job status is changed to SUCCEEDED",
      "completedPercentage": "100",
      "completed": true
    }
  }
}

Job Status Values

A job request is considered successfully completed when:
  • jobDetails.jobProgress.completed: true
  • jobDetails.jobProgress.status: SUCCEEDED
A job request is considered failed when:
  • jobDetails.jobProgress.status: FAILED

In this case, the jobDetails.jobProgress.message attribute contains the error message.