REST API for Oracle AI Data Platform Workbench

Get information about an async operation.

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/asyncOperations/{asyncOperationKey}

Get detailed information for a particular async operation

Request

Path Parameters

aiDataPlatformId(required): string

Minimum Length: 1

Maximum Length: 500

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

Minimum Length: 1

Maximum Length: 200

The unique identifier of an async operation

Header Parameters

opc-request-id: string

Maximum Length: 255

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.

Response

Supported Media Types

application/json

200 Response

The async operation

Headers

opc-next-page: string

For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
opc-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.

Root Schema : AsyncOperation

Type: object

An async operation.

Show Source

actionType(required): string

Allowed Values: [ "UNKNOWN", "CREATE_CATALOG", "UPDATE_CATALOG", "DELETE_CATALOG", "TEST_CONNECTION_CATALOG", "CREATE_USER_SCHEMA_IN_CATALOG", "CREATE_SCHEMA", "DELETE_SCHEMA", "CREATE_TABLE", "UPDATE_TABLE", "DELETE_TABLE", "CREATE_VOLUME", "DELETE_VOLUME", "COPY_VOLUME_FILE", "MOVE_VOLUME_FILE", "DELETE_VOLUME_FILE", "DELETE_VOLUME_FOLDER", "CREATE_WORKSPACE", "UPDATE_WORKSPACE", "DELETE_WORKSPACE", "CREATE_CLUSTER", "UPDATE_CLUSTER", "START_CLUSTER", "STOP_CLUSTER", "RESTART_CLUSTER", "PATCH_CLUSTER_LIBRARIES", "DELETE_CLUSTER", "MANAGE_EXTRACTED_ENTITIES", "REFRESH_ENTITY", "DOWNLOAD_CLUSTER_LOG", "MIGRATE_EXTERNAL_CATALOG", "UPDATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE", "CREATE_KNOWLEDGE_BASE", "DELETE_KNOWLEDGE_BASE_JOB", "CREATE_KNOWLEDGE_BASE_JOB", "CREATE_KNOWLEDGE_BASE_JOB_RUN", "DEPLOY_AGENT_FLOW", "CREATE_GIT_FOLDER", "UPDATE_GIT_REPOSITORY", "CREATE_BUNDLE", "BUNDLE_DEPLOY", "BUNDLE_PURGE", "BUNDLE_SYNC", "MARK_AS_BUNDLE", "GIT_COMMIT_PUSH", "GIT_CREATE_BRANCH", "GIT_CHECKOUT_BRANCH", "GIT_OPERATION_PULL", "GIT_OPERATION_MERGE", "GIT_OPERATION_REBASE", "GIT_OPERATION_RESET", "GIT_OPERATION_RESET_STATE" ]

The action type of the async operation.
createdBy: string

The principal Id who started the async operation
createdByName: string

The principal name who started the async operation
errorCode: string

Represents the error code of a failure
errorMessage: string

Representss extra error information of a failure
key(required): string

The unique key that identifies an async operation
resourceDisplayName: string

The display name of the Data Lake resource. Example: For catalog/table/schema, it is same as resourceName But for workspace/cluster it is workspace and cluster displayName field.
resourceName(required): string

The fully qualified name of the Data Lake resource. Example: For table, it is ... For Cluster, it is .
resourceType(required): string

Allowed Values: [ "UNKNOWN", "CATALOG", "SCHEMA", "TABLE", "VIEW", "VOLUME", "VOLUME_FILE", "WORKSPACE", "WORKSPACE_OBJECT", "CLUSTER", "AI_COMPUTE", "KNOWLEDGE_BASE", "KNOWLEDGE_BASE_JOB", "KNOWLEDGE_BASE_JOB_RUN", "AGENT_FLOW", "GIT_OPERATION", "BUNDLE_OPERATION" ]

The resource type of the async operation.
status(required): string

Allowed Values: [ "IN_PROGRESS", "SUCCEEDED", "FAILED", "CANCELED" ]

The state of the Table.
timeFinished: string(date-time)

The date and time the Async operation finished, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`
timeStarted(required): string(date-time)

The date and time the Async operation was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`

{
    "description":"An async operation.",
    "type":"object",
    "required":[
        "key",
        "resourceType",
        "actionType",
        "resourceName",
        "timeStarted",
        "status"
    ],
    "properties":{
        "key":{
            "description":"The unique key that identifies an async operation",
            "type":"string"
        },
        "resourceType":{
            "description":"The resource type of the async operation.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/AsyncOperationResourceType",
            "enum":[
                "UNKNOWN",
                "CATALOG",
                "SCHEMA",
                "TABLE",
                "VIEW",
                "VOLUME",
                "VOLUME_FILE",
                "WORKSPACE",
                "WORKSPACE_OBJECT",
                "CLUSTER",
                "AI_COMPUTE",
                "KNOWLEDGE_BASE",
                "KNOWLEDGE_BASE_JOB",
                "KNOWLEDGE_BASE_JOB_RUN",
                "AGENT_FLOW",
                "GIT_OPERATION",
                "BUNDLE_OPERATION"
            ]
        },
        "actionType":{
            "description":"The action type of the async operation.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/AsyncOperationActionType",
            "enum":[
                "UNKNOWN",
                "CREATE_CATALOG",
                "UPDATE_CATALOG",
                "DELETE_CATALOG",
                "TEST_CONNECTION_CATALOG",
                "CREATE_USER_SCHEMA_IN_CATALOG",
                "CREATE_SCHEMA",
                "DELETE_SCHEMA",
                "CREATE_TABLE",
                "UPDATE_TABLE",
                "DELETE_TABLE",
                "CREATE_VOLUME",
                "DELETE_VOLUME",
                "COPY_VOLUME_FILE",
                "MOVE_VOLUME_FILE",
                "DELETE_VOLUME_FILE",
                "DELETE_VOLUME_FOLDER",
                "CREATE_WORKSPACE",
                "UPDATE_WORKSPACE",
                "DELETE_WORKSPACE",
                "CREATE_CLUSTER",
                "UPDATE_CLUSTER",
                "START_CLUSTER",
                "STOP_CLUSTER",
                "RESTART_CLUSTER",
                "PATCH_CLUSTER_LIBRARIES",
                "DELETE_CLUSTER",
                "MANAGE_EXTRACTED_ENTITIES",
                "REFRESH_ENTITY",
                "DOWNLOAD_CLUSTER_LOG",
                "MIGRATE_EXTERNAL_CATALOG",
                "UPDATE_KNOWLEDGE_BASE",
                "DELETE_KNOWLEDGE_BASE",
                "CREATE_KNOWLEDGE_BASE",
                "DELETE_KNOWLEDGE_BASE_JOB",
                "CREATE_KNOWLEDGE_BASE_JOB",
                "CREATE_KNOWLEDGE_BASE_JOB_RUN",
                "DEPLOY_AGENT_FLOW",
                "CREATE_GIT_FOLDER",
                "UPDATE_GIT_REPOSITORY",
                "CREATE_BUNDLE",
                "BUNDLE_DEPLOY",
                "BUNDLE_PURGE",
                "BUNDLE_SYNC",
                "MARK_AS_BUNDLE",
                "GIT_COMMIT_PUSH",
                "GIT_CREATE_BRANCH",
                "GIT_CHECKOUT_BRANCH",
                "GIT_OPERATION_PULL",
                "GIT_OPERATION_MERGE",
                "GIT_OPERATION_REBASE",
                "GIT_OPERATION_RESET",
                "GIT_OPERATION_RESET_STATE"
            ]
        },
        "resourceName":{
            "description":"The fully qualified name of the Data Lake resource. Example: For table, it is \n<catalog_name>.<schema_name>.<table_name>. For Cluster, it is <workspace_key>.<cluster_key>\n",
            "type":"string"
        },
        "resourceDisplayName":{
            "description":"The display name of the Data Lake resource. Example: For catalog/table/schema, it is same as resourceName\nBut for workspace/cluster it is workspace and cluster displayName field.\n",
            "type":"string"
        },
        "createdBy":{
            "description":"The principal Id who started the async operation\n",
            "type":"string"
        },
        "createdByName":{
            "description":"The principal name who started the async operation\n",
            "type":"string"
        },
        "timeStarted":{
            "description":"The date and time the Async operation was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "timeFinished":{
            "description":"The date and time the Async operation finished, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "description":"The state of the Table.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/AsyncOperationStatus",
            "enum":[
                "IN_PROGRESS",
                "SUCCEEDED",
                "FAILED",
                "CANCELED"
            ]
        },
        "errorCode":{
            "description":"Represents the error code of a failure\n",
            "type":"string"
        },
        "errorMessage":{
            "description":"Representss extra error information of a failure\n",
            "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.

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.

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.

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.

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.

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.

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