更新文档

创建于 2024-08-15 / 最近更新于 2024-08-16 / 126
字体: [默认] [大] [更大]

基本信息

接口地址: 您的域名/?m=Doc&a=action

请求方式: PUT

Get参数请求

参数 示例值 类型 默认值 是否必填 描述
m Doc string - 必填 控制器
a action string - 必填 方法

Header参数请求

参数 示例值 类型 默认值 是否必填 描述
Authorization base64(key:secret) string - 必填

Body参数请求

请求方式: JSON

示例格式:

{
  "id": "14",
  "title": "我是API创建的文档",
  "version": "1.0",
  "open": 0,
  "open_nav": 0,
  "open_sidebar": 1,
  "createtime": "2024-08-01",
  "cover": "",
  "read_organize": "",
  "attr": "",
  "copyright": "",
  "listsort": 0
}
参数 示例值 类型 默认值 是否必填 描述
id 1 string - 必填 编辑的文档ID
title 更新文档标题 string - 必填 文档标题
version 1.0 string - 必填 文档的版本号
open 0 string - 必填 0表示公开 1表示登录查看
open_nav 0 string - 必填 0表示关闭导读 1表示打开
open_sidebar 1 string - 必填 0表示目录收起 1表示展开
createtime 2024-08-01 string - 必填 文档创建日期,以YY-MM-DD H:I:S
cover - string - 非必填 上传文档封面的URL,详情请参考上传文件接口
read_organize - string - 非必填 允许查看文档的用户分组,ID以英文逗号区分
attr - string - 非必填 文档属性,属性ID用英文逗号分开
copyright - string - 非必填 当前文档全局的版权声明
listsort 0 string 0 非必填 文档排序值 (升序)

执行更新接口前,请备份数据。
发送数据前,请确保上面所有字段都填写了参数。非必填项留空会导致该字段内容被清空。因此请把您读取到的文档内容填上。

成功

成功时返回的结构

{
  "status": 200,
  "msg": "更新内容成功",
  "data": "",
  "url": "/?g=Doc&m=Doc&a=index",
  "waitSecond": "3",
  "token": "08bf0a53d0a49d4294177854bd0caa79_8442736678818"
}
0 人点赞过