Insert/upsert rows

Inserts rows into a table, optionally updating existing rows if any upsert key columns are provided. This endpoint will always return a 202, so long as the doc and table exist and are accessible (and the update is structurally valid). Row inserts/upserts are generally processed within several seconds. Note: this endpoint only works for base tables, not views.
When upserting, if multiple rows match the specified key column(s), they will all be updated with the specified value.

curl --location --request POST 'http://dev-cn.your-api-server.com/docs/AbCDeFGH/tables/grid-pqRst-U/rows' \ --header 'Content-Type: application/json' \ --data-raw '{ "rows": [ { "cells": [ { "value": "$12.34", "column": "c-tuVwxYz" } ] } ], "keyColumns": [ "c-bCdeFgh" ] }'

请求参数

Path 参数

docId

string

必需

ID of the doc.

示例值:

AbCDeFGH

tableIdOrName

string

必需

ID or name of the table. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it.

示例值:

grid-pqRst-U

Query 参数

disableParsing

boolean

可选

If true, the API will not attempt to parse the data in any way.

示例值:

true

Body 参数application/json

Payload for upserting rows in a table.

rows

array[object (RowEdit) {1}]

必需

cells

array[object (CellEdit) {2}]

必需

keyColumns

array[string]

可选

Optional column IDs, URLs, or names (fragile and discouraged), specifying columns to be used as upsert keys.

示例值:

["c-bCdeFgh"]

示例

返回响应

🟢202A result indicating that the upsert was queued for processing.

application/json

Body

The result of a rows insert/upsert operation.

requestId

string

必需

An arbitrary unique identifier for this request.

示例值:

abc-123-def-456

addedRowIds

array[string]

可选

Row IDs for rows that will be added. Only applicable when keyColumns is not set or empty.

示例值:

["i-bCdeFgh","i-CdEfgHi"]

🟠400400

🟠401401

🟠403403

🟠404404

🟠429429