Jump to

• Request
• Response

Get list of jobs

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/jobs

Returns a list of jobs for a given AI Data Platform Workbench.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• workspaceKey(required): string
  The key of the Workspace

Query Parameters

• createdBy: string
  A filter to return only resources that are created by given user with username that matches exactly.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that match the given display name exactly.
• displayNameContains: string
  A filter to return only resources that have a display name containing the text provided.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• path: string
  The fully qualified path where the job is stored.
• sortBy: string
  The field to sort by. You can provide only one sort order. Default order for `timeCreated` is descending. Default order for `displayName` is ascending.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated", "displayName", "status" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]
• updatedBy: string
  A filter to return only resources that was last updated by given user with username that matches exactly.

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Headers

• opc-next-page: string
  For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• opc-prev-page: string
  For list pagination. When this header appears in the response, previous pages of results remain.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• opc-total-items: integer
  For list pagination. This header provides total number of items available.

Body ()

Root Schema : JobCollection

Type: object

List of jobs.

Show Source

• items(required): array items
  List of jobs.

{
    "description":"List of jobs.",
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of jobs.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/JobSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of jobs.

Show Source

• Array of: object JobSummary
  Summary information about a job.

{
    "description":"List of jobs.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/JobSummary"
    }
}

Nested Schema : JobSummary

Type: object

Summary information about a job.

Show Source

• clusters: array clusters
  List of job cluster keys.
• createdBy: string
  The OCID of the IAM user.
• createdByName: string
  Name of the user who created this record
• jobClusters: array jobClusters
  Maximum Number of Items: 100

  List of job cluster configurations.
• key(required): string
  The OCID of the job.
• name: string
  A user-friendly name. Does not have to be unique, and is changeable.
• path: string
  The path to store the job definition in.
• runAs: string
  The id with which the job run as.
• schedule: object Schedule
  The schedule configuration for the job.
• timeCreated: string(date-time)
  The date and time the DataLake was created, in the format defined by RFC 3339. Example: `2025-05-25T21:10:29.600Z`
• timeUpdated: string(date-time)
  The date and time the DataLake was updated, in the format defined by RFC 3339. Example: `2025-05-25T21:10:29.600Z`
• updatedBy: string
  The OCID of the IAM user.
• updatedByName: string
  The username of the latest updater.

{
    "description":"Summary information about a job.",
    "type":"object",
    "required":[
        "key"
    ],
    "properties":{
        "key":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "createdBy":{
            "description":"The OCID of the IAM user.",
            "type":"string"
        },
        "createdByName":{
            "description":"Name of the user who created this record",
            "type":"string"
        },
        "updatedBy":{
            "description":"The OCID of the IAM user.",
            "type":"string"
        },
        "updatedByName":{
            "description":"The username of the latest updater.",
            "type":"string"
        },
        "name":{
            "description":"A user-friendly name. Does not have to be unique, and is changeable.",
            "type":"string"
        },
        "path":{
            "description":"The path to store the job definition in.",
            "type":"string"
        },
        "schedule":{
            "$ref":"#/definitions/Schedule"
        },
        "runAs":{
            "description":"The id with which the job run as.",
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the DataLake was created, in the format defined by <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\nExample: `2025-05-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The date and time the DataLake was updated, in the format defined by <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\nExample: `2025-05-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "clusters":{
            "description":"List of job cluster keys.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "jobClusters":{
            "description":"List of job cluster configurations.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/JobCluster"
            }
        }
    }
}

Nested Schema : clusters

Type: array

List of job cluster keys.

Show Source

• Array of: string

{
    "description":"List of job cluster keys.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : jobClusters

Type: array

Maximum Number of Items: 100

List of job cluster configurations.

Show Source

• Array of: object JobCluster
  The cluster configuration that can be shared by tasks in the job.

{
    "description":"List of job cluster configurations.",
    "type":"array",
    "maxItems":100,
    "items":{
        "$ref":"#/definitions/JobCluster"
    }
}

Nested Schema : Schedule

Type: object

The schedule configuration for the job.

Show Source

• pauseStatus: string
  Default Value: UNPAUSED

  Allowed Values: [ "PAUSED", "UNPAUSED" ]

  Indicates whether the schedule is paused or not.
• quartzCronExpression(required): string
  A cron expression using Quartz syntax that describes the schedule for a job.
• timezoneId(required): string
  A Java timezone ID. The schedule of the job is resolved with respect to this timezone. Example - US/Pacific.

{
    "description":"The schedule configuration for the job.",
    "type":"object",
    "required":[
        "quartzCronExpression",
        "timezoneId"
    ],
    "properties":{
        "quartzCronExpression":{
            "description":"A cron expression using Quartz syntax that describes the schedule for a job.",
            "type":"string"
        },
        "timezoneId":{
            "description":"A Java timezone ID. The schedule of the job is resolved with respect to this timezone. Example - US/Pacific.",
            "type":"string"
        },
        "pauseStatus":{
            "description":"Indicates whether the schedule is paused or not.",
            "type":"string",
            "enum":[
                "PAUSED",
                "UNPAUSED"
            ],
            "default":"UNPAUSED"
        }
    }
}

Nested Schema : JobCluster

Type: object

The cluster configuration that can be shared by tasks in the job.

Show Source

• clusterKey: string
  Minimum Length: 1

  Maximum Length: 100

  A unique identifier for the job cluster.
• clusterName: string
  Minimum Length: 1

  Maximum Length: 100

  A unique name for the job cluster.
• newCluster: object NewClusterConfiguration
  The cluster configuration to create a new cluster.

{
    "description":"The cluster configuration that can be shared by tasks in the job.",
    "type":"object",
    "properties":{
        "clusterKey":{
            "description":"A unique identifier for the job cluster.",
            "type":"string",
            "minLength":1,
            "maxLength":100
        },
        "clusterName":{
            "description":"A unique name for the job cluster.",
            "type":"string",
            "minLength":1,
            "maxLength":100
        },
        "newCluster":{
            "$ref":"#/definitions/NewClusterConfiguration"
        }
    }
}

Nested Schema : NewClusterConfiguration

Type: object

The cluster configuration to create a new cluster.

Show Source

• autoScale: object AutoScale
  Properties required to automatically scale the clusters up and down based on load.
• clusterName: string
  Minimum Length: 1

  Maximum Length: 100

  A unique name for the job cluster.
• numWorkers: integer(int32)
  Number of worker nodes configured for this cluster.
• sparkConf: string
  The spark configuration in key-value pairs.
• sparkVersion: string
  The Spark version used to run the application.

{
    "description":"The cluster configuration to create a new cluster.",
    "type":"object",
    "properties":{
        "numWorkers":{
            "description":"Number of worker nodes configured for this cluster.",
            "type":"integer",
            "format":"int32"
        },
        "autoScale":{
            "$ref":"#/definitions/AutoScale"
        },
        "clusterName":{
            "description":"A unique name for the job cluster.",
            "type":"string",
            "minLength":1,
            "maxLength":100
        },
        "sparkVersion":{
            "description":"The Spark version used to run the application.",
            "type":"string"
        },
        "sparkConf":{
            "description":"The spark configuration in key-value pairs.",
            "type":"string"
        }
    }
}

Nested Schema : AutoScale

Type: object

Properties required to automatically scale the clusters up and down based on load.

Show Source

• maxWorkers: integer(int32)
  The maximum number of workers to which the cluster can scale up when overloaded.
• minWorkers: integer(int32)
  The minimum number of workers to which the cluster can scale down when underused.

{
    "description":"Properties required to automatically scale the clusters up and down based on load.",
    "type":"object",
    "properties":{
        "minWorkers":{
            "description":"The minimum number of workers to which the cluster can scale down when underused.",
            "type":"integer",
            "format":"int32"
        },
        "maxWorkers":{
            "description":"The maximum number of workers to which the cluster can scale up when overloaded.",
            "type":"integer",
            "format":"int32"
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top