Pre-General Availability: 2022-08-18. This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Jump to

• Request
• Response

Get Table

get

/20211130/projects/{projectId}/schemas/{schemaId}/tables/{tableId}

Gets a Table resource by identifier

Request

Path Parameters

• projectId: string
  Project OCID
• schemaId: string
  unique Schema identifier
• tableId: string
  unique Table identifier

Header Parameters

• opc-request-id: string
  The client request ID for tracing.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieves the Table resource with the given id

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• 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.

Body ()

Root Schema : Table

Type: object

Table resource

Show Source

• dataCatalogLogicalEntityId(optional): string
  OCID of the Data Catalog logical entity
• definedTags(optional): object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  Name of the Table resource
• fileFormat(optional): string
  Minimum Length: 3

  Maximum Length: 25

  The type format File - as currently supported by external tables.
• fileFormatParams(optional): object TextFileFormatParams
  Format Parameters for text files
• freeformTags(optional): object freeformTags
  Additional Properties Allowed: additionalProperties

  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
• id: string
  Minimum Length: 6

  Maximum Length: 255

  The uuid of the Table resource
• lifecycleState: string
  Allowed Values: [ "CREATING", "ACTIVE", "UPDATING", "DELETED", "DELETING", "FAILED" ]

  The current state of the Table resource.
• tableColumns(optional): array tableColumns
  Columns of a table
• targetObjectStoreFileGlob(optional): string
  Minimum Length: 1

  Maximum Length: 255

  The target object store file glob - as currently supported by external tables
• timeCreated: string(date-time)
  The time the Table instance was created. An RFC3339 formatted datetime string

  Example: 2019-03-29T09:36:42.000Z
• timeUpdated(optional): string(date-time)
  The time the Table instance was updated. An RFC3339 formatted datetime string

  Example: 2019-03-29T09:36:42.000Z

{
    "description":"Table resource",
    "x-obmcs-splat":{
        "resourceKind":"query-table",
        "adLocality":"regional",
        "ocidEntityType":"notreviewedplaceholder",
        "activeLifecycleStates":[
            "active"
        ],
        "deletedLifecycleStates":[
            "deleted"
        ],
        "getOperationId":"GetTable",
        "listResourcesOperationId":"ListTables"
    },
    "required":[
        "id",
        "displayName",
        "lifecycleState",
        "timeCreated"
    ],
    "properties":{
        "id":{
            "description":"The uuid of the Table resource",
            "type":"string",
            "minLength":6,
            "maxLength":255
        },
        "displayName":{
            "description":"Name of the Table resource",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "lifecycleState":{
            "description":"The current state of the Table resource.",
            "type":"string",
            "enum":[
                "CREATING",
                "ACTIVE",
                "UPDATING",
                "DELETED",
                "DELETING",
                "FAILED"
            ]
        },
        "timeCreated":{
            "description":"The time the Table instance was created. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time",
            "example":"2019-03-29T09:36:42.000Z"
        },
        "timeUpdated":{
            "description":"The time the Table instance was updated. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time",
            "example":"2019-03-29T09:36:42.000Z"
        },
        "tableColumns":{
            "description":"Columns of a table",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TableColumn"
            }
        },
        "dataCatalogLogicalEntityId":{
            "description":"OCID of the Data Catalog logical entity",
            "type":"string"
        },
        "targetObjectStoreFileGlob":{
            "description":"The target object store file glob - as currently supported by external tables",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "fileFormat":{
            "description":"The type format File - as currently supported by external tables.",
            "type":"string",
            "minLength":3,
            "maxLength":25
        },
        "fileFormatParams":{
            "$ref":"#/definitions/TextFileFormatParams"
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined name, type or scope.\nExists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
                }
            }
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
        }
    }
}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Nested Schema : TextFileFormatParams

Type: object

Format Parameters for text files

Show Source

• characterset(optional): string
  Specifies the characterset of source files.
• conversionErrors(optional): string
  Allowed Values: [ "REJECT_RECORD", "STORE_NULL" ]

  If a row is rejected because of data type conversion errors, the related columns are stored as null or the row is rejected.
• dateformat(optional): string
  Specifies the date format in the source file.
• fieldDelimiter(optional): string
  Minimum Length: 1

  Maximum Length: 1

  Specifies the field delimiter
• isEscapeCharacter(optional): boolean
  Default Value: true

  The character "\" is used as the escape character when specified.
• isIgnoreBlankLines(optional): boolean
  Default Value: true

  Blank lines are ignored when set to true.
• isRemoveQuotes(optional): boolean
  Default Value: true

  Removes any quotes that are around any field in the source file.
• isSpaceAsNull(optional): boolean
  Default Value: true

  When set to true, loads fields consisting of spaces as null.
• isTruncateCol(optional): boolean
  Default Value: true

  If the data in the file is too long for a field, then this option will truncate the value of the field rather than reject the row.
• quote(optional): string
  Minimum Length: 1

  Maximum Length: 1

  Specifies the quote character for the fields, the quote characters are removed during loading when specified.
• recordDelimiter(optional): string
  Minimum Length: 1

  Maximum Length: 1

  Specifies the record delimiter.
• rejectLimit(optional): integer
  The operation will error out after specified number of rows are rejected.
• skipRows(optional): integer
  Specifies how many rows should be skipped from the start of the file.
• timestampformat(optional): string
  Specifies the timestamp format in the source file.
• timestampltzformat(optional): string
  Specifies the timestamp with local timezone format in the source file.
• timestamptzformat(optional): string
  Specifies the timestamp with timezone format in the source file.
• trimSpaces(optional): string
  Allowed Values: [ "RTRIM", "LTRIM", "NOTRIM", "LRTRIM", "LDRTRIM" ]

  Specifies how the leading and trailing spaces of the fields are trimmed.

{
    "description":"Format Parameters for text files",
    "properties":{
        "conversionErrors":{
            "description":"If a row is rejected because of data type conversion errors, the related columns are stored as null or the row is rejected.",
            "type":"string",
            "enum":[
                "REJECT_RECORD",
                "STORE_NULL"
            ]
        },
        "fieldDelimiter":{
            "description":"Specifies the field delimiter",
            "type":"string",
            "minLength":1,
            "maxLength":1
        },
        "isEscapeCharacter":{
            "description":"The character \"\\\" is used as the escape character when specified.",
            "type":"boolean",
            "default":true
        },
        "isIgnoreBlankLines":{
            "description":"Blank lines are ignored when set to true.",
            "type":"boolean",
            "default":true
        },
        "isRemoveQuotes":{
            "description":"Removes any quotes that are around any field in the source file.",
            "type":"boolean",
            "default":true
        },
        "isSpaceAsNull":{
            "description":"When set to true, loads fields consisting of spaces as null.",
            "type":"boolean",
            "default":true
        },
        "isTruncateCol":{
            "description":"If the data in the file is too long for a field, then this option will truncate the value of the field rather than reject the row.",
            "type":"boolean",
            "default":true
        },
        "quote":{
            "description":"Specifies the quote character for the fields, the quote characters are removed during loading when specified.",
            "type":"string",
            "minLength":1,
            "maxLength":1
        },
        "recordDelimiter":{
            "description":"Specifies the record delimiter.",
            "type":"string",
            "minLength":1,
            "maxLength":1
        },
        "rejectLimit":{
            "description":"The operation will error out after specified number of rows are rejected.",
            "type":"integer"
        },
        "skipRows":{
            "description":"Specifies how many rows should be skipped from the start of the file.",
            "type":"integer"
        },
        "trimSpaces":{
            "description":"Specifies how the leading and trailing spaces of the fields are trimmed.",
            "type":"string",
            "enum":[
                "RTRIM",
                "LTRIM",
                "NOTRIM",
                "LRTRIM",
                "LDRTRIM"
            ]
        },
        "characterset":{
            "description":"Specifies the characterset of source files.",
            "type":"string"
        },
        "dateformat":{
            "description":"Specifies the date format in the source file.",
            "type":"string"
        },
        "timestampformat":{
            "description":"Specifies the timestamp format in the source file.",
            "type":"string"
        },
        "timestampltzformat":{
            "description":"Specifies the timestamp with local timezone format in the source file.",
            "type":"string"
        },
        "timestamptzformat":{
            "description":"Specifies the timestamp with timezone format in the source file.",
            "type":"string"
        }
    }
}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Simple key-value pair that is applied without any predefined name, type or scope.\nExists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Nested Schema : tableColumns

Type: array

Columns of a table

Show Source

• Array of: object TableColumn
  Column of a Table Field

{
    "description":"Columns of a table",
    "type":"array",
    "items":{
        "$ref":"#/definitions/TableColumn"
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer and boolean types are supported.\n"
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer and boolean types are supported.

Nested Schema : TableColumn

Type: object

Column of a Table Field

Show Source

• name: string
  Minimum Length: 1

  Maximum Length: 128

  The column name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore.
• oracleType: string
  Minimum Length: 1

  Maximum Length: 255

  Oracle DB data type of the field which extends or clarifies the primary data type.
• sourceColumnName: string
  Minimum Length: 1

  Maximum Length: 128

  The source column name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore.

{
    "description":"Column of a Table Field",
    "required":[
        "name",
        "sourceColumnName",
        "oracleType"
    ],
    "properties":{
        "name":{
            "description":"The column name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore.",
            "type":"string",
            "minLength":1,
            "maxLength":128
        },
        "sourceColumnName":{
            "description":"The source column name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore.",
            "type":"string",
            "minLength":1,
            "maxLength":128
        },
        "oracleType":{
            "description":"Oracle DB data type of the field which extends or clarifies the primary data type.",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "x-example":{
                "application-json":"{\n  \"oracleType\": \"VARCHAR2(4000 BYTE)\"\n}\n"
            }
        }
    }
}

400 Response

Bad Request

Headers

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

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

401 Response

Unauthorized

Headers

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

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

404 Response

Not Found

Headers

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

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

429 Response

Too Many Requests

Headers

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

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

500 Response

Internal Server Error

Headers

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

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

Default Response

Unknown Error

Headers

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

Body ()

Root Schema : DefaultError

Type: object

Error Information.

Show Source

• code: string
  Minimum Length: 1

  Maximum Length: 255

  A short error code that defines the error, meant for programmatic parsing.
• message: string
  Minimum Length: 1

  Maximum Length: 1024

  A human-readable error string.

{
    "description":"Error Information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        }
    }
}

Back to Top