Jump to

• Request
• Response

Update a table

put

/20260430/aiDataPlatforms/{aiDataPlatformId}/tables/{tableKey}

Updates a table with provided details.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• tableKey(required): string
  The fully qualified name of the table 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 : UpdateTableDetails

Type: object

The data to update a table.

Show Source

• addTableFields: array addTableFields
  Maximum Number of Items: 100

  Columns for table.
• addTableProperties: array addTableProperties
  Maximum Number of Items: 10

  Table properties.
• description: string
  Table description.
• displayName: string
  Table name.
• dropTableFields: array dropTableFields
  Maximum Number of Items: 100

  Columns for table.
• dropTableProperties: array dropTableProperties
  Maximum Number of Items: 10

  Table properties.
• renameTableFields: array renameTableFields
  Maximum Number of Items: 100

  Columns for table.
• updateTableFields: array updateTableFields
  Maximum Number of Items: 100

  Update columns in table.

{
    "description":"The data to update a table.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"Table name.",
            "type":"string"
        },
        "description":{
            "description":"Table description.",
            "type":"string"
        },
        "addTableFields":{
            "description":"Columns for table.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/TableFieldDetails"
            }
        },
        "dropTableFields":{
            "description":"Columns for table.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/TableFieldDetails"
            }
        },
        "renameTableFields":{
            "description":"Columns for table.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/RenameTableFieldDetails"
            }
        },
        "addTableProperties":{
            "description":"Table properties.",
            "type":"array",
            "maxItems":10,
            "items":{
                "$ref":"#/definitions/TableProperty"
            }
        },
        "dropTableProperties":{
            "description":"Table properties.",
            "type":"array",
            "maxItems":10,
            "items":{
                "$ref":"#/definitions/TableProperty"
            }
        },
        "updateTableFields":{
            "description":"Update columns in table.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/UpdateTableFieldDetails"
            }
        }
    }
}

Nested Schema : addTableFields

Type: array

Maximum Number of Items: 100

Columns for table.

Show Source

• Array of: object TableFieldDetails
  Columns for table.

{
    "description":"Columns for table.",
    "type":"array",
    "maxItems":100,
    "items":{
        "$ref":"#/definitions/TableFieldDetails"
    }
}

Nested Schema : addTableProperties

Type: array

Maximum Number of Items: 10

Table properties.

Show Source

• Array of: object TableProperty
  The property of the table.

{
    "description":"Table properties.",
    "type":"array",
    "maxItems":10,
    "items":{
        "$ref":"#/definitions/TableProperty"
    }
}

Nested Schema : dropTableFields

Type: array

Maximum Number of Items: 100

Columns for table.

Show Source

• Array of: object TableFieldDetails
  Columns for table.

{
    "description":"Columns for table.",
    "type":"array",
    "maxItems":100,
    "items":{
        "$ref":"#/definitions/TableFieldDetails"
    }
}

Nested Schema : dropTableProperties

Type: array

Maximum Number of Items: 10

Table properties.

Show Source

• Array of: object TableProperty
  The property of the table.

{
    "description":"Table properties.",
    "type":"array",
    "maxItems":10,
    "items":{
        "$ref":"#/definitions/TableProperty"
    }
}

Nested Schema : renameTableFields

Type: array

Maximum Number of Items: 100

Columns for table.

Show Source

• Array of: object RenameTableFieldDetails
  Details for renaming column of a table.

{
    "description":"Columns for table.",
    "type":"array",
    "maxItems":100,
    "items":{
        "$ref":"#/definitions/RenameTableFieldDetails"
    }
}

Nested Schema : updateTableFields

Type: array

Maximum Number of Items: 100

Update columns in table.

Show Source

• Array of: object UpdateTableFieldDetails
  Details for updating column of a table.

{
    "description":"Update columns in table.",
    "type":"array",
    "maxItems":100,
    "items":{
        "$ref":"#/definitions/UpdateTableFieldDetails"
    }
}

Nested Schema : TableFieldDetails

Type: object

Columns for table.

Show Source

• fieldDescription: string
  Description of the column.
• fieldName(required): string
  Minimum Length: 1

  Maximum Length: 767

  Name of the column.
• fieldPrecision: string
  Minimum Length: 1

  Maximum Length: 64

  Precision of the column.
• fieldScale: string
  Minimum Length: 1

  Maximum Length: 64

  Scale of the column.
• fieldType: string
  Minimum Length: 1

  Maximum Length: 9999

  Type of the column.

{
    "description":"Columns for table.",
    "type":"object",
    "required":[
        "fieldName"
    ],
    "properties":{
        "fieldName":{
            "description":"Name of the column.",
            "type":"string",
            "minLength":1,
            "maxLength":767
        },
        "fieldType":{
            "description":"Type of the column.",
            "type":"string",
            "minLength":1,
            "maxLength":9999
        },
        "fieldPrecision":{
            "description":"Precision of the column.",
            "type":"string",
            "minLength":1,
            "maxLength":64
        },
        "fieldScale":{
            "description":"Scale of the column.",
            "type":"string",
            "minLength":1,
            "maxLength":64
        },
        "fieldDescription":{
            "description":"Description of the column.",
            "type":"string"
        }
    }
}

Nested Schema : TableProperty

Type: object

The property of the table.

Show Source

• propertyName(required): string
  Minimum Length: 1

  Maximum Length: 255

  Property name.
• propertyValue: string
  Minimum Length: 1

  Maximum Length: 255

  Property value.

{
    "description":"The property of the table.",
    "type":"object",
    "required":[
        "propertyName"
    ],
    "properties":{
        "propertyName":{
            "description":"Property name.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "propertyValue":{
            "description":"Property value.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        }
    }
}

Nested Schema : RenameTableFieldDetails

Type: object

Details for renaming column of a table.

Show Source

• fieldName(required): string
  Minimum Length: 1

  Maximum Length: 767

  Name of the column.
• updatedFieldName(required): string
  Minimum Length: 1

  Maximum Length: 767

  Updated name of the column.

{
    "description":"Details for renaming column of a table.",
    "type":"object",
    "required":[
        "fieldName",
        "updatedFieldName"
    ],
    "properties":{
        "fieldName":{
            "description":"Name of the column.",
            "type":"string",
            "minLength":1,
            "maxLength":767
        },
        "updatedFieldName":{
            "description":"Updated name of the column.",
            "type":"string",
            "minLength":1,
            "maxLength":767
        }
    }
}

Nested Schema : UpdateTableFieldDetails

Type: object

Details for updating column of a table.

Show Source

• fieldDescription: string
  Description of the column.
• fieldName(required): string
  Minimum Length: 1

  Maximum Length: 767

  Name of the column.

{
    "description":"Details for updating column of a table.",
    "type":"object",
    "required":[
        "fieldName"
    ],
    "properties":{
        "fieldName":{
            "description":"Name of the column.",
            "type":"string",
            "minLength":1,
            "maxLength":767
        },
        "fieldDescription":{
            "description":"Description of the column.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Request accepted. Table is updated.

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

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