Jump to

• Request
• Response

Get schemas

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/schemas

Returns a list of schemas in a given AI Data Platform Workbench.

Request

Path Parameters

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

Query Parameters

• catalogKey(required): string
  The key of the catalog.
• 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. List of schemas 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 : SchemaCollection

Type: object

Result of listing schemas.

Show Source

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

{
    "type":"object",
    "description":"Result of listing schemas.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of schemas.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SchemaSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of schemas.

Show Source

• Array of: object SchemaSummary
  Discriminator: entityType

  Summary information about a schema.

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

Nested Schema : SchemaSummary

Type: object

Discriminator: entityType

Summary information about a schema.

Show Source

• createdBy: string
  ID of the user who created the schema.
• description: string
  Schema description.
• details: object details
  Additional Properties Allowed: additionalProperties

  Deprecated field. Map of key-value pairs. This object will be only provided when the parent catalog is external.
• displayName(required): string
  Schema name.
• entityType(required): string
  Allowed Values: [ "ADW", "ALH", "STANDARD", "KAFKA_TOPIC", "ATP", "ORACLE", "EXADATA" ]

  An enum to decide the type of the derived model.
• key(required): string
  The fully qualified name of the schema in the format ..
• lastRefreshStatus: string
  Allowed Values: [ "FAILED", "SUCCESS", "IN_PROGRESS" ]

  The status for last refresh performed on schema.
• lifecycleState: string
  Allowed Values: [ "ACTIVE", "CREATING", "DELETING" ]

  The current state of the schema.
• timeCreated: string(date-time)
  The date and time the schema was created.
• timeLastRefresh: string(date-time)
  The timestamp for last refresh performed on schema.
• timeUpdated: string(date-time)
  The date and time the schema was updated.
• updatedBy: string
  ID of the user who last updated the schema.

{
    "description":"Summary information about a schema.",
    "type":"object",
    "discriminator":"entityType",
    "required":[
        "entityType",
        "key",
        "displayName"
    ],
    "properties":{
        "entityType":{
            "description":"An enum to decide the type of the derived model.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/SchemaCatalogType",
            "enum":[
                "ADW",
                "ALH",
                "STANDARD",
                "KAFKA_TOPIC",
                "ATP",
                "ORACLE",
                "EXADATA"
            ]
        },
        "key":{
            "description":"The fully qualified name of the schema in the format <catalog_name>.<schema_name>.",
            "type":"string"
        },
        "displayName":{
            "description":"Schema name.",
            "type":"string"
        },
        "description":{
            "description":"Schema description.",
            "type":"string"
        },
        "timeCreated":{
            "description":"The date and time the schema was created.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The date and time the schema was updated.",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"ID of the user who created the schema.",
            "type":"string"
        },
        "updatedBy":{
            "description":"ID of the user who last updated the schema.",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the schema.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/SchemaLifecycleState",
            "enum":[
                "ACTIVE",
                "CREATING",
                "DELETING"
            ]
        },
        "details":{
            "description":"Deprecated field. Map of key-value pairs. This object will be only provided when the parent catalog is external.",
            "type":"object",
            "x-deprecated":true,
            "additionalProperties":{
                "type":"string"
            }
        },
        "lastRefreshStatus":{
            "description":"The status for last refresh performed on schema.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CrawlerLastRefreshStatus",
            "enum":[
                "FAILED",
                "SUCCESS",
                "IN_PROGRESS"
            ]
        },
        "timeLastRefresh":{
            "description":"The timestamp for last refresh performed on schema.",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : details

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Deprecated field. Map of key-value pairs. This object will be only provided when the parent catalog is external.",
    "type":"object",
    "x-deprecated":true,
    "additionalProperties":{
        "type":"string"
    }
}

Deprecated field. Map of key-value pairs. This object will be only provided when the parent catalog is external.

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