List formulas

Returns a list of named formulas in a Coda doc.

{ "nextPageToken": "eyJsaW1pd", "items": [ { "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": "f-fgHijkLm", "href": "https://coda.io/apis/v1/docs/AbCDeFGH/formulas/f-fgHijkLm", "name": "Sum of expenses", "type": "formula" } ], "href": "https://coda.io/apis/v1/docs/AbCDeFGH/formulas?limit=20", "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/formulas?pageToken=eyJsaW1pd" }

请求参数

Path 参数

docId

string

必需

ID of the doc.

示例值:

AbCDeFGH

Query 参数

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

sortBy

enum<string>

可选

Determines how to sort the given objects.

枚举值:

name

返回响应

🟢200List of formulas that have names in a doc.

application/json

Body

List of formulas.

nextPageToken

string

可选

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

示例值:

eyJsaW1pd

items

array[object (FormulaReference) {5}]

必需

parent

object (PageReference)

可选

Reference to a page.

string

必需

ID of the formula.

示例值:

f-fgHijkLm

href

string <url>

必需

API link to the formula.

示例值:

https://coda.io/apis/v1/docs/AbCDeFGH/formulas/f-fgHijkLm

name

string

必需

Name of the formula.

示例值:

Sum of expenses

type

enum<string>

必需

The type of this resource.

枚举值:

formula

href

string <url>

可选

API link to these results

示例值:

https://coda.io/apis/v1/docs/AbCDeFGH/formulas?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/formulas?pageToken=eyJsaW1pd

🟠401401

🟠403403

🟠404404

🟠429429