Jump to

• Request
• Response

Fetch task run output from runtime engine

post

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

Fetches the task run output from the runtime engine.

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.
• 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.

Body ()

Details for task run output retrieval.

Root Schema : FetchOutputDetails

Type: object

The payload to fetch TaskRunOutput.

Show Source

• outputKey: string
  Minimum Length: 1

  Maximum Length: 100

  A unique identifier for the output.

{
    "description":"The payload to fetch TaskRunOutput.",
    "type":"object",
    "properties":{
        "outputKey":{
            "description":"A unique identifier for the output.",
            "type":"string",
            "minLength":1,
            "maxLength":100
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Request accepted. Task run output is returned.

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

Type: object

Output of a task run.

Show Source

• data(required): array data
  Array of output objects.
• errorTrace: string
  If there was an error executing the run, this field contains any available stack traces.
• isTruncated: boolean
  Default Value: false

  True if logs are truncated.
• key: string
  Minimum Length: 1

  Maximum Length: 100

  A unique identifier for the output.
• outputParameters: array outputParameters
  List of output parameters with name and values.
• taskType: string
  Allowed Values: [ "NOTEBOOK_TASK", "PYTHON_TASK", "SPARK_SUBMIT_TASK", "IF_ELSE_TASK", "JOB_TASK", "JAR_TASK" ]

  The type of the task.
• version: integer(int32)
  Current version of job run object in repository.

{
    "description":"Output of a task run.",
    "type":"object",
    "required":[
        "data"
    ],
    "properties":{
        "key":{
            "description":"A unique identifier for the output.",
            "type":"string",
            "minLength":1,
            "maxLength":100
        },
        "taskType":{
            "description":"The type of the task.",
            "type":"string",
            "enum":[
                "NOTEBOOK_TASK",
                "PYTHON_TASK",
                "SPARK_SUBMIT_TASK",
                "IF_ELSE_TASK",
                "JOB_TASK",
                "JAR_TASK"
            ]
        },
        "isTruncated":{
            "description":"True if logs are truncated.",
            "type":"boolean",
            "default":false
        },
        "errorTrace":{
            "description":"If there was an error executing the run, this field contains any available stack traces.",
            "type":"string"
        },
        "data":{
            "type":"array",
            "description":"Array of output objects.",
            "items":{
                "$ref":"#/definitions/RunOutputData"
            }
        },
        "outputParameters":{
            "description":"List of output parameters with name and values.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/OutputParameter"
            }
        },
        "version":{
            "description":"Current version of job run object in repository.",
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : data

Type: array

Array of output objects.

Show Source

• Array of: object RunOutputData
  An object representing execution output of a command.

{
    "type":"array",
    "description":"Array of output objects.",
    "items":{
        "$ref":"#/definitions/RunOutputData"
    }
}

Nested Schema : outputParameters

Type: array

List of output parameters with name and values.

Show Source

• Array of: object OutputParameter
  Specifies the name and value of the output parameter.

{
    "description":"List of output parameters with name and values.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/OutputParameter"
    }
}

Nested Schema : RunOutputData

Type: object

An object representing execution output of a command.

Show Source

• charset: string
  Allowed Values: [ "UTF_8", "UTF_16" ]

  Charset of the result.
• compression: string
  Allowed Values: [ "GZIP", "DEFLATE", "COMPRESS", "BZIP2" ]

  Content-Encoding or compression
• isBase64: boolean
  Boolean to identify if output data is base64-encoded.
• length: string
  Size of object in bytes.
• type(required): string
  Allowed Values: [ "TEXT_PLAIN", "NOTEBOOK", "TEXT_HTML", "IMAGE_PNG", "IMAGE_SVG", "IMAGE_JPEG", "APPLICATION_PDF", "APPLICATION_JSON", "FILE_PATH", "NOTEBOOK_PATH" ]

  The type of the RunOutputData. For example, `TEXT_PLAIN`, `TEXT_HTML`, or `IMAGE`.
• value: string
  The output content string format.

{
    "type":"object",
    "description":"An object representing execution output of a command.\n",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"The type of the RunOutputData. For example, `TEXT_PLAIN`, `TEXT_HTML`, or `IMAGE`.\n",
            "type":"string",
            "enum":[
                "TEXT_PLAIN",
                "NOTEBOOK",
                "TEXT_HTML",
                "IMAGE_PNG",
                "IMAGE_SVG",
                "IMAGE_JPEG",
                "APPLICATION_PDF",
                "APPLICATION_JSON",
                "FILE_PATH",
                "NOTEBOOK_PATH"
            ]
        },
        "length":{
            "description":"Size of object in bytes.",
            "type":"string"
        },
        "charset":{
            "description":"Charset of the result.",
            "type":"string",
            "enum":[
                "UTF_8",
                "UTF_16"
            ]
        },
        "isBase64":{
            "description":"Boolean to identify if output data is base64-encoded.",
            "type":"boolean"
        },
        "compression":{
            "description":"Content-Encoding or compression",
            "type":"string",
            "enum":[
                "GZIP",
                "DEFLATE",
                "COMPRESS",
                "BZIP2"
            ]
        },
        "value":{
            "description":"The output content string format.",
            "type":"string"
        }
    }
}

Nested Schema : OutputParameter

Type: object

Specifies the name and value of the output parameter.

Show Source

• name(required): string
  The name of the parameter defined by user.
• value: string
  Value of the output parameter.

{
    "description":"Specifies the name and value of the output parameter.",
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"The name of the parameter defined by user.",
            "type":"string"
        },
        "value":{
            "description":"Value of the output parameter.",
            "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"
        }
    }
}

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

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