Data -- Internal Tables

Update BI Column

Updates the definition of an existing column in the specified Peaka BI Table. Allows modifying the column's name, display name, data type, default value, and constraints such as nullability and uniqueness.

put/data/projects/{projectId}/bitable/{tableName}/columns/{columnName}

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/data/projects/{projectId}/bitable/{tableName}/columns/{columnName}
  • Auth: HTTP bearer

Path parameters

projectIdstring required

ID of the Project

tableNamestring required

Name of the BI table

columnNamestring required

Name of the column to update

Request body

namestring

The name of the column.

dataType'VARCHAR' | 'BIGINT' | 'BOOLEAN' | 'DECIMAL' | 'TIMESTAMP' | 'TIME' | 'DATE' | 'UUID'

The data type of the column.

displayNamestring

The display name of the column.

defaultValuestring

The default value of the column.

isNotNullboolean

The not null flag for the column.

isUniqueboolean

The unique flag for the column.

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.