Jump to

• Request
• Response

Create a job run

post

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

Creates a job run for an 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

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.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.
• should-update-recent: boolean
  A flag to identify if the recent list should be updated.

  Default Value: false

Body ()

Details for the new job run.

Root Schema : CreateJobRunDetails

Type: object

The data to create a job run.

Show Source

• jobKey(required): string
  The OCID of the job.
• key: string
  The OCID of the job.
• originalAttemptRunId: string
  The OCID of the job.
• parameters: array parameters
  An optional list of parameters.
• queue: object Queue
  Queue configuration for job.
• repairHistory: array repairHistory
  Maximum Number of Items: 10

  Array of repaired runs.
• schedule: object Schedule
  The schedule configuration for the job.

{
    "description":"The data to create a job run.",
    "type":"object",
    "required":[
        "jobKey"
    ],
    "properties":{
        "key":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "jobKey":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "originalAttemptRunId":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "schedule":{
            "$ref":"#/definitions/Schedule"
        },
        "parameters":{
            "description":"An optional list of parameters.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Parameter"
            }
        },
        "queue":{
            "$ref":"#/definitions/Queue"
        },
        "repairHistory":{
            "description":"Array of repaired runs.",
            "type":"array",
            "maxItems":10,
            "items":{
                "$ref":"#/definitions/RepairHistory"
            }
        }
    }
}

Nested Schema : parameters

Type: array

An optional list of parameters.

Show Source

• Array of: object Parameter
  Specifies the name and value of the defined parameter.

{
    "description":"An optional list of parameters.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Parameter"
    }
}

Nested Schema : Queue

Type: object

Queue configuration for job.

Show Source

• isEnabled(required): boolean
  Default Value: false

  True if job queue is enabled.

{
    "description":"Queue configuration for job.",
    "type":"object",
    "required":[
        "isEnabled"
    ],
    "properties":{
        "isEnabled":{
            "description":"True if job queue is enabled.",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : repairHistory

Type: array

Maximum Number of Items: 10

Array of repaired runs.

Show Source

• Array of: object RepairHistory
  A description of a repaired job run.

{
    "description":"Array of repaired runs.",
    "type":"array",
    "maxItems":10,
    "items":{
        "$ref":"#/definitions/RepairHistory"
    }
}

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 : Parameter

Type: object

Specifies the name and value of the defined parameter.

Show Source

• name(required): string
  Pattern: ^[\w\-.]+$

  The name of the defined parameter. May only contain alphanumeric characters, '_', '-', and '.'
• value: string
  Value of the defined parameter.

{
    "description":"Specifies the name and value of the defined parameter.",
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"The name of the defined parameter. May only contain alphanumeric characters, '_', '-', and '.'",
            "type":"string",
            "pattern":"^[\\w\\-.]+$"
        },
        "value":{
            "description":"Value of the defined parameter.",
            "type":"string"
        }
    }
}

Nested Schema : RepairHistory

Type: object

A description of a repaired job run.

Show Source

• endTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.
• executionDuration: integer(int64)
  The time (in milliseconds) taken to complete the job execution.
• key: integer(int32)
  The unique ID of the Repair run.
• lifecycleStates: array lifecycleStates
  The collection of lifecycle states.
• parameters: array parameters
  An optional list of parameters.
• repairedTasks: array repairedTasks
  A list of repaired tasks.
• startTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.
• state: object State
  The current state of the run.
• taskToTaskRunMap: object taskToTaskRunMap
  Additional Properties Allowed: additionalProperties

  Task to TaskRun map for given job run.
• type: string
  Allowed Values: [ "ORIGINAL", "REPAIR" ]

  Indicates whether the job run is Original or Repaired.

{
    "description":"A description of a repaired job run.",
    "properties":{
        "type":{
            "description":"Indicates whether the job run is Original or Repaired.",
            "type":"string",
            "enum":[
                "ORIGINAL",
                "REPAIR"
            ]
        },
        "key":{
            "description":"The unique ID of the Repair run.",
            "type":"integer",
            "format":"int32"
        },
        "state":{
            "$ref":"#/definitions/State"
        },
        "startTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "endTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "taskToTaskRunMap":{
            "description":"Task to TaskRun map for given job run.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "parameters":{
            "description":"An optional list of parameters.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Parameter"
            }
        },
        "repairedTasks":{
            "type":"array",
            "description":"A list of repaired tasks.",
            "items":{
                "type":"string"
            }
        },
        "lifecycleStates":{
            "type":"array",
            "description":"The collection of lifecycle states.",
            "items":{
                "$ref":"#/definitions/LifecycleState"
            }
        },
        "executionDuration":{
            "description":"The time (in milliseconds) taken to complete the job execution.",
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : lifecycleStates

Type: array

The collection of lifecycle states.

Show Source

• Array of: object LifecycleState
  The lifecycle state of execution.

{
    "type":"array",
    "description":"The collection of lifecycle states.",
    "items":{
        "$ref":"#/definitions/LifecycleState"
    }
}

Nested Schema : parameters

Type: array

An optional list of parameters.

Show Source

• Array of: object Parameter
  Specifies the name and value of the defined parameter.

{
    "description":"An optional list of parameters.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Parameter"
    }
}

Nested Schema : repairedTasks

Type: array

A list of repaired tasks.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of repaired tasks.",
    "items":{
        "type":"string"
    }
}

Nested Schema : State

Type: object

The current state of the run.

Show Source

• errorTrace: string
  If there was an error executing the run, this field contains any available stack traces.
• isUserCanceledOrTimedOut: boolean
  Default Value: false

  Set to true, if the job execution is canceled by the user or by the scheduler due to timeout.
• stateMessage: string
  A descriptive message of the current state.
• status: string
  Allowed Values: [ "PENDING", "QUEUED", "RUNNING", "SKIPPED", "INTERNAL_ERROR", "BLOCKED", "SUCCESS", "FAILED", "CANCELING", "CANCELED", "UPSTREAM_CANCELED", "UPSTREAM_FAILED", "EXCLUDED", "TIMED_OUT", "PAUSED_MAINTENANCE" ]

  Current state of execution.

{
    "description":"The current state of the run.",
    "type":"object",
    "properties":{
        "status":{
            "description":"Current state of execution.",
            "type":"string",
            "enum":[
                "PENDING",
                "QUEUED",
                "RUNNING",
                "SKIPPED",
                "INTERNAL_ERROR",
                "BLOCKED",
                "SUCCESS",
                "FAILED",
                "CANCELING",
                "CANCELED",
                "UPSTREAM_CANCELED",
                "UPSTREAM_FAILED",
                "EXCLUDED",
                "TIMED_OUT",
                "PAUSED_MAINTENANCE"
            ]
        },
        "stateMessage":{
            "description":"A descriptive message of the current state.",
            "type":"string"
        },
        "errorTrace":{
            "description":"If there was an error executing the run, this field contains any available stack traces.",
            "type":"string"
        },
        "isUserCanceledOrTimedOut":{
            "description":"Set to true, if the job execution is canceled by the user or by the scheduler due to timeout.",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : taskToTaskRunMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Task to TaskRun map for given job run.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Task to TaskRun map for given job run.

Nested Schema : LifecycleState

Type: object

The lifecycle state of execution.

Match All

The lifecycle state of execution.

The lifecycle state of execution.

The lifecycle state of execution.

Show Source

• object State
  The current state of the run.
• object LifecycleState-allOf[1]
• object LifecycleState-allOf[2]

{
    "description":"The lifecycle state of execution.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/State"
        },
        {
            "type":"object"
        },
        {
            "properties":{
                "startTime":{
                    "description":"The time at which the job execution started in epoch milliseconds.",
                    "type":"integer",
                    "format":"int64"
                },
                "endTime":{
                    "description":"The time at which the job execution started in epoch milliseconds.",
                    "type":"integer",
                    "format":"int64"
                }
            }
        }
    ]
}

Nested Schema : LifecycleState-allOf[1]

Type: object

Nested Schema : LifecycleState-allOf[2]

Type: object

Show Source

• endTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.
• startTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.

{
    "properties":{
        "startTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "endTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Request accepted. Job run is created.

Headers

• content-location: string(uri-reference)
  Same as location.
• etag: string
  For optimistic concurrency control. See `if-match`.
• location: string(uri-reference)
  URL for the created job run. The job run key is generated after this request is sent.
• 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-work-request-id: string
  The OCID of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request.

Body ()

Root Schema : JobRun

Type: object

Description of a job run.

Show Source

• cleanupDuration: integer(int64)
  The time (in milliseconds) taken to terminate the cluster and to clean up any associated artifacts.
• clusterInstance: object ClusterInstance
  The cluster used for this run. The value of this field will be set when a new cluster is specified for execution and once the request to create a new cluster is successfully submitted.
• clusterSpec: object ClusterSpec
  Cluster specification snapshot of a job.
• createdBy: string
  The OCID of the IAM user.
• createdByName: string
  Name of the user who created this record
• endTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.
• executionDuration: integer(int64)
  The time (in milliseconds) taken to complete the job execution.
• gitConfig: object GitConfig
  Git configuration used when source is GIT_PROVIDER.
• jobKey(required): string
  The OCID of the job.
• jobName: string
  A user-friendly name. Does not have to be unique, and is changeable.
• key(required): string
  The OCID of the job.
• launched: string
  Default Value: MANUAL

  Allowed Values: [ "SCHEDULED", "MANUAL" ]

  Identify job run launched by schedule or manually.
• lifecycleStates: array lifecycleStates
  The collection of lifecycle states.
• maxConcurrentRuns: integer(int32)
  Minimum Value: 0

  Maximum Value: 1000

  Default Value: 1

  Indicates the number of executions for the same job that can be run concurrently. The maximum value cannot exceed 1000.
• name(required): string
  A user-friendly name. Does not have to be unique, and is changeable.
• originalAttemptRunId: string
  The OCID of the job.
• parameters: array parameters
  An optional list of parameters.
• parentJobRunKey: string
  The OCID of the job.
• parentTaskRunKey: string
  The OCID of the task run.
• queue: object Queue
  Queue configuration for job.
• repairedTasks: array repairedTasks
  A list of repaired tasks.
• repairHistory: array repairHistory
  Maximum Number of Items: 10

  Array of repaired runs.
• rootJobRunKey: string
  The OCID of the job.
• runDuration: integer(int64)
  The time (in milliseconds) taken to complete the job execution and all its repairs to finish.
• schedule: object Schedule
  The schedule configuration for the job.
• setupDuration: integer(int64)
  The time (in milliseconds) taken to setup the cluster.
• startTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.
• state: object State
  The current state of the run.
• systemParameters: object systemParameters
  Additional Properties Allowed: additionalProperties

  Map of system parameters with their values for this job run.
• taskRunSummaryMap: object taskRunSummaryMap
  Additional Properties Allowed: additionalProperties

  TaskRun to TaskRunSummary map for given job run.
• tasks: array tasks
  List of tasks in a job.
• taskToTaskRunMap: object taskToTaskRunMap
  Additional Properties Allowed: additionalProperties

  Task to TaskRun map for given job run.
• timeCreated: string(date-time)
  The time at which the job execution started.
• timeoutSeconds: integer(int32)
  Minimum Value: 60

  Maximum Value: 172800

  Default Value: 0

  An optional value to indicate the max run duration of a job after which job will be timed out. The default is Zero indicating no timeout value.
• timeUpdated: string(date-time)
  The time at which the job execution was updated.
• unifiedJobAndJobRunParameters: array unifiedJobAndJobRunParameters
  Unified List of job and job run parameters after resolving dynamic value references and parameter resolution as per precedence.
• version: integer(int32)
  Current version of job run object in repository.

{
    "description":"Description of a job run.",
    "type":"object",
    "required":[
        "key",
        "name",
        "jobKey"
    ],
    "properties":{
        "key":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "name":{
            "description":"A user-friendly name. Does not have to be unique, and is changeable.",
            "type":"string"
        },
        "jobKey":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "jobName":{
            "description":"A user-friendly name. Does not have to be unique, and is changeable.",
            "type":"string"
        },
        "parentJobRunKey":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "rootJobRunKey":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "parentTaskRunKey":{
            "description":"The OCID of the task run.",
            "type":"string"
        },
        "tasks":{
            "description":"List of tasks in a job.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Task"
            }
        },
        "createdBy":{
            "description":"The OCID of the IAM user.",
            "type":"string"
        },
        "createdByName":{
            "description":"Name of the user who created this record",
            "type":"string"
        },
        "maxConcurrentRuns":{
            "description":"Indicates the number of executions for the same job that can be run concurrently. The maximum value cannot exceed 1000.",
            "type":"integer",
            "format":"int32",
            "minimum":0,
            "maximum":1000,
            "default":1
        },
        "gitConfig":{
            "$ref":"#/definitions/GitConfig"
        },
        "queue":{
            "$ref":"#/definitions/Queue"
        },
        "originalAttemptRunId":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "state":{
            "$ref":"#/definitions/State"
        },
        "schedule":{
            "$ref":"#/definitions/Schedule"
        },
        "clusterSpec":{
            "$ref":"#/definitions/ClusterSpec"
        },
        "clusterInstance":{
            "$ref":"#/definitions/ClusterInstance"
        },
        "parameters":{
            "description":"An optional list of parameters.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Parameter"
            }
        },
        "unifiedJobAndJobRunParameters":{
            "description":"Unified List of job and job run parameters after resolving dynamic value references and parameter resolution as per precedence.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Parameter"
            }
        },
        "repairHistory":{
            "description":"Array of repaired runs.",
            "type":"array",
            "maxItems":10,
            "items":{
                "$ref":"#/definitions/RepairHistory"
            }
        },
        "systemParameters":{
            "description":"Map of system parameters with their values for this job run.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "startTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "endTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "setupDuration":{
            "description":"The time (in milliseconds) taken to setup the cluster.",
            "type":"integer",
            "format":"int64"
        },
        "executionDuration":{
            "description":"The time (in milliseconds) taken to complete the job execution.",
            "type":"integer",
            "format":"int64"
        },
        "cleanupDuration":{
            "description":"The time (in milliseconds) taken to terminate the cluster and to clean up any associated artifacts.",
            "type":"integer",
            "format":"int64"
        },
        "runDuration":{
            "description":"The time (in milliseconds) taken to complete the job execution and all its repairs to finish.",
            "type":"integer",
            "format":"int64"
        },
        "timeCreated":{
            "description":"The time at which the job execution started.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time at which the job execution was updated.",
            "type":"string",
            "format":"date-time"
        },
        "launched":{
            "description":"Identify job run launched by schedule or manually.",
            "type":"string",
            "enum":[
                "SCHEDULED",
                "MANUAL"
            ],
            "default":"MANUAL"
        },
        "version":{
            "description":"Current version of job run object in repository.",
            "type":"integer",
            "format":"int32"
        },
        "taskToTaskRunMap":{
            "description":"Task to TaskRun map for given job run.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "taskRunSummaryMap":{
            "description":"TaskRun to TaskRunSummary map for given job run.",
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "timeoutSeconds":{
            "description":"An optional value to indicate the max run duration of a job after which job will be timed out. The default is Zero indicating no timeout value.",
            "type":"integer",
            "format":"int32",
            "minimum":60,
            "maximum":172800,
            "default":0
        },
        "repairedTasks":{
            "type":"array",
            "description":"A list of repaired tasks.",
            "items":{
                "type":"string"
            }
        },
        "lifecycleStates":{
            "type":"array",
            "description":"The collection of lifecycle states.",
            "items":{
                "$ref":"#/definitions/LifecycleState"
            }
        }
    }
}

Nested Schema : ClusterInstance

Type: object

The cluster used for this run. The value of this field will be set when a new cluster is specified for execution and once the request to create a new cluster is successfully submitted.

Show Source

• clusterKey: string
  The cluster key for the cluster configuration on which the job is executed.
• sparkContextKey: string
  The spark context used in the job run.

{
    "description":"The cluster used for this run.\nThe value of this field will be set when a new cluster is specified for execution and once the request to create a new cluster is successfully submitted.\n",
    "type":"object",
    "properties":{
        "clusterKey":{
            "description":"The cluster key for the cluster configuration on which the job is executed.",
            "type":"string"
        },
        "sparkContextKey":{
            "description":"The spark context used in the job run.",
            "type":"string"
        }
    }
}

Nested Schema : ClusterSpec

Type: object

Cluster specification snapshot of a job.

Show Source

• existingClusterKey: string
  The key of the cluster.
• libraries: object Libraries
  List of libraries to be installed on the cluster.
• newCluster: object NewClusterConfiguration
  The cluster configuration to create a new cluster.

{
    "description":"Cluster specification snapshot of a job.",
    "type":"object",
    "properties":{
        "existingClusterKey":{
            "description":"The key of the cluster.",
            "type":"string"
        },
        "newCluster":{
            "$ref":"#/definitions/NewClusterConfiguration"
        },
        "libraries":{
            "$ref":"#/definitions/Libraries"
        }
    }
}

Nested Schema : GitConfig

Type: object

Git configuration used when source is GIT_PROVIDER.

Show Source

• branch: string
  Git branch path.
• credential: string
  Git credential to access the repository.
• provider: string
  Allowed Values: [ "GITHUB", "BITBUCKET", "GITLAB", "OCI_DEVOPS" ]

  Git provider.
• repositoryUrl: string
  Git repository URL.

{
    "description":"Git configuration used when source is GIT_PROVIDER.",
    "type":"object",
    "properties":{
        "provider":{
            "description":"Git provider.",
            "type":"string",
            "enum":[
                "GITHUB",
                "BITBUCKET",
                "GITLAB",
                "OCI_DEVOPS"
            ]
        },
        "credential":{
            "description":"Git credential to access the repository.",
            "type":"string"
        },
        "repositoryUrl":{
            "description":"Git repository URL.",
            "type":"string"
        },
        "branch":{
            "description":"Git branch path.",
            "type":"string"
        }
    }
}

Nested Schema : lifecycleStates

Type: array

The collection of lifecycle states.

Show Source

• Array of: object LifecycleState
  The lifecycle state of execution.

{
    "type":"array",
    "description":"The collection of lifecycle states.",
    "items":{
        "$ref":"#/definitions/LifecycleState"
    }
}

Nested Schema : parameters

Type: array

An optional list of parameters.

Show Source

• Array of: object Parameter
  Specifies the name and value of the defined parameter.

{
    "description":"An optional list of parameters.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Parameter"
    }
}

Nested Schema : Queue

Type: object

Queue configuration for job.

Show Source

• isEnabled(required): boolean
  Default Value: false

  True if job queue is enabled.

{
    "description":"Queue configuration for job.",
    "type":"object",
    "required":[
        "isEnabled"
    ],
    "properties":{
        "isEnabled":{
            "description":"True if job queue is enabled.",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : repairedTasks

Type: array

A list of repaired tasks.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of repaired tasks.",
    "items":{
        "type":"string"
    }
}

Nested Schema : repairHistory

Type: array

Maximum Number of Items: 10

Array of repaired runs.

Show Source

• Array of: object RepairHistory
  A description of a repaired job run.

{
    "description":"Array of repaired runs.",
    "type":"array",
    "maxItems":10,
    "items":{
        "$ref":"#/definitions/RepairHistory"
    }
}

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 : State

Type: object

The current state of the run.

Show Source

• errorTrace: string
  If there was an error executing the run, this field contains any available stack traces.
• isUserCanceledOrTimedOut: boolean
  Default Value: false

  Set to true, if the job execution is canceled by the user or by the scheduler due to timeout.
• stateMessage: string
  A descriptive message of the current state.
• status: string
  Allowed Values: [ "PENDING", "QUEUED", "RUNNING", "SKIPPED", "INTERNAL_ERROR", "BLOCKED", "SUCCESS", "FAILED", "CANCELING", "CANCELED", "UPSTREAM_CANCELED", "UPSTREAM_FAILED", "EXCLUDED", "TIMED_OUT", "PAUSED_MAINTENANCE" ]

  Current state of execution.

{
    "description":"The current state of the run.",
    "type":"object",
    "properties":{
        "status":{
            "description":"Current state of execution.",
            "type":"string",
            "enum":[
                "PENDING",
                "QUEUED",
                "RUNNING",
                "SKIPPED",
                "INTERNAL_ERROR",
                "BLOCKED",
                "SUCCESS",
                "FAILED",
                "CANCELING",
                "CANCELED",
                "UPSTREAM_CANCELED",
                "UPSTREAM_FAILED",
                "EXCLUDED",
                "TIMED_OUT",
                "PAUSED_MAINTENANCE"
            ]
        },
        "stateMessage":{
            "description":"A descriptive message of the current state.",
            "type":"string"
        },
        "errorTrace":{
            "description":"If there was an error executing the run, this field contains any available stack traces.",
            "type":"string"
        },
        "isUserCanceledOrTimedOut":{
            "description":"Set to true, if the job execution is canceled by the user or by the scheduler due to timeout.",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : systemParameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Map of system parameters with their values for this job run.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Map of system parameters with their values for this job run.

Nested Schema : taskRunSummaryMap

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"TaskRun to TaskRunSummary map for given job run.",
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

TaskRun to TaskRunSummary map for given job run.

Nested Schema : tasks

Type: array

List of tasks in a job.

Show Source

• Array of: object Task
  Discriminator: type

  Properties of a task provided by the user.

{
    "description":"List of tasks in a job.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Task"
    }
}

Nested Schema : taskToTaskRunMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Task to TaskRun map for given job run.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Task to TaskRun map for given job run.

Nested Schema : unifiedJobAndJobRunParameters

Type: array

Unified List of job and job run parameters after resolving dynamic value references and parameter resolution as per precedence.

Show Source

• Array of: object Parameter
  Specifies the name and value of the defined parameter.

{
    "description":"Unified List of job and job run parameters after resolving dynamic value references and parameter resolution as per precedence.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Parameter"
    }
}

Nested Schema : Libraries

Type: object

List of libraries to be installed on the cluster.

Show Source

• jar: string
  URI of the jar to be installed.

{
    "description":"List of libraries to be installed on the cluster.",
    "type":"object",
    "properties":{
        "jar":{
            "description":"URI of the jar to be installed.",
            "type":"string"
        }
    }
}

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

Nested Schema : LifecycleState

Type: object

The lifecycle state of execution.

Match All

The lifecycle state of execution.

The lifecycle state of execution.

The lifecycle state of execution.

Show Source

• object State
  The current state of the run.
• object LifecycleState-allOf[1]
• object LifecycleState-allOf[2]

{
    "description":"The lifecycle state of execution.",
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/State"
        },
        {
            "type":"object"
        },
        {
            "properties":{
                "startTime":{
                    "description":"The time at which the job execution started in epoch milliseconds.",
                    "type":"integer",
                    "format":"int64"
                },
                "endTime":{
                    "description":"The time at which the job execution started in epoch milliseconds.",
                    "type":"integer",
                    "format":"int64"
                }
            }
        }
    ]
}

Nested Schema : LifecycleState-allOf[1]

Type: object

Nested Schema : LifecycleState-allOf[2]

Type: object

Show Source

• endTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.
• startTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.

{
    "properties":{
        "startTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "endTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : Parameter

Type: object

Specifies the name and value of the defined parameter.

Show Source

• name(required): string
  Pattern: ^[\w\-.]+$

  The name of the defined parameter. May only contain alphanumeric characters, '_', '-', and '.'
• value: string
  Value of the defined parameter.

{
    "description":"Specifies the name and value of the defined parameter.",
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"The name of the defined parameter. May only contain alphanumeric characters, '_', '-', and '.'",
            "type":"string",
            "pattern":"^[\\w\\-.]+$"
        },
        "value":{
            "description":"Value of the defined parameter.",
            "type":"string"
        }
    }
}

Nested Schema : RepairHistory

Type: object

A description of a repaired job run.

Show Source

• endTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.
• executionDuration: integer(int64)
  The time (in milliseconds) taken to complete the job execution.
• key: integer(int32)
  The unique ID of the Repair run.
• lifecycleStates: array lifecycleStates
  The collection of lifecycle states.
• parameters: array parameters
  An optional list of parameters.
• repairedTasks: array repairedTasks
  A list of repaired tasks.
• startTime: integer(int64)
  The time at which the job execution started in epoch milliseconds.
• state: object State
  The current state of the run.
• taskToTaskRunMap: object taskToTaskRunMap
  Additional Properties Allowed: additionalProperties

  Task to TaskRun map for given job run.
• type: string
  Allowed Values: [ "ORIGINAL", "REPAIR" ]

  Indicates whether the job run is Original or Repaired.

{
    "description":"A description of a repaired job run.",
    "properties":{
        "type":{
            "description":"Indicates whether the job run is Original or Repaired.",
            "type":"string",
            "enum":[
                "ORIGINAL",
                "REPAIR"
            ]
        },
        "key":{
            "description":"The unique ID of the Repair run.",
            "type":"integer",
            "format":"int32"
        },
        "state":{
            "$ref":"#/definitions/State"
        },
        "startTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "endTime":{
            "description":"The time at which the job execution started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "taskToTaskRunMap":{
            "description":"Task to TaskRun map for given job run.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "parameters":{
            "description":"An optional list of parameters.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Parameter"
            }
        },
        "repairedTasks":{
            "type":"array",
            "description":"A list of repaired tasks.",
            "items":{
                "type":"string"
            }
        },
        "lifecycleStates":{
            "type":"array",
            "description":"The collection of lifecycle states.",
            "items":{
                "$ref":"#/definitions/LifecycleState"
            }
        },
        "executionDuration":{
            "description":"The time (in milliseconds) taken to complete the job execution.",
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : lifecycleStates

Type: array

The collection of lifecycle states.

Show Source

• Array of: object LifecycleState
  The lifecycle state of execution.

{
    "type":"array",
    "description":"The collection of lifecycle states.",
    "items":{
        "$ref":"#/definitions/LifecycleState"
    }
}

Nested Schema : parameters

Type: array

An optional list of parameters.

Show Source

• Array of: object Parameter
  Specifies the name and value of the defined parameter.

{
    "description":"An optional list of parameters.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Parameter"
    }
}

Nested Schema : repairedTasks

Type: array

A list of repaired tasks.

Show Source

• Array of: string

{
    "type":"array",
    "description":"A list of repaired tasks.",
    "items":{
        "type":"string"
    }
}

Nested Schema : taskToTaskRunMap

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Task to TaskRun map for given job run.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Task to TaskRun map for given job run.

Nested Schema : additionalProperties

Type: object

Nested Schema : Task

Type: object

Discriminator: type

Properties of a task provided by the user.

Show Source

• dependsOn: array dependsOn
  Specifies the dependency graph of the task. All the tasks mentioned in this field need to be completed before executing this task.
• isRetryOnTimeout: boolean
  Default Value: false

  An optional policy to specify whether to retry a task when it times out. The default behavior is to not retry on timeout.
• maxRetries: integer(int32)
  Minimum Value: 0

  Maximum Value: 300

  Default Value: 0

  The maximum number of times to retry an unsuccessful run. A run is considered to be unsuccessful if it fails with status FAILED or INTERNAL_ERROR. Maximum value is 300.
• minRetryIntervalMillis: integer(int32)
  Minimum Value: 0

  Maximum Value: 600000

  Default Value: 0

  An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. If value is not provided, the run would be immediately retried. Maximum value is 10 mins (600000)
• runIf(required): string
  Default Value: ALL_SUCCESS

  Allowed Values: [ "ALL_SUCCESS", "ALL_DONE", "NONE_FAILED", "AT_LEAST_ONE_SUCCESS", "ALL_FAILED", "AT_LEAST_ONE_FAILED" ]

  The trigger rule based on which the current task execution is determined.
• taskKey(required): string
  Minimum Length: 1

  Maximum Length: 100

  The display name of the task. User can specify a value for this.
• type(required): string
  Allowed Values: [ "NOTEBOOK_TASK", "PYTHON_TASK", "SPARK_SUBMIT_TASK", "IF_ELSE_TASK", "JOB_TASK", "JAR_TASK" ]

  The type of the task.

{
    "description":"Properties of a task provided by the user.",
    "type":"object",
    "discriminator":"type",
    "required":[
        "type",
        "taskKey",
        "runIf"
    ],
    "properties":{
        "type":{
            "description":"The type of the task.",
            "type":"string",
            "enum":[
                "NOTEBOOK_TASK",
                "PYTHON_TASK",
                "SPARK_SUBMIT_TASK",
                "IF_ELSE_TASK",
                "JOB_TASK",
                "JAR_TASK"
            ]
        },
        "taskKey":{
            "description":"The display name of the task. User can specify a value for this.",
            "minLength":1,
            "maxLength":100,
            "type":"string"
        },
        "dependsOn":{
            "description":"Specifies the dependency graph of the task. All the tasks mentioned in this field need to be completed before executing this task.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/DependsOn"
            }
        },
        "runIf":{
            "description":"The trigger rule based on which the current task execution is determined.",
            "type":"string",
            "enum":[
                "ALL_SUCCESS",
                "ALL_DONE",
                "NONE_FAILED",
                "AT_LEAST_ONE_SUCCESS",
                "ALL_FAILED",
                "AT_LEAST_ONE_FAILED"
            ],
            "default":"ALL_SUCCESS"
        },
        "maxRetries":{
            "description":"The maximum number of times to retry an unsuccessful run. \nA run is considered to be unsuccessful if it fails with status FAILED or INTERNAL_ERROR. Maximum value is 300.\n",
            "type":"integer",
            "format":"int32",
            "minimum":0,
            "maximum":300,
            "default":0
        },
        "minRetryIntervalMillis":{
            "description":"An optional minimal interval in milliseconds between the start of the failed run and the subsequent retry run. \nIf value is not provided, the run would be immediately retried. Maximum value is 10 mins (600000)\n",
            "type":"integer",
            "format":"int32",
            "minimum":0,
            "default":0,
            "maximum":600000
        },
        "isRetryOnTimeout":{
            "description":"An optional policy to specify whether to retry a task when it times out. The default behavior is to not retry on timeout.",
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : dependsOn

Type: array

Specifies the dependency graph of the task. All the tasks mentioned in this field need to be completed before executing this task.

Show Source

• Array of: object DependsOn
  Specifies the dependency graph of the task. All the tasks mentioned in this field need to be completed before executing this task.

{
    "description":"Specifies the dependency graph of the task. All the tasks mentioned in this field need to be completed before executing this task.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/DependsOn"
    }
}

Nested Schema : DependsOn

Type: object

Specifies the dependency graph of the task. All the tasks mentioned in this field need to be completed before executing this task.

Show Source

• outcome: string
  Specified on condition task dependencies. The outcome of the dependent task should be met for this task to be executed.
• taskKey(required): string
  The name of the task that it depends on.

{
    "description":"Specifies the dependency graph of the task. All the tasks mentioned in this field need to be completed before executing this task.",
    "type":"object",
    "required":[
        "taskKey"
    ],
    "properties":{
        "taskKey":{
            "description":"The name of the task that it depends on.",
            "type":"string"
        },
        "outcome":{
            "description":"Specified on condition task dependencies. The outcome of the dependent task should be met for this task to be executed.",
            "type":"string"
        }
    }
}

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

409 Response

Conflict. Request conflicts with the current state of the resource.

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