Jump to

• Request
• Response

Get a list of catalogs

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/catalogs

Get a list of catalogs in an AI Data Platform Workbench with a given ID.

Request

Path Parameters

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

Query Parameters

• catalogState: string
  The state of the catalog.

  Allowed Values: [ "ACTIVE", "CREATING", "DELETING" ]
• catalogType: string
  The type of the catalog.

  Allowed Values: [ "INTERNAL", "EXTERNAL" ]
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A filter to return only resources that match the given display name exactly.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

  Default Value: 100
• page: string
  Minimum Length: 1

  For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).
• sortBy: string
  The field to sort by. You can provide only one sort order. Default order for timeCreated is descending. Default order for displayName is ascending.

  Default Value: timeCreated

  Allowed Values: [ "timeCreated", "displayName" ]
• sortOrder: string
  The sort order to use, either ascending (`ASC`) or descending (`DESC`).

  Allowed Values: [ "ASC", "DESC" ]

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. A list of catalogs is retrieved.

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.

Body ()

Root Schema : CatalogCollection

Type: object

Catalog List

Show Source

• items(required): array items
  List of catalogs.

{
    "type":"object",
    "description":"Catalog List",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of catalogs.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CatalogSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of catalogs.

Show Source

• Array of: object CatalogSummary
  Summary information about a catalog.

{
    "description":"List of catalogs.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CatalogSummary"
    }
}

Nested Schema : CatalogSummary

Type: object

Summary information about a catalog.

Show Source

• catalogGuid: string
  Unique identifier for catalog.
• catalogType: string
  Allowed Values: [ "EXTERNAL", "INTERNAL" ]

  Type of 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.
• lastRefreshStatus: string
  Allowed Values: [ "FAILED", "SUCCESS", "IN_PROGRESS" ]

  The status for last refresh performed on catalog.
• 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.
• 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.
• timeLastRefresh: string(date-time)
  The timestamp for last refresh performed on catalog.
• 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":"Summary information about a catalog.",
    "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"
        },
        "catalogType":{
            "type":"string",
            "description":"Type of catalog.",
            "x-obmcs-top-level-enum":"#/definitions/CatalogType",
            "enum":[
                "EXTERNAL",
                "INTERNAL"
            ]
        },
        "catalogGuid":{
            "description":"Unique identifier for catalog.",
            "type":"string"
        },
        "sourceType":{
            "type":"string",
            "description":"External catalog source type.",
            "x-obmcs-top-level-enum":"#/definitions/ExternalCatalogSourceType",
            "enum":[
                "ADW",
                "ALH",
                "KAFKA",
                "ATP",
                "ORACLE",
                "EXADATA"
            ]
        },
        "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"
        },
        "lastRefreshStatus":{
            "description":"The status for last refresh performed on catalog.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CrawlerLastRefreshStatus",
            "enum":[
                "FAILED",
                "SUCCESS",
                "IN_PROGRESS"
            ]
        },
        "timeLastRefresh":{
            "description":"The timestamp for last refresh performed on catalog.",
            "type":"string",
            "format":"date-time"
        }
    }
}

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