List table rows

开发环境

GET

/docs/{docId}/tables/{tableIdOrName}/rows

Rows

Returns a list of rows in a table.

Value results

The valueFormat parameter dictates in what format the API should return values for individual cells.

simple (default): Returns cell values as the following JSON values: string, number, or boolean. Array values (like multiselects) are returned as comma-delimited strings.

simpleWithArrays: Singleton values are returned as simple. Array values are returned as JSON arrays and the values within are simple values (including nested arrays).

rich: If applicable, returns many values with further encoding, allowing API users to have lossless access to data in Coda.

For text values, returns data in Markdown syntax. If the text field is simple text (e.g. has no formatting),
the field will be fully escaped with triple-ticks. E.g
```This is plain text```

For currency, lookup, image, person and hyperlink values, the value will be encoded in JSON-LD format.

  // Currency
  {
    "@context": "http://schema.org",
    "@type": "MonetaryAmount",
    "currency": "USD",
    "amount": 42.42
  }

  // Lookup
  {
    "@context": "http://schema.org",
    "@type": "StructuredValue",
    "additionalType": "row",
    "name": "Row Name",
    "rowId": "i-123456789",
    "tableId": "grid-123456789",
    "tableUrl": "https://coda.io/d/_d123456789/grid-123456789",
    "url": "https://coda.io/d/_d123456789/grid-123456789#_r42",
  }

  // Hyperlink
  {
    "@context": "http://schema.org",
    "@type": "WebPage",
    "name": "Coda",
    "url": "https://coda.io"
  }

  // Image
  {
    "@context": "http://schema.org",
    "@type": "ImageObject",
    "name": "Coda logo",
    "url": "https://coda.io/logo.jpg"
  }

  // People
  {
    "@context": "http://schema.org",
    "@type": "Person",
    "name": "Art Vandalay",
    "email": "art@vandalayindustries.com"
  }

请求示例

Python

Shell

JavaScript

Java

curl --location --request GET 'http://dev-cn.your-api-server.com/docs/AbCDeFGH/tables/grid-pqRst-U/rows'

响应示例

200 - 示例 1

{
  "nextPageToken": "eyJsaW1pd",
  "nextSyncToken": "eyJsaW1pd",
  "items": [
    {
      "id": "i-tuVwxYz",
      "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows/i-RstUv-W",
      "name": "Apple",
      "index": 7,
      "browserLink": "https://coda.io/d/_dAbCDeFGH#Teams-and-Tasks_tpqRst-U/_rui-tuVwxYz",
      "createdAt": "2018-04-11T00:18:57.946Z",
      "updatedAt": "2018-04-11T00:18:57.946Z",
      "type": "row",
      "values": {
        "c-tuVwxYz": "Apple",
        "c-bCdeFgh": [
          "$12.34",
          "$56.78"
        ]
      }
    }
  ],
  "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows?limit=20",
  "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows?pageToken=eyJsaW1pd"
}

请求参数

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 参数

query

string

可选

Query used to filter returned rows, specified as <column_id_or_name>:<value>. If you'd like to use a column name instead of an ID, you must quote it (e.g., "My Column":123). Also note that value is a JSON value; if you'd like to use a string, you must surround it in quotes (e.g., "groceries").

示例值:

c-tuVwxYz:"Apple"

sortBy

enum<string>

可选

Specifies the sort order of the rows returned. If left unspecified, rows are returned by creation time ascending. "UpdatedAt" sort ordering is the order of rows based upon when they were last updated. This does not include updates to calculated values. "Natural" sort ordering is the order that the rows appear in the table view in the application. This ordering is only meaningfully defined for rows that are visible (unfiltered). Because of this, using this sort order will imply visibleOnly=true, that is, to only return visible rows. If you pass sortBy=natural and visibleOnly=false explicitly, this will result in a Bad Request error as this condition cannot be satisfied.

枚举值:

createdAtnaturalupdatedAt

useColumnNames

boolean

可选

Use column names instead of column IDs in the returned output. This is generally discouraged as it is fragile. If columns are renamed, code using original names may throw errors.

示例值:

true

valueFormat

enum<string>

可选

The format that cell values are returned as.

枚举值:

simplesimpleWithArraysrich

visibleOnly

boolean

可选

If true, returns only visible rows and columns for the table.

示例值:

true

limit

integer

可选

Maximum number of results to return in this query.

>= 1

默认值:

示例值:

pageToken

string

可选

An opaque token used to fetch the next page of results.

示例值:

eyJsaW1pd

syncToken

string

可选

An opaque token returned from a previous call that can be used to return results that are relevant to the query since the call where the syncToken was generated.

示例值:

eyJsaW1pd

返回响应

🟢200List of rows in the table.

application/json

Body

List of rows.

nextPageToken

string

可选

If specified, an opaque token used to fetch the next page of results.

示例值:

eyJsaW1pd

nextSyncToken

string

可选

If specified, an opaque token that can be passed back later to retrieve new results that match the parameters specified when the sync token was created.

示例值:

eyJsaW1pd

items

array[object (Row) {9}]

必需

string

必需

ID of the row.

示例值:

i-tuVwxYz

href

string <url>

必需

API link to the row.

示例值:

https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows/i-RstUv-W

name

string

必需

The display name of the row, based on its identifying column.

示例值:

Apple

index

integer

必需

Index of the row within the table.

示例值:

browserLink

string <url>

必需

Browser-friendly link to the row.

示例值:

https://coda.io/d/_dAbCDeFGH#Teams-and-Tasks_tpqRst-U/_rui-tuVwxYz

createdAt

string <date-time>

必需

Timestamp for when the row was created.

示例值:

2018-04-11T00:18:57.946Z

updatedAt

string <date-time>

必需

Timestamp for when the row was last modified.

示例值:

2018-04-11T00:18:57.946Z

type

enum<string>

必需

The type of this resource.

枚举值:

row

values

object

必需

Values for a specific row, represented as a hash of column IDs (or names with useColumnNames) to values.

示例值:

{"c-tuVwxYz":"Apple","c-bCdeFgh":["$12.34","$56.78"]}

href

string <url>

可选

API link to these results

示例值:

https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows?limit=20

nextPageLink

string <url>

可选

If specified, a link that can be used to fetch the next page of results.

示例值:

https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/rows?pageToken=eyJsaW1pd

🟠400400

🟠401401

🟠403403

🟠404404

🟠429429

修改于 2024-03-20 08:13:15

Push a button

Insert/upsert rows

List table rows

Value results#

请求参数

返回响应

Value results