PingCodeRESTAPI

创建一个页面

POST

https://open.pingcode.com/v1/wiki/pages

最后修改时间：2024-01-02 08:13:17

责任人：未设置

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

space_id

string

空间的id。

必需

name

string

页面的名称。

必需

parent_id

string

父页面的id。

可选

content

string

页面的内容。

可选

format_type

string

可选

页面内容的格式。content和format_type字段必须同时传递。允许值: text, markdown, html

示例

{
    "space_id": "63e1bf51760505c8795ebcc8",
    "name": "示例页面",
    "parent_id": "63e1bf51760505c8795ebcce",
    "content": "空间是记录信息和知识的页面集合，通过组织页面层级将知识系统化、结构化，便于团队沉淀经验、共享资源，实现知识增值，加快知识流动，在知识管理层面助力企业更快更好的发布产品。 PingCode 空间支持以下特性： 页面支持插入多种元素以及关联页面，满足编写需要 编辑过程自动保存草稿，无需担心内容丢失 提供丰富的模板，使用模板保持页面的一致性，让空间更加规范 使用锁定功能锁定页面最终版本 删除的页面放进回收站，随时恢复 树状页面结构，直接拖动页面编排目录，让知识管理更方便高效 通过设置成员角色来进行权限控制 通过页面评论实现成员沟通交流，形成反馈闭环  【PingCode 空间】当前处于不断迭代过程中，更多功能即将呈现，敬请期待~",
    "format_type": "text"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://open.pingcode.com/v1/wiki/pages' \
--header 'Content-Type: application/json' \
--data-raw '{
    "space_id": "63e1bf51760505c8795ebcc8",
    "name": "示例页面",
    "parent_id": "63e1bf51760505c8795ebcce",
    "content": "空间是记录信息和知识的页面集合，通过组织页面层级将知识系统化、结构化，便于团队沉淀经验、共享资源，实现知识增值，加快知识流动，在知识管理层面助力企业更快更好的发布产品。 PingCode 空间支持以下特性： 页面支持插入多种元素以及关联页面，满足编写需要 编辑过程自动保存草稿，无需担心内容丢失 提供丰富的模板，使用模板保持页面的一致性，让空间更加规范 使用锁定功能锁定页面最终版本 删除的页面放进回收站，随时恢复 树状页面结构，直接拖动页面编排目录，让知识管理更方便高效 通过设置成员角色来进行权限控制 通过页面评论实现成员沟通交流，形成反馈闭环  【PingCode 空间】当前处于不断迭代过程中，更多功能即将呈现，敬请期待~",
    "format_type": "text"
}'

返回响应

🟢200成功

application/json

Body

string

必需

url

string

必需

name

string

必需

icon

string

必需

space

object

必需

string

必需

url

string

必需

name

string

必需

identifier

string

必需

parent

null

必需

type

string

必需

readings

integer

必需

participants

array [object {4}]

必需

string

可选

url

string

可选

type

string

可选

user

object

可选

published_at

integer

必需

published_by

object

必需

string

必需

url

string

必需

name

string

必需

display_name

string

必需

avatar

string

必需

created_at

integer

必需

created_by

object

必需

string

必需

url

string

必需

name

string

必需

display_name

string

必需

avatar

string

必需

updated_at

integer

必需

updated_by

object

必需

string

必需

url

string

必需

name

string

必需

display_name

string

必需

avatar

string

必需

is_archived

integer

必需

is_deleted

integer

必需

示例

{
    "id": "string",
    "url": "string",
    "name": "string",
    "icon": "string",
    "space": {
        "id": "string",
        "url": "string",
        "name": "string",
        "identifier": "string"
    },
    "parent": null,
    "type": "string",
    "readings": 0,
    "participants": [
        {
            "id": "string",
            "url": "string",
            "type": "string",
            "user": {
                "id": "string",
                "url": "string",
                "name": "string",
                "display_name": "string",
                "avatar": "string"
            }
        }
    ],
    "published_at": 0,
    "published_by": {
        "id": "string",
        "url": "string",
        "name": "string",
        "display_name": "string",
        "avatar": "string"
    },
    "created_at": 0,
    "created_by": {
        "id": "string",
        "url": "string",
        "name": "string",
        "display_name": "string",
        "avatar": "string"
    },
    "updated_at": 0,
    "updated_by": {
        "id": "string",
        "url": "string",
        "name": "string",
        "display_name": "string",
        "avatar": "string"
    },
    "is_archived": 0,
    "is_deleted": 0
}

删除一个空间

部分更新一个页面