Jump to

• Request
• Response

Updates a job

put

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

Update details for a job in 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.
• jobKey(required): string
  Job key.
• workspaceKey(required): string
  The key of the Workspace

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• 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.
• should-update-recent: boolean
  A flag to identify if the recent list should be updated.

  Default Value: false

Body ()

The information to be updated.

Root Schema : UpdateJobDetails

Type: object

The data to update a job.

Show Source

• continuous: object Continuous
  The continuous property ensures that there is always one execution for this job.
• description: string
  Maximum Length: 1024

  A description for the job.
• gitConfig: object GitConfig
  Git configuration used when source is GIT_PROVIDER.
• jobClusters: array jobClusters
  Maximum Number of Items: 100

  List of job cluster configurations.
• 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.
• parameters: array parameters
  An optional list of parameters.
• path: string
  The path to store the job definition in.
• queue: object Queue
  Queue configuration for job.
• runAs: string
  The id with which the job run as.
• schedule: object Schedule
  The schedule configuration for the job.
• tasks: array tasks
  List of tasks in a job.
• 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.

{
    "description":"The data to update a job.",
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "runAs":{
            "description":"The id with which the job run as.",
            "type":"string"
        },
        "name":{
            "description":"A user-friendly name. Does not have to be unique, and is changeable.",
            "type":"string"
        },
        "description":{
            "description":"A description for the job.",
            "type":"string",
            "maxLength":1024
        },
        "schedule":{
            "$ref":"#/definitions/Schedule"
        },
        "continuous":{
            "$ref":"#/definitions/Continuous"
        },
        "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"
        },
        "jobClusters":{
            "description":"List of job cluster configurations.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/JobCluster"
            }
        },
        "path":{
            "description":"The path to store the job definition in.",
            "type":"string"
        },
        "tasks":{
            "description":"List of tasks in a job.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Task"
            }
        },
        "parameters":{
            "description":"An optional list of parameters.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Parameter"
            }
        },
        "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
        }
    }
}

Nested Schema : Continuous

Type: object

The continuous property ensures that there is always one execution for this job.

Show Source

• pauseStatus: string
  Default Value: UNPAUSED

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

  Indicates whether the continuous execution of this job is paused or not.

{
    "description":"The continuous property ensures that there is always one execution for this job.",
    "type":"object",
    "properties":{
        "pauseStatus":{
            "description":"Indicates whether the continuous execution of this job is paused or not.",
            "type":"string",
            "enum":[
                "PAUSED",
                "UNPAUSED"
            ],
            "default":"UNPAUSED"
        }
    }
}

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

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Job details are updated.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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 : Job

Type: object

A description of a Job. To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).

Show Source

• continuous: object Continuous
  The continuous property ensures that there is always one execution for this job.
• createdBy(required): string
  The OCID of the IAM user.
• createdByName: string
  Name of the user who created this record
• description: string
  Maximum Length: 1024

  A description for the job.
• gitConfig: object GitConfig
  Git configuration used when source is GIT_PROVIDER.
• jobClusters: array jobClusters
  Maximum Number of Items: 100

  List of job cluster configurations.
• key(required): string
  The OCID of the job.
• 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.
• parameters: array parameters
  An optional list of parameters.
• path: string
  The path to store the job definition in.
• queue: object Queue
  Queue configuration for job.
• runAs: string
  The id with which the job run as.
• schedule: object Schedule
  The schedule configuration for the job.
• tasks: array tasks
  List of tasks in a 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`
• 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 date and time the DataLake was updated, in the format defined by RFC 3339. Example: `2025-05-25T21:10:29.600Z`
• updatedBy: string
  The username of the latest updater. The OCID of the IAM user.
• updatedByName: string
  Name of the user who updated this record.

{
    "description":"A description of a Job.\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to\nan administrator. If you're an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/iaas/Content/Identity/policiesgs/get-started-with-policies.htm).\n",
    "type":"object",
    "required":[
        "key",
        "createdBy",
        "name"
    ],
    "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 username of the latest updater. The OCID of the IAM user.",
            "type":"string"
        },
        "updatedByName":{
            "description":"Name of the user who updated this record.",
            "type":"string"
        },
        "runAs":{
            "description":"The id with which the job run as.",
            "type":"string"
        },
        "name":{
            "description":"A user-friendly name. Does not have to be unique, and is changeable.",
            "type":"string"
        },
        "description":{
            "description":"A description for the job.",
            "type":"string",
            "maxLength":1024
        },
        "schedule":{
            "$ref":"#/definitions/Schedule"
        },
        "continuous":{
            "$ref":"#/definitions/Continuous"
        },
        "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"
        },
        "path":{
            "description":"The path to store the job definition in.",
            "type":"string"
        },
        "jobClusters":{
            "description":"List of job cluster configurations.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/JobCluster"
            }
        },
        "tasks":{
            "description":"List of tasks in a job.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Task"
            }
        },
        "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"
        },
        "parameters":{
            "description":"An optional list of parameters.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Parameter"
            }
        },
        "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
        }
    }
}

Nested Schema : Continuous

Type: object

The continuous property ensures that there is always one execution for this job.

Show Source

• pauseStatus: string
  Default Value: UNPAUSED

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

  Indicates whether the continuous execution of this job is paused or not.

{
    "description":"The continuous property ensures that there is always one execution for this job.",
    "type":"object",
    "properties":{
        "pauseStatus":{
            "description":"Indicates whether the continuous execution of this job is paused or not.",
            "type":"string",
            "enum":[
                "PAUSED",
                "UNPAUSED"
            ],
            "default":"UNPAUSED"
        }
    }
}

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

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

405 Response

Method Not Allowed. Request is recognized but not supported.

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

412 Response

Precondition Failed (One or more conditions in request failed).

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