Create doc

开发环境

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

POST

/docs

Creates a new Coda doc, optionally copying an existing doc. Note that creating a doc requires you to be a Doc Maker in the applicable workspace (or be auto-promoted to one).

请求示例

Shell

JavaScript

Java

Swift

curl -s -H 'Authorization: Bearer <your API token>' -X POST -H "Content-Type: application/json" \
  -d '{"title": "Project Tracker"}' \
  'https://coda.io/apis/v1/docs' |
  jq .name
# => "Project Tracker"

响应示例

201 - 示例 1

{
    "icon": {
        "name": "string",
        "type": "string",
        "browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"
    },
    "docSize": {
        "totalRowCount": 31337,
        "tableAndViewCount": 42,
        "pageCount": 10,
        "overApiSizeLimit": false
    },
    "published": {
        "mode": "view",
        "description": "Hello World!",
        "browserLink": "https://coda.io/@coda/hello-world",
        "imageLink": "string",
        "discoverable": true,
        "earnCredit": true,
        "categories": [
            "Project Management"
        ]
    },
    "folder": {
        "id": "fl-1Ab234",
        "browserLink": "https://coda.io/docs?folderId=fl-1Ab234",
        "name": "My docs",
        "type": "folder"
    },
    "workspace": {
        "id": "ws-1Ab234",
        "organizationId": "org-2Bc456",
        "browserLink": "https://coda.io/docs?workspaceId=ws-1Ab234",
        "name": "My workspace",
        "type": "workspace"
    },
    "id": "AbCDeFGH",
    "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
    "browserLink": "https://coda.io/d/_dAbCDeFGH",
    "name": "Product Launch Hub",
    "owner": "user@example.com",
    "ownerName": "Some User",
    "createdAt": "2018-04-11T00:18:57.946Z",
    "updatedAt": "2018-04-11T00:18:57.946Z",
    "workspaceId": "ws-1Ab234",
    "folderId": "fl-1Ab234",
    "requestId": "abc-123-def-456",
    "type": "doc",
    "sourceDoc": {
        "id": "AbCDeFGH",
        "href": "https://coda.io/apis/v1/docs/AbCDeFGH",
        "browserLink": "https://coda.io/d/_dAbCDeFGH",
        "type": "doc"
    }
}

请求参数

Body 参数application/json

示例

返回响应

🟢201Info about the created doc.

application/json

Body

🟠400400

🟠401401

🟠403403

🟠429429

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

Update doc

List available docs