Data -- Internal Tables

Add BI Column

Adds one or more columns to the specified Peaka BI Table. Each column definition includes its name, data type, display name, optional default value, and constraints (nullability, uniqueness). Peaka BI Table supports VARCHAR, BIGINT, BOOLEAN, TIMESTAMP, TIME, DATE, UUID, and DECIMAL data types. Note that JSON data type is not supported in Peaka BI Table.

post/data/projects/{projectId}/bitable/{tableName}/columns

Request

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

Path parameters

projectIdstring required

ID of the Project

tableNamestring required

Name of the BI table

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

Column added successfully

Changes

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