Jump to

• Request
• Response

Create a catalog

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs

Create a catalog in the AI Data Platform Workbench with the given ID.

Request

Path Parameters

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

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.
• should-update-recent: boolean
  A flag to identify if the recent list should be updated.

  Default Value: false

Body ()

Details for the new AI Data Platform Workbench catalog.

Root Schema : CreateCatalogDetails

Type: object

The required details for creating catalog.

Show Source

• catalogType: string
  Allowed Values: [ "EXTERNAL", "INTERNAL" ]

  Type of catalog.
• connectionDetails: object CreateConnectionDetails
  The details of a connection associated with a catalog.
• description: string
  Short description of the catalog.
• displayName(required): string
  Catalog display name.
• 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.

{
    "description":"The required details for creating catalog.",
    "type":"object",
    "required":[
        "displayName"
    ],
    "properties":{
        "displayName":{
            "description":"Catalog display name.",
            "type":"string"
        },
        "description":{
            "description":"Short description of the 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"
            ]
        },
        "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"
            }
        },
        "connectionDetails":{
            "$ref":"#/definitions/CreateConnectionDetails"
        }
    }
}

Nested Schema : CreateConnectionDetails

Type: object

The details of a connection associated with a catalog.

Show Source

• connectionProperties(required): object connectionProperties
  Additional Properties Allowed: additionalProperties

  Connection properties.

{
    "description":"The details of a connection associated with a catalog.",
    "type":"object",
    "required":[
        "connectionProperties"
    ],
    "properties":{
        "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.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Request accepted. The AI Data Platform Workbench catalog is created.

Headers

• aidp-async-operation-key: string
  The key of the asynchronous operations associated with an AI Data Platform instance. Use GetAsyncOperation with this key to track the status of the request.
• content-location: string(uri-reference)
  Same as location.
• location: string(uri-reference)
  URL for the created catalog. The AI Data Platform Workbench catalog key is generated after this request is sent.
• 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.

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

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

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