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

Update the Table resource identified by the id

put

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

Updates the Table

Request

Path Parameters

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

Header Parameters

• if-match(optional): 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
  The client request ID for tracing.

Body ()

The information to be updated.

Root Schema : UpdateTableDetails

Type: object

The Table resource information to be updated.

Show Source

• 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(optional): string
  Minimum Length: 1

  Maximum Length: 255

  Name of the Table resource
• 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"}`
• tableColumns(optional): array tableColumns
  Columns of a table

{
    "description":"The Table resource information to be updated.",
    "properties":{
        "displayName":{
            "description":"Name of the Table resource",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "tableColumns":{
            "description":"Columns of a table",
            "type":"array",
            "items":{
                "$ref":"#/definitions/TableColumn"
            }
        },
        "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 : 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"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted the request. The Table resource will be updated.

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.
• opc-work-request-id: string
  Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

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

412 Response

Precondition failed

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