REST API for Oracle AI Data Catalog

Replace a view

post

{scheme}://{host}/{basePath}/v1/{prefix}/namespaces/{namespace}/views/{view}

Commit updates to a view.

Request

Path Parameters

namespace(required): string
A namespace identifier as a single string. Multipart namespace parts must be separated by the namespace separator as indicated via the /config override `namespace-separator`, which defaults to the unit separator `0x1F` byte (url encoded `%1F`). To be compatible with older clients, servers must use both the advertised separator and `0x1F` as valid separators when decoding namespaces. The `namespace-separator` should be provided in a url encoded form.

Examples
prefix(required): string

An optional prefix in the path
view(required): string
A view name
Example:
```
sales
```

Header Parameters

Idempotency-Key: string(uuid)

Optional client-provided idempotency key for safe request retries. When present, the server ensures no additional effects for requests that carry the same Idempotency-Key. If a prior request with this key has been finalized, the server returns an equivalent final response without re-running the operation. The response body may reflect a newer state of the catalog than existed at the time of the commit. Finalization rules: - Finalize & replay: 200, 201, 204, and deterministic terminal 4xx (including 409 such as AlreadyExists, NamespaceNotEmpty, etc.) - Do not finalize (not stored/replayed): 5xx Key Requirements: - Key format: UUIDv7 in string form (RFC 9562). - The idempotency key must be globally unique (no reuse across different operations). - Catalogs SHOULD NOT expire keys before the end of the advertised token lifetime. - If Idempotency-Key is used, clients MUST reuse the same key when retrying the same logical operation and MUST generate a new key for a different operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

identifier: object TableIdentifier
requirements: array requirements
updates(required): array updates

{
    "type":"object",
    "required":[
        "updates"
    ],
    "properties":{
        "identifier":{
            "description":"View identifier to update",
            "$ref":"#/components/schemas/TableIdentifier"
        },
        "requirements":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewRequirement"
            }
        },
        "updates":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewUpdate"
            }
        }
    }
}

Nested Schema : TableIdentifier

Type: object

Show Source

name(required): string
namespace(required): array Namespace

Reference to one or more levels of a namespace

{
    "type":"object",
    "required":[
        "namespace",
        "name"
    ],
    "properties":{
        "namespace":{
            "$ref":"#/components/schemas/Namespace"
        },
        "name":{
            "type":"string",
            "nullable":false
        }
    }
}

Nested Schema : requirements

Type: array

Show Source

Array of: object Discriminator: type

Discriminator: { "propertyName":"type", "mapping":{ "assert-view-uuid":"#/components/schemas/AssertViewUUID" } }

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewRequirement"
    }
}

Nested Schema : updates

Type: array

Show Source

Array of:

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewUpdate"
    }
}

Nested Schema : Namespace

Type: array

Reference to one or more levels of a namespace

Show Source

Array of: string

{
    "description":"Reference to one or more levels of a namespace",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "accounting",
        "tax"
    ]
}

Example:

[
    "accounting",
    "tax"
]

Nested Schema : Discriminator: type

Type: object

Discriminator: type

Discriminator Values

assert-view-uuid

{
    "type":"object",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "assert-view-uuid":"#/components/schemas/AssertViewUUID"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/AssertViewUUID"
        }
    ]
}

Match One Schema

Show Source

assert-view-uuid - object AssertViewUUID

The view UUID must match the requirement's `uuid`

{
    "type":"object",
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "assert-view-uuid":"#/components/schemas/AssertViewUUID"
        }
    },
    "oneOf":[
        {
            "$ref":"#/components/schemas/AssertViewUUID"
        }
    ]
}

Nested Schema : AssertViewUUID

Type: object

The view UUID must match the requirement's `uuid`

Show Source

type(required): string
uuid(required): string

{
    "description":"The view UUID must match the requirement's `uuid`",
    "required":[
        "type",
        "uuid"
    ],
    "properties":{
        "type":{
            "type":"string",
            "const":"assert-view-uuid"
        },
        "uuid":{
            "type":"string"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

View metadata result when loading a view

Root Schema : LoadViewResult

Type: object

Result used when a view is successfully loaded. The view metadata JSON is returned in the `metadata` field. The corresponding file location of view metadata is returned in the `metadata-location` field. Clients can check whether metadata has changed by comparing metadata locations after the view has been created. The `config` map returns view-specific configuration for the view's resources. The following configurations should be respected by clients: ## General Configurations - `token`: Authorization bearer token to use for view requests if OAuth2 security is enabled

Show Source

config: object config

Additional Properties Allowed: additionalProperties
metadata(required): object ViewMetadata
metadata-location(required): string

{
    "description":"Result used when a view is successfully loaded.\n\n\nThe view metadata JSON is returned in the `metadata` field. The corresponding file location of view metadata is returned in the `metadata-location` field.\nClients can check whether metadata has changed by comparing metadata locations after the view has been created.\n\nThe `config` map returns view-specific configuration for the view's resources.\n\nThe following configurations should be respected by clients:\n\n## General Configurations\n\n- `token`: Authorization bearer token to use for view requests if OAuth2 security is enabled\n",
    "type":"object",
    "required":[
        "metadata-location",
        "metadata"
    ],
    "properties":{
        "metadata-location":{
            "type":"string"
        },
        "metadata":{
            "$ref":"#/components/schemas/ViewMetadata"
        },
        "config":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : config

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : ViewMetadata

Type: object

Show Source

current-version-id(required): integer
format-version(required): integer

Minimum Value: 1

Maximum Value: 1
location(required): string
properties: object properties

Additional Properties Allowed: additionalProperties
schemas(required): array schemas
version-log(required): array version-log
versions(required): array versions
view-uuid(required): string

{
    "type":"object",
    "required":[
        "view-uuid",
        "format-version",
        "location",
        "current-version-id",
        "versions",
        "version-log",
        "schemas"
    ],
    "properties":{
        "view-uuid":{
            "type":"string"
        },
        "format-version":{
            "type":"integer",
            "minimum":1,
            "maximum":1
        },
        "location":{
            "type":"string"
        },
        "current-version-id":{
            "type":"integer"
        },
        "versions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewVersion"
            }
        },
        "version-log":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewHistoryEntry"
            }
        },
        "schemas":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Schema"
            }
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : schemas

Type: array

Show Source

Array of: Schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Schema"
    }
}

Nested Schema : version-log

Type: array

Show Source

Array of: object ViewHistoryEntry

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewHistoryEntry"
    }
}

Nested Schema : versions

Type: array

Show Source

Array of: object ViewVersion

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewVersion"
    }
}

Nested Schema : Schema

Match All

Show Source

object StructType
object Schema-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/StructType"
        },
        {
            "type":"object",
            "properties":{
                "schema-id":{
                    "type":"integer",
                    "readOnly":true
                },
                "identifier-field-ids":{
                    "type":"array",
                    "items":{
                        "type":"integer"
                    }
                }
            }
        }
    ]
}

Nested Schema : StructType

Type: object

Show Source

fields(required): array fields
type(required): string

{
    "type":"object",
    "required":[
        "type",
        "fields"
    ],
    "properties":{
        "type":{
            "type":"string",
            "const":"struct"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StructField"
            }
        }
    }
}

Nested Schema : Schema-allOf[1]

Type: object

Show Source

identifier-field-ids: array identifier-field-ids
schema-id: integer

Read Only: true

{
    "type":"object",
    "properties":{
        "schema-id":{
            "type":"integer",
            "readOnly":true
        },
        "identifier-field-ids":{
            "type":"array",
            "items":{
                "type":"integer"
            }
        }
    }
}

Nested Schema : fields

Type: array

Show Source

Array of: object StructField

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/StructField"
    }
}

Nested Schema : StructField

Type: object

Show Source

doc: string
id(required): integer
initial-default: PrimitiveTypeValue
name(required): string
required(required): boolean
type(required): Type
write-default: PrimitiveTypeValue

{
    "type":"object",
    "required":[
        "id",
        "name",
        "type",
        "required"
    ],
    "properties":{
        "id":{
            "type":"integer"
        },
        "name":{
            "type":"string"
        },
        "type":{
            "$ref":"#/components/schemas/Type"
        },
        "required":{
            "type":"boolean"
        },
        "doc":{
            "type":"string"
        },
        "initial-default":{
            "$ref":"#/components/schemas/PrimitiveTypeValue"
        },
        "write-default":{
            "$ref":"#/components/schemas/PrimitiveTypeValue"
        }
    }
}

Nested Schema : PrimitiveTypeValue

Match One Schema

Show Source

boolean

Title: BooleanTypeValue

Example: true
integer

Title: IntegerTypeValue

Example: 42
integer(int64)

Title: LongTypeValue

Example: 9223372036854776000
number(float)

Title: FloatTypeValue

Example: 3.14
number(double)

Title: DoubleTypeValue

Example: 123.456
string

Title: DecimalTypeValue

Decimal type values are serialized as strings. Decimals with a positive scale serialize as numeric plain text, while decimals with a negative scale use scientific notation and the exponent will be equal to the negated scale. For instance, a decimal with a positive scale is '123.4500', with zero scale is '2', and with a negative scale is '2E+20'

Example: 123.45
string

Title: StringTypeValue

Example: hello
string(uuid)

Title: UUIDTypeValue

Minimum Length: 36

Maximum Length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122

Example: eb26bdb1-a1d8-4aa6-990e-da940875492c
string(date)

Title: DateTypeValue

Date type values follow the 'YYYY-MM-DD' ISO-8601 standard date format

Example: 2007-12-03
string

Title: TimeTypeValue

Time type values follow the 'HH:MM:SS.ssssss' ISO-8601 format with microsecond precision

Example: 22:31:08.123456
string

Title: TimestampTypeValue

Timestamp type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss' ISO-8601 format with microsecond precision

Example: 2007-12-03T10:15:30.123456
string

Title: TimestampTzTypeValue

TimestampTz type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss+00:00' ISO-8601 format with microsecond precision, and a timezone offset (+00:00 for UTC)

Example: 2007-12-03T10:15:30.123456+00:00
string

Title: TimestampNanoTypeValue

Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss' ISO-8601 format with nanosecond precision

Example: 2007-12-03T10:15:30.123456789
string

Title: TimestampTzNanoTypeValue

Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss+00:00' ISO-8601 format with nanosecond precision, and a timezone offset (+00:00 for UTC)

Example: 2007-12-03T10:15:30.123456789+00:00
string

Title: FixedTypeValue

Fixed length type values are stored and serialized as an uppercase hexadecimal string preserving the fixed length

Example: 78797A
string

Title: BinaryTypeValue

Binary type values are stored and serialized as an uppercase hexadecimal string

Example: 78797A

{
    "oneOf":[
        {
            "type":"boolean",
            "example":true,
            "title":"BooleanTypeValue"
        },
        {
            "type":"integer",
            "example":42,
            "title":"IntegerTypeValue"
        },
        {
            "type":"integer",
            "format":"int64",
            "example":"9223372036854776000",
            "title":"LongTypeValue"
        },
        {
            "type":"number",
            "format":"float",
            "example":3.14,
            "title":"FloatTypeValue"
        },
        {
            "type":"number",
            "format":"double",
            "example":123.456,
            "title":"DoubleTypeValue"
        },
        {
            "type":"string",
            "description":"Decimal type values are serialized as strings. Decimals with a positive scale serialize as numeric plain text, while decimals with a negative scale use scientific notation and the exponent will be equal to the negated scale. For instance, a decimal with a positive scale is '123.4500', with zero scale is '2', and with a negative scale is '2E+20'",
            "example":123.45,
            "title":"DecimalTypeValue"
        },
        {
            "type":"string",
            "example":"hello",
            "title":"StringTypeValue"
        },
        {
            "type":"string",
            "format":"uuid",
            "pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
            "maxLength":36,
            "minLength":36,
            "description":"UUID type values are serialized as a 36-character lowercase string in standard UUID format as specified by RFC-4122",
            "example":"eb26bdb1-a1d8-4aa6-990e-da940875492c",
            "title":"UUIDTypeValue"
        },
        {
            "type":"string",
            "format":"date",
            "description":"Date type values follow the 'YYYY-MM-DD' ISO-8601 standard date format",
            "example":"2007-12-03",
            "title":"DateTypeValue"
        },
        {
            "type":"string",
            "description":"Time type values follow the 'HH:MM:SS.ssssss' ISO-8601 format with microsecond precision",
            "example":"22:31:08.123456",
            "title":"TimeTypeValue"
        },
        {
            "type":"string",
            "description":"Timestamp type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss' ISO-8601 format with microsecond precision",
            "example":"2007-12-03T10:15:30.123456",
            "title":"TimestampTypeValue"
        },
        {
            "type":"string",
            "description":"TimestampTz type values follow the 'YYYY-MM-DDTHH:MM:SS.ssssss+00:00' ISO-8601 format with microsecond precision, and a timezone offset (+00:00 for UTC)",
            "example":"2007-12-03T10:15:30.123456+00:00",
            "title":"TimestampTzTypeValue"
        },
        {
            "type":"string",
            "description":"Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss' ISO-8601 format with nanosecond precision",
            "example":"2007-12-03T10:15:30.123456789",
            "title":"TimestampNanoTypeValue"
        },
        {
            "type":"string",
            "description":"Timestamp_ns type values follow the 'YYYY-MM-DDTHH:MM:SS.sssssssss+00:00' ISO-8601 format with nanosecond precision, and a timezone offset (+00:00 for UTC)",
            "example":"2007-12-03T10:15:30.123456789+00:00",
            "title":"TimestampTzNanoTypeValue"
        },
        {
            "type":"string",
            "description":"Fixed length type values are stored and serialized as an uppercase hexadecimal string preserving the fixed length",
            "example":"78797A",
            "title":"FixedTypeValue"
        },
        {
            "type":"string",
            "description":"Binary type values are stored and serialized as an uppercase hexadecimal string",
            "example":"78797A",
            "title":"BinaryTypeValue"
        }
    ]
}

Nested Schema : Type

Match One Schema

Show Source

string

Title: PrimitiveType

Example: [ "long", "string", "fixed[16]", "decimal(10,2)" ]
object StructType

Title: StructType
object ListType

Title: ListType
object MapType

Title: MapType

{
    "oneOf":[
        {
            "type":"string",
            "example":[
                "long",
                "string",
                "fixed[16]",
                "decimal(10,2)"
            ],
            "title":"PrimitiveType"
        },
        {
            "type":"object",
            "required":[
                "type",
                "fields"
            ],
            "properties":{
                "type":{
                    "type":"string",
                    "const":"struct"
                },
                "fields":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/StructField"
                    }
                }
            },
            "title":"StructType"
        },
        {
            "type":"object",
            "required":[
                "type",
                "element-id",
                "element",
                "element-required"
            ],
            "properties":{
                "type":{
                    "type":"string",
                    "const":"list"
                },
                "element-id":{
                    "type":"integer"
                },
                "element":{
                    "$ref":"#/components/schemas/Type"
                },
                "element-required":{
                    "type":"boolean"
                }
            },
            "title":"ListType"
        },
        {
            "type":"object",
            "required":[
                "type",
                "key-id",
                "key",
                "value-id",
                "value",
                "value-required"
            ],
            "properties":{
                "type":{
                    "type":"string",
                    "const":"map"
                },
                "key-id":{
                    "type":"integer"
                },
                "key":{
                    "$ref":"#/components/schemas/Type"
                },
                "value-id":{
                    "type":"integer"
                },
                "value":{
                    "$ref":"#/components/schemas/Type"
                },
                "value-required":{
                    "type":"boolean"
                }
            },
            "title":"MapType"
        }
    ]
}

Nested Schema : StructType

Type: object

Title: StructType

Show Source

fields(required): array fields
type(required): string

{
    "type":"object",
    "required":[
        "type",
        "fields"
    ],
    "properties":{
        "type":{
            "type":"string",
            "const":"struct"
        },
        "fields":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StructField"
            }
        }
    },
    "title":"StructType"
}

Nested Schema : ListType

Type: object

Title: ListType

Show Source

element(required): Type
element-id(required): integer
element-required(required): boolean
type(required): string

{
    "type":"object",
    "required":[
        "type",
        "element-id",
        "element",
        "element-required"
    ],
    "properties":{
        "type":{
            "type":"string",
            "const":"list"
        },
        "element-id":{
            "type":"integer"
        },
        "element":{
            "$ref":"#/components/schemas/Type"
        },
        "element-required":{
            "type":"boolean"
        }
    },
    "title":"ListType"
}

Nested Schema : MapType

Type: object

Title: MapType

Show Source

key(required): Type
key-id(required): integer
type(required): string
value(required): Type
value-id(required): integer
value-required(required): boolean

{
    "type":"object",
    "required":[
        "type",
        "key-id",
        "key",
        "value-id",
        "value",
        "value-required"
    ],
    "properties":{
        "type":{
            "type":"string",
            "const":"map"
        },
        "key-id":{
            "type":"integer"
        },
        "key":{
            "$ref":"#/components/schemas/Type"
        },
        "value-id":{
            "type":"integer"
        },
        "value":{
            "$ref":"#/components/schemas/Type"
        },
        "value-required":{
            "type":"boolean"
        }
    },
    "title":"MapType"
}

Nested Schema : fields

Type: array

Show Source

Array of: object StructField

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/StructField"
    }
}

Nested Schema : identifier-field-ids

Type: array

Show Source

Array of: integer

{
    "type":"array",
    "items":{
        "type":"integer"
    }
}

Nested Schema : ViewHistoryEntry

Type: object

Show Source

timestamp-ms(required): integer (int64)
version-id(required): integer

{
    "type":"object",
    "required":[
        "version-id",
        "timestamp-ms"
    ],
    "properties":{
        "version-id":{
            "type":"integer"
        },
        "timestamp-ms":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : ViewVersion

Type: object

Show Source

default-catalog: string
default-namespace(required): array Namespace

Reference to one or more levels of a namespace
representations(required): array representations
schema-id(required): integer

Schema ID to set as current, or -1 to set last added schema
summary(required): object summary

Additional Properties Allowed: additionalProperties
timestamp-ms(required): integer (int64)
version-id(required): integer

{
    "type":"object",
    "required":[
        "version-id",
        "timestamp-ms",
        "schema-id",
        "summary",
        "representations",
        "default-namespace"
    ],
    "properties":{
        "version-id":{
            "type":"integer"
        },
        "timestamp-ms":{
            "type":"integer",
            "format":"int64"
        },
        "schema-id":{
            "type":"integer",
            "description":"Schema ID to set as current, or -1 to set last added schema"
        },
        "summary":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "representations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ViewRepresentation"
            }
        },
        "default-catalog":{
            "type":"string"
        },
        "default-namespace":{
            "$ref":"#/components/schemas/Namespace"
        }
    }
}

Nested Schema : Namespace

Type: array

Reference to one or more levels of a namespace

Show Source

Array of: string

{
    "description":"Reference to one or more levels of a namespace",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":[
        "accounting",
        "tax"
    ]
}

Example:

[
    "accounting",
    "tax"
]

Nested Schema : representations

Type: array

Show Source

Array of: ViewRepresentation

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ViewRepresentation"
    }
}

Nested Schema : summary

Type: object

Additional Properties Allowed

Show Source

string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : ViewRepresentation

Match One Schema

Show Source

object SQLViewRepresentation

Title: SQLViewRepresentation

{
    "oneOf":[
        {
            "type":"object",
            "required":[
                "type",
                "sql",
                "dialect"
            ],
            "properties":{
                "type":{
                    "type":"string"
                },
                "sql":{
                    "type":"string"
                },
                "dialect":{
                    "type":"string"
                }
            },
            "title":"SQLViewRepresentation"
        }
    ]
}

Nested Schema : SQLViewRepresentation

Type: object

Title: SQLViewRepresentation

Show Source

dialect(required): string
sql(required): string
type(required): string

{
    "type":"object",
    "required":[
        "type",
        "sql",
        "dialect"
    ],
    "properties":{
        "type":{
            "type":"string"
        },
        "sql":{
            "type":"string"
        },
        "dialect":{
            "type":"string"
        }
    },
    "title":"SQLViewRepresentation"
}

400 Response

Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware.

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

error(required): object ErrorModel

JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

code(required): integer

Minimum Value: 400

Maximum Value: 600

HTTP response code

Example: 404
message(required): string

Human-readable error message
stack: array stack
type(required): string

Internal type definition of the error

Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized. The REST Catalog SHOULD respond with the 401 UnauthorizedResponse when the access token provided is expired, revoked, malformed, or invalid for other reasons. The client MAY request a new access token and retry the request.

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

error(required): object ErrorModel

JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

code(required): integer

Minimum Value: 400

Maximum Value: 600

HTTP response code

Example: 404
message(required): string

Human-readable error message
stack: array stack
type(required): string

Internal type definition of the error

Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

403 Response

Forbidden. Authenticated user does not have the necessary permissions.

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

error(required): object ErrorModel

JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

code(required): integer

Minimum Value: 400

Maximum Value: 600

HTTP response code

Example: 404
message(required): string

Human-readable error message
stack: array stack
type(required): string

Internal type definition of the error

Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

Not Found - NoSuchViewException, view to load does not exist

Root Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

code(required): integer

Minimum Value: 400

Maximum Value: 600

HTTP response code

Example: 404
message(required): string

Human-readable error message
stack: array stack
type(required): string

Internal type definition of the error

Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Examples

409 Response

Conflict - CommitFailedException. The client may retry.

Root Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

code(required): integer

Minimum Value: 400

Maximum Value: 600

HTTP response code

Example: 404
message(required): string

Human-readable error message
stack: array stack
type(required): string

Internal type definition of the error

Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

419 Response

This is an optional status response type that the REST Catalog can issue when the token has expired. The client MAY request a new access token and retry the request. 401 UnauthorizedResponse SHOULD be preferred over this response type on token expiry.

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

error(required): object ErrorModel

JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

code(required): integer

Minimum Value: 400

Maximum Value: 600

HTTP response code

Example: 404
message(required): string

Human-readable error message
stack: array stack
type(required): string

Internal type definition of the error

Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

500 Response

An unknown server-side problem occurred; the commit state is unknown.

Root Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

code(required): integer

Minimum Value: 400

Maximum Value: 600

HTTP response code

Example: 404
message(required): string

Human-readable error message
stack: array stack
type(required): string

Internal type definition of the error

Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

502 Response

A gateway or proxy received an invalid response from the upstream server; the commit state is unknown.

Root Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

code(required): integer

Minimum Value: 400

Maximum Value: 600

HTTP response code

Example: 404
message(required): string

Human-readable error message
stack: array stack
type(required): string

Internal type definition of the error

Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

503 Response

The service is not ready to handle the request, request could have been partially processed. The service may additionally send a Retry-After header to indicate when to retry, a non idempotent request should only be retried by the client when the Retry-After header is present.

Root Schema : IcebergErrorResponse

Type: object

JSON wrapper for all error responses (non-2xx)

Show Source

error(required): object ErrorModel

JSON error payload returned in a response with further details on the error

{
    "description":"JSON wrapper for all error responses (non-2xx)",
    "type":"object",
    "required":[
        "error"
    ],
    "properties":{
        "error":{
            "$ref":"#/components/schemas/ErrorModel"
        }
    },
    "additionalProperties":false,
    "example":{
        "error":{
            "message":"The server does not support this operation",
            "type":"UnsupportedOperationException",
            "code":406
        }
    }
}

Example:

{
    "error":{
        "message":"The server does not support this operation",
        "type":"UnsupportedOperationException",
        "code":406
    }
}

Nested Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

code(required): integer

Minimum Value: 400

Maximum Value: 600

HTTP response code

Example: 404
message(required): string

Human-readable error message
stack: array stack
type(required): string

Internal type definition of the error

Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

504 Response

A server-side gateway timeout occurred; the commit state is unknown.

Root Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

code(required): integer

Minimum Value: 400

Maximum Value: 600

HTTP response code

Example: 404
message(required): string

Human-readable error message
stack: array stack
type(required): string

Internal type definition of the error

Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

5XX Response

A server-side problem that might not be addressable on the client.

Root Schema : ErrorModel

Type: object

JSON error payload returned in a response with further details on the error

Show Source

code(required): integer

Minimum Value: 400

Maximum Value: 600

HTTP response code

Example: 404
message(required): string

Human-readable error message
stack: array stack
type(required): string

Internal type definition of the error

Example: NoSuchNamespaceException

{
    "type":"object",
    "description":"JSON error payload returned in a response with further details on the error",
    "required":[
        "message",
        "type",
        "code"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable error message"
        },
        "type":{
            "type":"string",
            "description":"Internal type definition of the error",
            "example":"NoSuchNamespaceException"
        },
        "code":{
            "type":"integer",
            "minimum":400,
            "maximum":600,
            "description":"HTTP response code",
            "example":404
        },
        "stack":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : stack

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}