Jump to

• Request
• Response

Create a table

post

/20260430/aiDataPlatforms/{aiDataPlatformId}/tables

Creates a table.

Request

Path Parameters

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

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.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected.
• should-update-recent: boolean
  A flag to identify if the recent list should be updated.

  Default Value: false

Body ()

Details for the new table.

Root Schema : CreateTableDetails

Type: object

The data to create a table.

Show Source

• catalogKey(required): string
  The name of the catalog to which this table belongs.
• description: string
  Table description.
• displayName(required): string
  Table name.
• externalTableDefinition: object ExternalTableDefinition
  The details about the new external table.
• managedTableDefinition: object ManagedTableDefinition
  The details about the new managed table.
• partitionKeys: array partitionKeys
  Maximum Number of Items: 100

  Columns to be used in partition for table.
• schemaKey(required): string
  The name of the schema to which this table belongs.
• tableFields: array tableFields
  Maximum Number of Items: 100

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

  Table properties.
• tableType(required): string
  Allowed Values: [ "MANAGED", "EXTERNAL" ]

  Type of table. Managed, external or mount table.

{
    "description":"The data to create a table.",
    "type":"object",
    "required":[
        "displayName",
        "catalogKey",
        "schemaKey",
        "tableType"
    ],
    "properties":{
        "displayName":{
            "description":"Table name.",
            "type":"string"
        },
        "catalogKey":{
            "description":"The name of the catalog to which this table belongs.",
            "type":"string"
        },
        "schemaKey":{
            "description":"The name of the schema to which this table belongs.",
            "type":"string"
        },
        "description":{
            "description":"Table description.",
            "type":"string"
        },
        "tableType":{
            "description":"Type of table. Managed, external or mount table.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/TableType",
            "enum":[
                "MANAGED",
                "EXTERNAL"
            ]
        },
        "managedTableDefinition":{
            "$ref":"#/definitions/ManagedTableDefinition"
        },
        "externalTableDefinition":{
            "$ref":"#/definitions/ExternalTableDefinition"
        },
        "tableFields":{
            "description":"Columns for table.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/TableFieldDetails"
            }
        },
        "partitionKeys":{
            "description":"Columns to be used in partition for table.",
            "type":"array",
            "maxItems":100,
            "items":{
                "$ref":"#/definitions/TableFieldDetails"
            }
        },
        "tableProperties":{
            "description":"Table properties.",
            "type":"array",
            "maxItems":10,
            "items":{
                "$ref":"#/definitions/TableProperty"
            }
        }
    }
}

Nested Schema : ExternalTableDefinition

Type: object

The details about the new external table.

Show Source

• externalTableDataFormat(required): string
  Allowed Values: [ "AVRO", "ORC", "PARQUET", "TEXTFILE", "JSON", "CSV", "DELTA", "ICEBERG" ]

  External table data format.
• externalTableLocationType: string
  Allowed Values: [ "OBJECT_STORAGE", "MOUNT" ]

  External table location type, either object store location or mount location.
• objectStorageLocationPath: string
  Minimum Length: 1

  Maximum Length: 1024

  The file location from which table properties are loaded.
• txtFileDefinition: object TxtFileDefinition
  Properties specific to a text file.

{
    "description":"The details about the new external table.",
    "type":"object",
    "required":[
        "externalTableDataFormat"
    ],
    "properties":{
        "externalTableLocationType":{
            "type":"string",
            "description":"External table location type, either object store location or mount location.",
            "x-obmcs-top-level-enum":"#/definitions/ExternalTableLocationType",
            "enum":[
                "OBJECT_STORAGE",
                "MOUNT"
            ]
        },
        "objectStorageLocationPath":{
            "description":"The file location from which table properties are loaded.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        },
        "externalTableDataFormat":{
            "description":"External table data format.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DataFormat",
            "enum":[
                "AVRO",
                "ORC",
                "PARQUET",
                "TEXTFILE",
                "JSON",
                "CSV",
                "DELTA",
                "ICEBERG"
            ]
        },
        "txtFileDefinition":{
            "$ref":"#/definitions/TxtFileDefinition"
        }
    }
}

Nested Schema : ManagedTableDefinition

Type: object

The details about the new managed table.

Show Source

• managedTableDataFormat(required): string
  Allowed Values: [ "AVRO", "ORC", "PARQUET", "TEXTFILE", "JSON", "CSV", "DELTA", "ICEBERG" ]

  Data format of the managed table.

{
    "description":"The details about the new managed table.",
    "type":"object",
    "required":[
        "managedTableDataFormat"
    ],
    "properties":{
        "managedTableDataFormat":{
            "description":"Data format of the managed table.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DataFormat",
            "enum":[
                "AVRO",
                "ORC",
                "PARQUET",
                "TEXTFILE",
                "JSON",
                "CSV",
                "DELTA",
                "ICEBERG"
            ]
        }
    }
}

Nested Schema : partitionKeys

Type: array

Maximum Number of Items: 100

Columns to be used in partition for table.

Show Source

• Array of: object TableFieldDetails
  Columns for table.

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

Nested Schema : tableFields

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 : tableProperties

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 : TxtFileDefinition

Type: object

Properties specific to a text file.

Show Source

• delimiter: string
  Minimum Length: 1

  Maximum Length: 255

  Delimiter to be used with text file.
• quote: string
  Minimum Length: 1

  Maximum Length: 255

  Type of quote to be used with text file.

{
    "description":"Properties specific to a text file.",
    "type":"object",
    "properties":{
        "delimiter":{
            "description":"Delimiter to be used with text file.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "quote":{
            "description":"Type of quote to be used with text file.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        }
    }
}

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

Back to Top

Response

Supported Media Types

• application/json

202 Response

Request accepted. Table is created.

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.
• content-location: string(uri-reference)
  Same as location.
• location: string(uri-reference)
  URL for the created Table. The table key is generated after this request is sent.
• 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"
        }
    }
}

409 Response

Conflict. Request conflicts with the current state of the resource.

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