REST API for Embedded Python Execution

Retrieve All Asynchronous Jobs

get

/py-scripts/v2/jobs

Retrieves the status, job id, elapsed time of the asynchronous jobs.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

List of asynchronous jobs.

Root Schema : JSONObject

Type: object

Show Source

empty: boolean

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

401 Response

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

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.

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"
        }
    }
}

Examples

The following example gets all the result 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/v2/jobs"

Response

The response body in JSON format is the following:

{
    "result": [
        {
            "createdDate": "2026-01-06 21:40:08 UTC",
            "job_id": "OML-EBPY-691b7220-64f8-489e-bc73-b6acbeafa8e5-2537b107-LOW-1767735602687_2026-01-06-09-40-07",
            "status": "FINISH",
            "elapsedTime": "00:00:22"
        }
    ]
}