Jump to

• Request
• Response

Update schema

put

/20260430/aiDataPlatforms/{aiDataPlatformId}/schemas/{schemaKey}

Updates a schema.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• schemaKey(required): string
  The fully qualified name of the schema in the format ..

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
• 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

Body ()

The information to be updated.

Root Schema : UpdateSchemaDetails

Type: object

The data to update a schema.

Show Source

• description: string
  Schema description.
• displayName: string
  Schema name.
• properties: object properties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing a defined tag key and value.

{
    "description":"The data to update a schema.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Schema name.",
            "type":"string"
        },
        "description":{
            "description":"Schema description.",
            "type":"string"
        },
        "properties":{
            "description":"Key-value pair representing a defined tag key and value.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Key-value pair representing a defined tag key and value.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Key-value pair representing a defined tag key and value.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Requested accepted. Schema is updated.

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.
• opc-work-request-id: string
  The OCID of the asynchronous work request. Use GetWorkRequest with this ID to track the status of the request.

Body ()

Root Schema : Schema

Type: object

Discriminator: entityType

Schema in data catalogs are constructs to organize data. Schema can contain tables, which contain structured data, and volumes, which contain unstructured data. A default schema is created in all standard catalogs created in the Master Catalog. 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

• catalogName: string
  The name of the catalog to which this schema belongs.
• 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 ..
• lifecycleState: string
  Allowed Values: [ "ACTIVE", "CREATING", "DELETING" ]

  The current state of the schema.
• 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 representing a defined tag key and value.
• timeCreated: string(date-time)
  The date and time the schema was created.
• timeUpdated: string(date-time)
  The date and time the schema was updated.
• updatedBy: string
  ID of the user who last updated the schema.

{
    "description":"Schema in data catalogs are constructs to organize data. Schema can contain tables, which contain structured data,\nand volumes, which contain unstructured data. A default schema is created in all standard catalogs created in the\nMaster Catalog. To 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",
    "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"
        },
        "properties":{
            "description":"Key-value pair representing a defined tag key and value.",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "catalogName":{
            "description":"The name of the catalog to which this schema belongs.",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the schema.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/SchemaLifecycleState",
            "enum":[
                "ACTIVE",
                "CREATING",
                "DELETING"
            ]
        },
        "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"
        },
        "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"
            }
        }
    }
}

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.

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Key-value pair representing a defined tag key and value.",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Key-value pair representing a defined tag key and value.

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

405 Response

Method Not Allowed. Request is recognized but not supported.

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

412 Response

Precondition Failed (One or more conditions in request failed).

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