Coda

Create a page

开发环境

http://dev-cn.your-api-server.com

POST

/docs/{docId}/pages

Pages

Create a new page in a doc. Note that creating a page requires you to be a Doc Maker in the applicable workspace.

请求示例

Python

Shell

JavaScript

Java

curl --location --request POST 'http://dev-cn.your-api-server.com/docs/AbCDeFGH/pages' \
--header 'Content-Type: application/json' \
--data-raw '{
    "pageContent": {
        "canvasContent": {
            "format": "html",
            "content": "<p><b>This</b> is rich text</p>"
        },
        "type": "canvas"
    },
    "name": "Launch Status",
    "subtitle": "See the status of launch-related tasks.",
    "iconName": "rocket",
    "imageUrl": "https://example.com/image.jpg",
    "parentPageId": "canvas-tuVwxYz"
}'

响应示例

202 - 示例 1

{
    "requestId": "abc-123-def-456",
    "id": "canvas-tuVwxYz"
}

请求参数

Path 参数

docId

string

必需

ID of the doc.

示例值:

AbCDeFGH

Body 参数application/json

Payload for creating a new page in a doc.

pageContent

PageCreateContent

可选

Content that can be added to a page at creation time, either text (or rich text) or a URL to create a full-page embed.

One of

object

canvasContent

object

PageContent

必需

Content for a page (canvas).

type

enum<string>

必需

Indicates a page containing canvas content.

枚举值:

canvas

name

string

可选

Name of the page.

示例值:

Launch Status

subtitle

string

可选

Subtitle of the page.

示例值:

See the status of launch-related tasks.

iconName

string

可选

Name of the icon.

示例值:

rocket

imageUrl

string

可选

Url of the cover image to use.

示例值:

https://example.com/image.jpg

parentPageId

string

可选

The ID of this new page's parent, if creating a subpage.

示例值:

canvas-tuVwxYz

示例

返回响应

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

application/json

Body

The result of a page creation.

requestId

string

必需

An arbitrary unique identifier for this request.

示例值:

abc-123-def-456

string

必需

ID of the created page.

示例值:

canvas-tuVwxYz

🟠400400

🟠401401

🟠403403

🟠404404

🟠429429

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

List pages

Begin content export