Get a page - Coda

Returns details about a page.

{ "icon": { "name": "string", "type": "string", "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png" }, "image": { "browserLink": "https://codahosted.io/docs/nUYhlXysYO/blobs/bl-lYkYKNzkuT/3f879b9ecfa27448", "type": "string", "width": 800, "height": 600 }, "contentType": "canvas", "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" }, "createdBy": { "@type": "ImageObject", "@context": "http://schema.org/", "additionalType": "string", "name": "Alice Atkins", "email": "alice@atkins.com" }, "updatedBy": { "@type": "ImageObject", "@context": "http://schema.org/", "additionalType": "string", "name": "Alice Atkins", "email": "alice@atkins.com" }, "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", "subtitle": "See the status of launch-related tasks.", "isHidden": true, "isEffectivelyHidden": true, "children": [ { "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" } ], "authors": [ { "@type": "ImageObject", "@context": "http://schema.org/", "additionalType": "string", "name": "Alice Atkins", "email": "alice@atkins.com" } ], "createdAt": "2018-04-11T00:18:57.946Z", "updatedAt": "2018-04-11T00:18:57.946Z", "type": "page" }

请求参数

Path 参数

docId

string

必需

ID of the doc.

示例值:

AbCDeFGH

pageIdOrName

string

必需

ID or name of the page. 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. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

示例值:

canvas-IjkLmnO

返回响应

🟢200Info about a page.

application/json

Body

Metadata about a page.

icon

object (Icon)

可选

Info about the icon.

name

string

必需

Name of the icon.

type

string

必需

MIME type of the icon

browserLink

string <url>

必需

Browser-friendly link to an icon.

示例值:

https://cdn.coda.io/icons/png/color/icon-32.png

image

object (Image)

可选

Info about the image.

browserLink

string <url>

必需

Browser-friendly link to an image.

示例值:

https://codahosted.io/docs/nUYhlXysYO/blobs/bl-lYkYKNzkuT/3f879b9ecfa27448

type

string

可选

MIME type of the image.

width

number

可选

The width in pixels of the image.

示例值:

800

height

number

可选

The height in pixels of the image.

示例值:

600

contentType

enum<string>

必需

The type of a page in a doc.

枚举值:

canvasembedsyncPage

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

createdBy

object (PersonValue)

可选

A named reference to a person, where the person is identified by email address.

@type

enum<string>

LinkedDataType

必需

A schema.org identifier for the object.

枚举值:

ImageObjectMonetaryAmountPersonWebPageStructuredValue

@context

string

必需

A url describing the schema context for this object, typically "http://schema.org/".

示例值:

http://schema.org/

additionalType

string

可选

An identifier of additional type info specific to Coda that may not be present in a schema.org taxonomy,

name

string

必需

The full name of the person.

示例值:

Alice Atkins

string

必需

The email address of the person.

示例值:

alice@atkins.com

updatedBy

object (PersonValue)

可选

A named reference to a person, where the person is identified by email address.

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

subtitle

string

可选

Subtitle of the page.

示例值:

See the status of launch-related tasks.

isHidden

boolean

必需

Whether the page is hidden in the UI.

示例值:

true

isEffectivelyHidden

boolean

必需

Whether the page or any of its parents is hidden in the UI.

示例值:

true

children

array[object (PageReference) {5}]

必需

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

authors

array[object (PersonValue) {5}]

可选

Authors of the page

@type

enum<string>

LinkedDataType

必需

A schema.org identifier for the object.

枚举值:

ImageObjectMonetaryAmountPersonWebPageStructuredValue

@context

string

必需

A url describing the schema context for this object, typically "http://schema.org/".

示例值:

http://schema.org/

additionalType

string

可选

An identifier of additional type info specific to Coda that may not be present in a schema.org taxonomy,

name

string

必需

The full name of the person.

示例值:

Alice Atkins

string

必需

The email address of the person.

示例值:

alice@atkins.com

createdAt

string <date-time>

可选

Timestamp for when the page was created.

示例值:

2018-04-11T00:18:57.946Z

updatedAt

string <date-time>

可选

Timestamp for when page content was last modified.

示例值:

2018-04-11T00:18:57.946Z

type

enum<string>

必需

The type of this resource.

枚举值:

page

🟠401401

🟠403403

🟠404404

🟠410410

🟠429429