1. 获取页面详情
2. 获取页面详情(路由中不带space_uuid)
3. 删除页面
4. 获取页面组的页面列表
5. 获取页面组的带历史的页面列表
6. 获取页面组的已加密的页面列表
7. 关注/取消关注页面
8. 移动页面
9. 页面的历史版本
10. 页面历史版本（路由不带space_uuid）
11. 页面回滚特定版本
12. 页面排序
13. 获取页面附件
14. 更新页面附件
15. 获取页面的messages
16. 页面导出
17. 发送页面评论
18. 检查页面冲突

HTTP status code 说明

状态码	说明
200	成功
403	主页不能被删除(ConstraintViolation.RootPageCannotDelete)
404	没有找到 page
607	uuid invalid
620	不存在 page version
630	没有page记录
801	uuid 无效、数据格式有误
817	root page 不能删除、不能修改(移动到子页面情况下)

1. 获取页面详情

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID

HTTP Method

GET

是否需要登录

是

传值方式

url param

参数列表

参数名	是否必须	值类型	取值范围	默认值	取值例子	说明
version	F	int	[0,n)		0	根据版本号获取page,默认获取最近版本

请求体示例

curl -X GET \
  ' https://your-host-name/wiki/api/wiki/team/3pDzCwAe/space/MAJPYt6j/page/CbA3y4i1?version=0' \
  -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache'

返回体示例

{
    "uuid": "4VSnJJmk",
    "space_uuid": "DV1NU3Ab",
    "owner_uuid": "6ZpgEzkk",
    "title": "主页",
    "content": "<h1>\n\t编辑主页\n</h1>\n<p>\n\t点击右上角的&ldquo;编辑&rdquo;按钮，开始编辑页面。\n</p>\n<p>\n\t作为页面组的主页，可以介绍这个页面组对应项目的目标、接下来的计划或提供工作对接需要的信息。\n</p>\n<h1>\n\t新建页面\n</h1>\n<p>\n\t点击&ldquo;新建&rdquo;按钮，开始编辑页面。 Wiki 会实时保存页面内容，退出编辑后可以在左边导航栏上方的「草稿箱」找回你的草稿。\n</p>\n<p>\n\t你可以点击左栏&ldquo;页面树&rdquo;右侧的配置按钮，管理页面间的位置和层级关系。\n</p>\n<h1>\n\t配置权限\n</h1>\n<p>\n\t点击左栏页面组标题右侧的设置按钮，进入项目设置，配置谁能看查看或者编辑这个页面组。\n</p>\n<p>\n\tWiki 项目支持配置「查看与反馈」、「编辑内容」和「管理项目」三种权限。\n</p>\n",
    "version": 0,
    "draft_uuid": "",
    "updated_time": 1584598502,
    "watch_users": null,
    "encrypt_status": 1,
    "is_can_edit": true,
    "share_uuid": "",
    "is_can_share": false,
    "is_can_edit_share": false,
    "space_view_page_permission": false,
    "share_view_page_permission": false
}

2. 获取页面详情(路由中不带space_uuid)

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/page/:pageUUID

HTTP Method

GET

是否需要登录

是

传值方式

url param

参数列表

参数名	是否必须	值类型	取值范围	默认值	取值例子	说明
version	F	int	[0,n)		0	根据版本号获取page,默认获取最近版本

返回JSON

{
    "uuid": "4VSnJJmk",
    "space_uuid": "DV1NU3Ab",
    "owner_uuid": "6ZpgEzkk",
    "title": "主页",
    "content": "<h1>\n\t编辑主页\n</h1>\n<p>\n\t点击右上角的&ldquo;编辑&rdquo;按钮，开始编辑页面。\n</p>\n<p>\n\t作为页面组的主页，可以介绍这个页面组对应项目的目标、接下来的计划或提供工作对接需要的信息。\n</p>\n<h1>\n\t新建页面\n</h1>\n<p>\n\t点击&ldquo;新建&rdquo;按钮，开始编辑页面。 Wiki 会实时保存页面内容，退出编辑后可以在左边导航栏上方的「草稿箱」找回你的草稿。\n</p>\n<p>\n\t你可以点击左栏&ldquo;页面树&rdquo;右侧的配置按钮，管理页面间的位置和层级关系。\n</p>\n<h1>\n\t配置权限\n</h1>\n<p>\n\t点击左栏页面组标题右侧的设置按钮，进入项目设置，配置谁能看查看或者编辑这个页面组。\n</p>\n<p>\n\tWiki 项目支持配置「查看与反馈」、「编辑内容」和「管理项目」三种权限。\n</p>\n",
    "version": 0,
    "draft_uuid": "",
    "updated_time": 1584598502,
    "watch_users": null,
    "encrypt_status": 1,
    "is_can_edit": true,
    "share_uuid": "",
    "is_can_share": false,
    "is_can_edit_share": false,
    "space_view_page_permission": true,
    "share_view_page_permission": false
}

3. 删除页面

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID/delete

HTTP Method

POST

是否需要登录

是

传值方式

无

参数列表

无

请求体示例

curl -X POST \
 https://your-host-name/wiki/api/wiki/team/3pDzCwAe/space/MAJPYt6j/page/N9TcsWjJ/delete \
  -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache'

4. 获取页面组的页面列表

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/pages

HTTP Method

GET

是否需要登录

是

传值方式

url param

参数列表

参数名	是否必须	值类型	取值范围	默认值	取值例子	说明
status	T	int	[1,2]		2	1:正常页面, 2: 已删除页面

返回JSON

JSON键名	值类型	取值范围	取值例子	说明
total	int			pages 个数
pages	array			pages

请求体示例

curl -X GET \
  'https://your-host-name/wiki/api/wiki/team/3pDzCwAe/space/MAJPYt6j/pages?status=1' \
  -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache'

返回体示例

{
    "pages": [
        {
            "uuid": "4VSnJJmk",
            "space_uuid": "DV1NU3Ab",
            "title": "主页",
            "parent_uuid": "",
            "last_modified_time": 1584598502,
            "last_modified_user_uuid": "6ZpgEzkk"
        }
    ]
}

5. 获取页面组的带历史的页面列表

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/pages_with_history

HTTP Method

GET

是否需要登录

是

传值方式

无

参数列表

无

返回体结构

JSON键名	值类型	取值范围	取值例子	说明
pages	array			pages

返回值示例

{
    "pages": [
        {
            "uuid": "4VSnJJmk",
            "space_uuid": "DV1NU3Ab",
            "title": "主页",
            "parent_uuid": "",
            "last_modified_time": 1584598502,
            "last_modified_user_uuid": "6ZpgEzkk"
        }
    ]
}

6. 获取页面组的已加密的页面列表

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/encrypt_pages

HTTP Method

GET

是否需要登录

是

传值方式

无

参数列表

无

返返回体结构

JSON键名	值类型	取值范围	取值例子	说明
pages	array			pages

返回体示例

{
    "pages": [
        {
            "uuid": "W61EiMp4",
            "space_uuid": "SCEFCtg1",
            "title": "F2045 1 草稿6",
            "parent_uuid": "KSGQChyD",
            "encrypt_status": 2,
            "evaluated_permissions": [
                {
                    "key": "1103-W61EiMp4-:2005",
                    "context_type": "page",
                    "context_param": {
                        "page_uuid": "W61EiMp4"
                    },
                    "permission": "page_view"
                }
            ],
            "is_can_edit": false
        }
    ]
}

7. 关注/取消关注页面

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID/watch

HTTP Method

POST

是否需要登录

是

传值方式

JSON

参数列表

参数名	是否必须	值类型	取值范围	默认值	取值例子	说明
action	T	string			`watch`,`unwatch`	关注,取消关注

8. 移动页面

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID/update

HTTP Method

POST

是否需要登录

是

传值方式

JSON

参数列表

参数名	是否必须	值类型	说明
space_uuid	T	string	space uuid
parent_uuid	T	string	父节点 page uuid
version	T	int	page version

请求体示例

{
    "space_uuid": "DV1NU3Ab",
    "parent_uuid": "4VSnJJmk",
    "version": 0
}

9. 页面的历史版本

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID/history

HTTP Method

GET

是否需要登录

是

传值方式

无

参数列表

无

返回JSON

{
    "history": [
        {
            "space_uuid": "DV1NU3Ab",
            "page_uuid": "4VSnJJmk",
            "owner_uuid": "6ZpgEzkk",
            "title": "主页",
            "version": 0,
            "is_revert": false,
            "updated_time": 1584598502
        }
    ]
}

10. 页面历史版本（路由不带space_uuid）

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/page/:pageUUID/history

HTTP Method

GET

是否需要登录

是

传值方式

无

参数列表

无

返回JSON

{
    "history": [
        {
            "space_uuid": "DV1NU3Ab",
            "page_uuid": "4VSnJJmk",
            "owner_uuid": "6ZpgEzkk",
            "title": "主页",
            "version": 0,
            "is_revert": false,
            "updated_time": 1584598502
        }
    ]
}

11. 页面回滚特定版本

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID/revert

HTTP Method

POST

是否需要登录

是

传值方式

JSON

参数列表

参数名	是否必须	值类型	取值范围	默认值	取值例子	说明
version	T	int	[0,n)	0	1	page version

12. 页面排序

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID/sort

HTTP Method

POST

是否需要登录

是

传值方式

JSON

参数列表

参数名	是否必须	值类型	取值范围	默认值	取值例子	说明
previous_uuid	T	string				page uuid
previous_relation	T	string	brother, child			关系

13. 获取页面附件

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:page/attachments

HTTP Method

GET

是否需要登录

是

传值方式

无

参数列表

无

请求体示例

curl -X GET \
  'https://your-host-name/project/api/project/team/3pDzCwAe/res/attachment/3VxaVhCV?op=attname%3Dreadme' \
  -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache'

返回体参考

{
    "uuid": "3VxaVhCV",
    "type": "file",
    "ref_type": "space",
    "ref_id": "MAJPYt6j",
    "create_time": 1566357279151984,
    "owner_uuid": "DU6krHBN",
    "status": 1,
    "name": "readme",
    "hash": "FqAmtB4EXzOTcOgAKbNAkLqTvzvm",
    "mime": "text/plain",
    "size": 32,
    "url": " https://your-host-name/api/project/file/attachment/FqAmtB4EXzOTcOgAKbNAkLqTvzvm?attname=readme&e=1566362427&token=KkZ1kuDzSN9fSunHNUTb22zu7OVqjsU0QdvPMf94:QmI2dYIKmf6Xn9dFxqf_ebzf-J0", // 资源绝对路径
    "description": ""
}

请求体示例

curl -X GET \
 https://your-host-name/wiki/api/wiki/team/3pDzCwAe/space/MAJPYt6j/page/N9TcsWjJ/attachments \
  -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache'

返回JSON

{
    "attachments": [
        {
            "uuid": "3VxaVhCV", // 附件 uuid
            "name": "readme"    // 附件 name
        }
    ]
}

14. 更新页面附件

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID/attachments/update

HTTP Method

POST

是否需要登录

是

传值方式

JSON

参数列表

参数名	是否必须	值类型	取值范围	默认值	取值例子	说明
add	F	array				新增 attachment
remove	F	array				删除 attachment

attachment model

参数名	是否必须	值类型	取值范围	默认值	取值例子	说明
uuid	T	string	len=8		QEfqHHfN	附件 uuid
name	T	string	len: (0,255]		readme.md	附件 name

15. 获取页面的messages

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID/messages

HTTP Method

GET

是否需要登录

是

传值方式

无

参数列表

参数名	是否必须	值类型
since	T	int
max	T	int
count	T	int

返回JSON

{
    "messages": [
        {
            "uuid": "R3R6tg6X",
            "user_uuid": "ThDxgFxK",
            "space_uuid": "SCEFCtg1",
            "page_uuid": "W61EiMp4",
            "send_time": 1571020963790806,
            "action": "add",
            "title": "F2045 1 草稿6",
            "message": "",
            "object_attr": "",
            "ext": {
                "updated_time": 1571020963,
                "version": 0
            },
            "type": "system"
        }
    ],
    "count": 1,
    "has_next": false
}

16. 页面导出

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID/export

HTTP Method

GET

是否需要登录

是

传值方式

JSON

参数列表

无

请求体示例

curl -X GET \
 https://your-host-name/wiki/api/wiki/team/3pDzCwAe/space/MAJPYt6j/page/CbA3y4i1/export \
  -H 'Ones-Auth-Token: ILg1uaO9d8MOG6rqQoe6Ozqkv27sTbgiKeDDgapEtIYnkyu8m6d51nq7og0koETZ' \
  -H 'Ones-User-Id: DU6krHBN' \
  -H 'Referer: https://your-host-name' \
  -H 'cache-control: no-cache'

17. 发送页面评论

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID/send_comment

HTTP Method

POST

是否需要登录

是

传值方式

JSON

参数列表

参数名	是否必须	值类型	取值范围	默认值	取值例子	说明
content	T	string				评论内容

18. 检查页面冲突

URL

https://your-host-name/wiki/api/wiki/team/:teamUUID/space/:spaceUUID/page/:pageUUID/check_version_conflict

HTTP Method

POST

是否需要登录

是

传值方式

JSON

参数列表

参数名	是否必须	值类型	取值范围	默认值	取值例子	说明
page_uuid	T	string					页面UUID
from_version	T	int					来源版本

目录

HTTP status code 说明

1. 获取页面详情

URL

HTTP Method

是否需要登录

传值方式

参数列表

请求体示例

返回体示例

2. 获取页面详情(路由中不带space_uuid)

URL

HTTP Method

是否需要登录

传值方式

参数列表

返回JSON

3. 删除页面

URL

HTTP Method

是否需要登录

传值方式

参数列表

请求体示例

4. 获取页面组的页面列表

URL

HTTP Method

是否需要登录

传值方式

参数列表

返回JSON

请求体示例

返回体示例

5. 获取页面组的带历史的页面列表

URL

HTTP Method

是否需要登录

传值方式

参数列表

返回体结构

返回值示例

6. 获取页面组的已加密的页面列表

URL

HTTP Method

是否需要登录

传值方式

参数列表

返返回体结构

返回体示例

7. 关注/取消关注页面

URL

HTTP Method

是否需要登录

传值方式

参数列表

8. 移动页面

URL

HTTP Method

是否需要登录

传值方式

参数列表

请求体示例

9. 页面的历史版本

URL

HTTP Method

是否需要登录

传值方式

参数列表

返回JSON

10. 页面历史版本（路由不带space_uuid）

URL

HTTP Method

是否需要登录

传值方式

参数列表

返回JSON

11. 页面回滚特定版本

URL

HTTP Method

是否需要登录