Preview paste operation results

PATCH

table

{tableId}

selection

temporaryPaste

curl --request PATCH \
  --url https://app.teable.io/api/table/%7BtableId%7D/selection/temporaryPaste \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"viewId":"viwXXXXXXX","ranges":[[0,0],[1,1]],"projection":["string"],"ignoreViewQuery":"string","content":"John\tDoe\tjohn.doe@example.com","header":[]}'

[
  {
    "fields": {}
  }
]

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tableId

string

required

Body

application/json

ranges

array

required

The parameter "ranges" is used to represent the coordinates of a selected range in a table.

content

string

required

Content to paste

viewId

string

Set the view you want to fetch, default is first view. result will filter and sort by view options.

projection

string[]

If you want to get only some fields, pass in this parameter, otherwise all visible fields will be obtained

ignoreViewQuery

When a viewId is specified, configure this to true will ignore the view's filter, sort, etc

header

object[]

Table header for paste operation

header.id

string

required

The id of the field.

header.name

string

required

The name of the field. can not be duplicated in the table.

header.type

enum<string>

required

The field types supported by teable.

Available options:

singleLineText,

longText,

user,

attachment,

checkbox,

multipleSelect,

singleSelect,

date,

number,

duration,

rating,

formula,

rollup,

count,

link,

createdTime,

lastModifiedTime,

createdBy,

lastModifiedBy,

autoNumber,

button

header.options

object

required

The configuration options of the field. The structure of the field's options depend on the field's type.

header.cellValueType

enum<string>

required

The cell value type of the field.

Available options:

string,

number,

boolean,

dateTime

header.dbFieldType

enum<string>

required

The field type of database that cellValue really store.

Available options:

TEXT,

INTEGER,

DATETIME,

REAL,

BLOB,

JSON,

BOOLEAN

header.dbFieldName

string

required

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.

Minimum length: 1

header.description

string

The description of the field.

header.isLookup

boolean

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

header.lookupOptions

object

field lookup options.

header.notNull

boolean

Whether this field is not null.

header.unique

boolean

Whether this field is not unique.

header.isPrimary

boolean

Whether this field is primary field.

header.isComputed

boolean

Whether this field is computed field, you can not modify cellValue in computed field.

header.isPending

boolean

Whether this field's calculation is pending.

header.hasError

boolean

Whether This field has a configuration error. Check the fields referenced by this field's formula or configuration.

header.isMultipleCellValue

boolean

Whether this field has multiple cell value.

Response

200 - application/json

Paste successfully

fields

object

required

Objects with a fields key mapping fieldId or field name to value for that field.

Get table field planGenerate calculation plan for the field

curl --request PATCH \
  --url https://app.teable.io/api/table/%7BtableId%7D/selection/temporaryPaste \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: application/json' \
  --data '{"viewId":"viwXXXXXXX","ranges":[[0,0],[1,1]],"projection":["string"],"ignoreViewQuery":"string","content":"John\tDoe\tjohn.doe@example.com","header":[]}'

[
  {
    "fields": {}
  }
]

Quick Start

API List

Preview paste operation results

Authorizations

Path Parameters

Body

Response