Jump to

• Request
• Response

Get table schema and data

post

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

Returns table schema and data from the specified location.

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

• 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 ()

Details of the location from which the table schema and data can be inferred.

Root Schema : PerformInferSchemaDetails

Type: object

Infer schema details.

Show Source

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

  Data format of the schema location.
• inferSchemaProperties: array inferSchemaProperties
  Properties which are needed for inferring schema.
• location(required): string
  Location of the table to infer schema.
• numberOfPartitions: integer
  Number of root partition folders to scan.

{
    "description":"Infer schema details.",
    "type":"object",
    "required":[
        "dataFormat",
        "location"
    ],
    "properties":{
        "dataFormat":{
            "description":"Data format of the schema location.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/DataFormat",
            "enum":[
                "AVRO",
                "ORC",
                "PARQUET",
                "TEXTFILE",
                "JSON",
                "CSV",
                "DELTA",
                "ICEBERG"
            ]
        },
        "location":{
            "description":"Location of the table to infer schema.",
            "type":"string"
        },
        "numberOfPartitions":{
            "description":"Number of root partition folders to scan.",
            "type":"integer"
        },
        "inferSchemaProperties":{
            "description":"Properties which are needed for inferring schema.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InferSchemaProperties"
            }
        }
    }
}

Nested Schema : inferSchemaProperties

Type: array

Properties which are needed for inferring schema.

Show Source

• Array of: object InferSchemaProperties
  Properties to be supplied for infer schema.

{
    "description":"Properties which are needed for inferring schema.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/InferSchemaProperties"
    }
}

Nested Schema : InferSchemaProperties

Type: object

Properties to be supplied for infer schema.

Show Source

• propertyName: string
  Minimum Length: 1

  Maximum Length: 255

  Name of the property.
• propertyValue: string
  Minimum Length: 1

  Maximum Length: 255

  Property value.

{
    "description":"Properties to be supplied for infer schema.",
    "type":"object",
    "properties":{
        "propertyName":{
            "description":"Name of the property.",
            "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

200 Response

Successful operation. Table schema and data are retrieved.

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.

Body ()

Root Schema : InferSchemaWithPreview

Type: object

Inferred schema and data.

Show Source

• data(required): array data
  Sample preview data.
• schema(required): array schema
  Column information obtained by inferring schema.

{
    "description":"Inferred schema and data.",
    "type":"object",
    "required":[
        "schema",
        "data"
    ],
    "properties":{
        "schema":{
            "description":"Column information obtained by inferring schema.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/InferSchemaColumn"
            }
        },
        "data":{
            "description":"Sample preview data.",
            "type":"array",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    }
}

Nested Schema : data

Type: array

Sample preview data.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "description":"Sample preview data.",
    "type":"array",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : schema

Type: array

Column information obtained by inferring schema.

Show Source

• Array of: object InferSchemaColumn
  Column inferred from location.

{
    "description":"Column information obtained by inferring schema.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/InferSchemaColumn"
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

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

Nested Schema : InferSchemaColumn

Type: object

Column inferred from location.

Show Source

• fieldName: string
  Minimum Length: 1

  Maximum Length: 767

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

  Maximum Length: 9999

  Type of the column.
• isPartition: boolean
  Boolean value indicating if this column is partition column.
• rank: integer
  For partition columns rank value indicates level, for non-partition column the value will be zero.

{
    "description":"Column inferred from location.",
    "type":"object",
    "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
        },
        "isPartition":{
            "description":"Boolean value indicating if this column is partition column.",
            "type":"boolean"
        },
        "rank":{
            "description":"For partition columns rank value indicates level, for non-partition column the value will be zero.",
            "type":"integer"
        }
    }
}

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