Jump to

• Request
• Response

Get task run details

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/workspaces/{workspaceKey}/taskRuns/{taskRunKey}

Returns detailed information about a task run with a given task run key.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• taskRunKey(required): string
  Task run key.
• 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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Details for task run with given task run key is retrieved.

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

Type: object

A description of a task run.

Show Source

• cleanupDuration: integer(int64)
  The time (in milliseconds) taken to terminate the cluster and to clean up any associated artifacts.
• clusterSpec: object ClusterSpec
  Cluster specification snapshot of a job.
• clusterValidationStartTime: integer(int64)
  The time at which the cluster validation started in epoch milliseconds.
• 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.
• externalId: string
  The external ID of the task execution.
• jobKey: string
  The OCID of the job.
• jobRunKey: string
  The OCID of the job.
• key(required): string
  The OCID of the task run.
• lifecycleStates: array lifecycleStates
  The collection of lifecycle states.
• name(required): string
  A user-friendly name. Does not have to be unique, and is changeable.
• outputKey: string
  Minimum Length: 1

  Maximum Length: 100

  A unique identifier for the output.
• parameters: array parameters
  An optional list of parameters.
• parentJobRunKey: string
  The OCID of the job.
• retries: array retries
  List of task retries.
• retryAttempt: integer(int32)
  Sequence number of the current retry attempt. 0 for the original. 1, 2, 3, ... for subsequent retry attempts.
• rootJobRunKey: string
  The OCID of 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.
• task: object Task
  Discriminator: type

  Properties of a task provided by the user.
• taskKey: string
  Minimum Length: 1

  Maximum Length: 100

  The display name of the task. User can specify a value for this.
• version: integer(int32)
  Current version of job run object in repository.

{
    "description":"A description of a task run.",
    "type":"object",
    "required":[
        "key",
        "name"
    ],
    "properties":{
        "key":{
            "description":"The OCID of the task run.",
            "type":"string"
        },
        "name":{
            "description":"A user-friendly name. Does not have to be unique, and is changeable.",
            "type":"string"
        },
        "taskKey":{
            "description":"The display name of the task. User can specify a value for this.",
            "minLength":1,
            "maxLength":100,
            "type":"string"
        },
        "jobKey":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "jobRunKey":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "parentJobRunKey":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "rootJobRunKey":{
            "description":"The OCID of the job.",
            "type":"string"
        },
        "clusterValidationStartTime":{
            "description":"The time at which the cluster validation started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "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"
        },
        "state":{
            "$ref":"#/definitions/State"
        },
        "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"
        },
        "clusterSpec":{
            "$ref":"#/definitions/ClusterSpec"
        },
        "task":{
            "$ref":"#/definitions/Task"
        },
        "version":{
            "description":"Current version of job run object in repository.",
            "type":"integer",
            "format":"int32"
        },
        "retryAttempt":{
            "description":"Sequence number of the current retry attempt. 0 for the original. 1, 2, 3, ... for subsequent retry attempts.",
            "type":"integer",
            "format":"int32"
        },
        "retries":{
            "description":"List of task retries.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TaskRunRetry"
            }
        },
        "outputKey":{
            "description":"A unique identifier for the output.",
            "type":"string",
            "minLength":1,
            "maxLength":100
        },
        "externalId":{
            "description":"The external ID of the task execution.",
            "type":"string"
        },
        "systemParameters":{
            "description":"Map of system parameters with their values for this job run.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "parameters":{
            "description":"An optional list of parameters.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/Parameter"
            }
        },
        "lifecycleStates":{
            "type":"array",
            "description":"The collection of lifecycle states.",
            "items":{
                "$ref":"#/definitions/LifecycleState"
            }
        }
    }
}

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

Type: array

List of task retries.

Show Source

• Array of: object TaskRunRetry
  Representation of a task run retry. Maximum of 10 retries are allowed.

{
    "description":"List of task retries.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/TaskRunRetry"
    }
}

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

Type: object

Representation of a task run retry. Maximum of 10 retries are allowed.

Show Source

• cleanupDuration: integer(int64)
  The time (in milliseconds) taken to terminate the cluster and to clean up any associated artifacts.
• clusterValidationStartTime: integer(int64)
  The time at which the cluster validation started in epoch milliseconds.
• 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.
• externalId: string
  The external ID of the task execution.
• outputKey: string
  Minimum Length: 1

  Maximum Length: 100

  A unique identifier for the output.
• retryNumber: integer(int32)
  Sequence number of the retry attempt. 0 for the original. 1, 2, 3, ... for subsequent retry attempts.
• 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.

{
    "description":"Representation of a task run retry. Maximum of 10 retries are allowed.",
    "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"
        },
        "clusterValidationStartTime":{
            "description":"The time at which the cluster validation started in epoch milliseconds.",
            "type":"integer",
            "format":"int64"
        },
        "state":{
            "$ref":"#/definitions/State"
        },
        "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"
        },
        "outputKey":{
            "description":"A unique identifier for the output.",
            "type":"string",
            "minLength":1,
            "maxLength":100
        },
        "externalId":{
            "description":"The external ID of the task execution.",
            "type":"string"
        },
        "retryNumber":{
            "description":"Sequence number of the retry attempt. 0 for the original. 1, 2, 3, ... for subsequent retry attempts.",
            "type":"integer",
            "format":"int32"
        }
    }
}

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

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