Get a table

Returns details about a specific table or view.

{ "tableType": "table", "parent": { "id": "canvas-IjkLmnO", "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO", "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO", "name": "Launch Status", "type": "page" }, "parentTable": { "tableType": "table", "parent": { "id": "canvas-IjkLmnO", "href": "https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO", "browserLink": "https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO", "name": "Launch Status", "type": "page" }, "id": "grid-pqRst-U", "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U", "browserLink": "https://coda.io/d/_dAbCDeFGH/#Teams-and-Tasks_tpqRst-U", "name": "Tasks", "type": "table" }, "displayColumn": { "id": "c-tuVwxYz", "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns/c-tuVwxYz", "type": "column" }, "layout": "default", "id": "grid-pqRst-U", "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U", "browserLink": "https://coda.io/d/_dAbCDeFGH/#Teams-and-Tasks_tpqRst-U", "name": "Tasks", "rowCount": 130, "sorts": [ { "column": { "id": "c-tuVwxYz", "href": "https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns/c-tuVwxYz", "type": "column" }, "direction": "ascending" } ], "createdAt": "2018-04-11T00:18:57.946Z", "updatedAt": "2018-04-11T00:18:57.946Z", "type": "table", "filter": { "valid": true, "isVolatile": false, "hasUserFormula": false, "hasTodayFormula": false, "hasNowFormula": false } }

请求参数

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

useUpdatedTableLayouts

boolean

可选

Return "detail" and "form" for the layout field of detail and form layouts respectively (instead of "masterDetail" for both)

返回响应

🟢200Info about a table.

application/json

Body

Metadata about a table.

tableType

enum<string>

必需

枚举值:

tableview

parent

object (PageReference)

必需

Reference to a page.

string

必需

ID of the page.

示例值:

canvas-IjkLmnO

href

string <url>

必需

API link to the page.

示例值:

https://coda.io/apis/v1/docs/AbCDeFGH/pages/canvas-IjkLmnO

browserLink

string <url>

必需

Browser-friendly link to the page.

示例值:

https://coda.io/d/_dAbCDeFGH/Launch-Status_sumnO

name

string

必需

Name of the page.

示例值:

Launch Status

type

enum<string>

必需

The type of this resource.

枚举值:

page

parentTable

object (TableReference)

可选

Reference to a table or view.

tableType

enum<string>

必需

枚举值:

tableview

parent

object (PageReference)

可选

Reference to a page.

string

必需

ID of the table.

示例值:

grid-pqRst-U

href

string <url>

必需

API link to the table.

示例值:

https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U

browserLink

string <url>

必需

Browser-friendly link to the table.

示例值:

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

name

string

必需

Name of the table.

示例值:

Tasks

type

enum<string>

必需

The type of this resource.

枚举值:

table

displayColumn

object (ColumnReference)

必需

Reference to a column.

string

必需

ID of the column.

示例值:

c-tuVwxYz

href

string <url>

必需

API link to the column.

示例值:

https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U/columns/c-tuVwxYz

type

enum<string>

必需

The type of this resource.

枚举值:

column

layout

enum<string>

必需

Layout type of the table or view.

枚举值:

defaultareaChartbarChartbubbleChartcalendarcarddetailformganttChartlineChartmasterDetailpieChartscatterChartslidewordCloud

string

必需

ID of the table.

示例值:

grid-pqRst-U

href

string <url>

必需

API link to the table.

示例值:

https://coda.io/apis/v1/docs/AbCDeFGH/tables/grid-pqRst-U

browserLink

string <url>

必需

Browser-friendly link to the table.

示例值:

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

name

string

必需

Name of the table.

示例值:

Tasks

rowCount

integer

必需

Total number of rows in the table.

示例值:

130

sorts

array[object (Sort) {2}]

必需

Any sorts applied to the table.

column

object (ColumnReference)

必需

Reference to a column.

direction

enum<string>

必需

Direction of a sort for a table or view.

枚举值:

ascendingdescending

createdAt

string <date-time>

必需

Timestamp for when the table was created.

示例值:

2018-04-11T00:18:57.946Z

updatedAt

string <date-time>

必需

Timestamp for when the table was last modified.

示例值:

2018-04-11T00:18:57.946Z

type

enum<string>

必需

The type of this resource.

枚举值:

table

filter

object

可选

Detailed information about a formula.

valid

boolean

必需

Returns whether or not the given formula is valid.

示例值:

true

isVolatile

boolean

可选

Returns whether or not the given formula can return different results in different contexts (for example, for different users).

示例值:

false

hasUserFormula

boolean

可选

Returns whether or not the given formula has a User() formula within it.

示例值:

false

hasTodayFormula

boolean

可选

Returns whether or not the given formula has a Today() formula within it.

示例值:

false

hasNowFormula

boolean

可选

Returns whether or not the given formula has a Now() formula within it.

示例值:

false

🟠401401

🟠403403

🟠404404

🟠429429