Jump to

• Request
• Response
• Examples

Retrieve Asynchronous Job Status

get

/py-scripts/v1/jobs/{jobId}

Retrieves the status of the asynchronous job.

Request

Path Parameters

• jobId(required): string
  The id of the asynchronous job

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Job is still pending.

Body ()

Root Schema : JSONObject

Type: object

Show Source

• empty: boolean

{
    "type":"object",
    "properties":{
        "empty":{
            "type":"boolean"
        }
    }
}

302 Response

Returns the Content-Location header where the result of the job can be fetched.

Headers

• Content-Location:

401 Response

When the user doesn't have privileges to perform the action.

Body ()

Root Schema : UnauthorizedException

Type: object

Show Source

• errorCode(required): integer (int64)
• errorMessage: string

{
    "type":"object",
    "required":[
        "debug",
        "errorCode"
    ],
    "properties":{
        "errorMessage":{
            "type":"string"
        },
        "errorCode":{
            "type":"integer",
            "format":"int64"
        }
    }
}

500 Response

Problem connecting to Broker, finding the job id or other unexpected error.

Body ()

Root Schema : ComputeContainerException

Type: object

Show Source

• errorCode(required): integer (int64)
• errorMessage: string

{
    "type":"object",
    "required":[
        "debug",
        "errorCode"
    ],
    "properties":{
        "errorMessage":{
            "type":"string"
        },
        "errorCode":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Back to Top

Examples

The following example gets the status of an asynchronous job.

curl -i -X GET --header "Authorization: Bearer ${token}" \
--header 'Accept: application/json' \
"<oml-cloud-service-location-url>/oml/api/py-scripts/v1/jobs/<job id>"

Response Headers

• Response status 202: The HTTP response status 202 indicates the job is found and it is pending.

  HTTP/2 202 
  date: Wed, 12 Mar 2025 23:09:20 GMT
  content-type: application/json
  content-length: 93
  strict-transport-security: max-age=31536000; includeSubDomains
  x-content-type-options: nosniff
  cache-control: no-cache, no-store, must-revalidate
  pragma: no-cache
  x-frame-options: SAMEORIGIN
  x-xss-protection: 1;mode=block
  content-security-policy: default-src 'none'; connect-src 'self'; font-src 'self' static.oracle.com; img-src 'self' data: static.oracle.com; media-src 'none'; object-src 'none'; script-src 'self' static.oracle.com 'unsafe-inline' 'unsafe-eval'; style-src 'self' static.oracle.com 'unsafe-inline'; frame-ancestors 'none'
   
  {"createdDate":" Mar 12,2025 22:55","status":"job is still running","elapsedTime":"00:13:32"}

• Response status 302: The HTTP response status 302 indicates the job is found and includes a job id for the results.

  HTTP/1.1 302 Found
  Date: Thu, 27 Aug 2020 15:14:26 GMT
  Content-Length: 0
  Connection: keep-alive
  Cache-Control: no-cache, no-store, private
  X-Frame-Options: SAMEORIGIN
  X-XSS-Protection: 1;mode=block
  Strict-Transport-Security: max-age=31536000; includeSubDomains
  X-Content-Type-Options: nosniff
  Content-Location:
  <oml_users-cloud-service-location-url>/oml/api/py-scripts/v1/jobs/<job id>/result

Back to Top