Sign in

v1

latestOpenAPI 3.0.02026-07-2638801.8 MB
plan

Generate calculation plan for creating the field

post/table/{tableId}/field/plan

Path parameters

tableIdstring required

Request body

type'singleLineText' | 'longText' | 'user' | 'attachment' | 'checkbox' | 'multipleSelect' | 'singleSelect' | 'date' | 'number' | 'rating' | 'formula' | 'rollup' | 'conditionalRollup' | 'link' | 'createdTime' | 'lastModifiedTime' | 'createdBy' | 'lastModifiedBy' | 'autoNumber' | 'button' required

The field types supported by teable.

namestring
uniqueboolean

Whether this field is not unique.

notNullboolean

Whether this field is not null.

dbFieldNamestring

Field(column) name in backend database. Limitation: 1-63 characters, can only contain letters, numbers and underscore, case sensitive, cannot be duplicated with existing db field name in the table.

isLookupboolean

Whether this field is lookup field. witch means cellValue and [fieldType] is looked up from the linked table.

isConditionalLookupboolean

Whether this lookup field applies a conditional filter when resolving linked records.

descriptionstring nullable

The description of the field.

idstring

The id of the field that start with "fld", followed by exactly 16 alphanumeric characters /^fld[\da-zA-Z]{16}$/. It is sometimes useful to specify an id at creation time

Example request

{
  "type": "singleSelect",
  "description": "this is a summary",
  "id": "fldxxxxxxxxxxxxxxxx"
}

Response

Returns the calculation plan for creating the field

estimateTimenumber required
updateCellCountnumber required
linkFieldCountnumber