REST API for Oracle AI Data Platform Workbench

Get catalog details

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs/{catalogKey}

Gets detailed information about an AI Data Platform Workbench catalog with a given catalog key.

Request

Path Parameters

aiDataPlatformId(required): string

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

The key of the catalog.

Query Parameters

isCatalogGuid: boolean

A boolean which decides if catalogKey path parameter is catalog GUID (UUID) or name.

Default Value: false

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.
should-update-recent: boolean

A flag to identify if the recent list should be updated.

Default Value: false

Response

Supported Media Types

application/json

200 Response

Successful operation. Catalog details are 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.

Root Schema : Catalog

Type: object

AI Data Platform Workbench catalogs enable you to manage your data and metadata. 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 IAM Policies for Oracle AI Data Platform Workbench.

Show Source

catalogGuid: string

Unique identifier for catalog.
catalogType: string

Allowed Values: [ "EXTERNAL", "INTERNAL" ]

Type of catalog.
connectionDetails: object CatalogConnectionDetails

The details of a connection associated with a catalog.
createdBy: string

The ID of the user that created the catalog.
description: string

Short description of the catalog.
displayName(required): string

Catalog display name.
key(required): string

The AI Data Platform Workbench catalog key.
lifecycleState: string

Allowed Values: [ "ACTIVE", "CREATING", "DELETING", "UPDATING" ]

The current status of the catalog.
lifecycleStateDetails: string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
properties: object properties

Additional Properties Allowed: additionalProperties

Key-value pair used to provide catalog properties like the subCompartment OCID where the buckets need to reside.
sourceType: string

Allowed Values: [ "ADW", "ALH", "KAFKA", "ATP", "ORACLE", "EXADATA" ]

External catalog source type.
timeCreated(required): string(date-time)

The date and time the AI Data Platform Workbench catalog was created.
timeUpdated: string(date-time)

The date and time the AI Data Platform Workbench catalog was updated.
updatedBy: string

The ID of the last user to update the catalog.

{
    "description":"AI Data Platform Workbench catalogs enable you to manage your data and metadata.\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<a href=\"https://docs.oracle.com/en/cloud/paas/ai-data-platform/aidug/iam-policies-oracle-ai-data-platform.html\" target=\"_blank\" rel=\"noopener noreferrer\">IAM Policies for Oracle AI Data Platform Workbench</a>.\n",
    "type":"object",
    "required":[
        "key",
        "timeCreated",
        "displayName"
    ],
    "properties":{
        "key":{
            "description":"The AI Data Platform Workbench catalog key.",
            "type":"string"
        },
        "displayName":{
            "description":"Catalog display name.",
            "type":"string"
        },
        "description":{
            "description":"Short description of the catalog.",
            "type":"string"
        },
        "catalogGuid":{
            "description":"Unique identifier for catalog.",
            "type":"string"
        },
        "catalogType":{
            "type":"string",
            "description":"Type of catalog.",
            "x-obmcs-top-level-enum":"#/definitions/CatalogType",
            "enum":[
                "EXTERNAL",
                "INTERNAL"
            ]
        },
        "sourceType":{
            "type":"string",
            "description":"External catalog source type.",
            "x-obmcs-top-level-enum":"#/definitions/ExternalCatalogSourceType",
            "enum":[
                "ADW",
                "ALH",
                "KAFKA",
                "ATP",
                "ORACLE",
                "EXADATA"
            ]
        },
        "connectionDetails":{
            "$ref":"#/definitions/CatalogConnectionDetails"
        },
        "lifecycleState":{
            "description":"The current status of the catalog.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CatalogLifecycleState",
            "enum":[
                "ACTIVE",
                "CREATING",
                "DELETING",
                "UPDATING"
            ]
        },
        "lifecycleStateDetails":{
            "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.",
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the AI Data Platform Workbench catalog was created.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The date and time the AI Data Platform Workbench catalog was updated.",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"The ID of the user that created the catalog.",
            "type":"string"
        },
        "updatedBy":{
            "description":"The ID of the last user to update the catalog.",
            "type":"string"
        },
        "properties":{
            "description":"Key-value pair used to provide catalog properties like the subCompartment OCID where the buckets need to reside.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CatalogConnectionDetails

Type: object

The details of a connection associated with a catalog.

Show Source

connectionProperties(required): object connectionProperties

Additional Properties Allowed: additionalProperties

Connection properties.
displayName: string

Maximum Length: 255

Connection name.

{
    "description":"The details of a connection associated with a catalog.",
    "type":"object",
    "required":[
        "connectionProperties"
    ],
    "properties":{
        "displayName":{
            "description":"Connection name.",
            "type":"string",
            "maxLength":255
        },
        "connectionProperties":{
            "description":"Connection properties.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Key-value pair used to provide catalog properties like the subCompartment OCID where the buckets need to reside.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Key-value pair used to provide catalog properties like the subCompartment OCID where the buckets need to reside.

Nested Schema : connectionProperties

Type: object

Additional Properties Allowed

Show Source

string

{
    "description":"Connection properties.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Connection properties.

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