文档库更新
更新时间:2023-03-10
文档库更新
1、接口地址:(POST) {IP}:{PORT}/open/v1/document/update
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 父节点 | 备注 |
---|---|---|---|---|
id | string | 否 | 文档id | |
contentVersion | string | 否 | 内容版本号 | |
dococEditStatus | short | 是 | 更新状态,0表示未正在编辑,1表示正在编辑 | |
dirIds | string | 否 | 目录id | |
title | string | 是 | 关联的标题(如果未更改标题,则传入原标题) | |
richText | string | 是 | 富文本数据 | |
plainText | string | 是 | 纯文本数据【如果有富文本的情况下,需要把富文本中的纯文字提取出来,放到这个字段中。纯文本不可单独存在】 | |
attaches | list | 是 | 关联的附件列表 | |
uid | string | 是 | attaches | 附件上传者id |
username | string | 是 | attaches | 附件上传者名称 |
url | string | 否 | attaches | 地址 |
name | string | 否 | attaches | 名称 |
key | string | 否 | attaches | 获取预览地址时使用 |
size | string | 否 | attaches | 文件大小 |
faqs | list< string> | 是 | 关联标准问的id列表 | |
tags | list< sring> | 是 | 标签列表 | |
linkNum | int | 是 | 链接数【页面展示用】 | |
pictureNum | int | 是 | 图片数【页面展示用】 | |
wordNum | int | 是 | 文档字符数(如果richText不为空,则此字段必传,数量为richText去掉标签和空格后所剩长度) |
请求示例
POST /open/v{versionId}/document/update
{
"attaches": [{
"url": "http://127.0.0.1:8080/api/v2/file/downloadkey=Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
"name": "测试图.jpg",,
"size": 23663,
"key": "Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw=="
}],
"contentVersion": 0,
"dirId": "0",
"docEditingStatus": 2,
"faqs": ["id1"],
"id": "xxxxxxxxxxxxxxxxxxx",
"linkNum": 1,
"pictureNum": 1,
"richText": "<p>文档库内容<a href=\"http://www.xxxx.com\" target=\"_blank\">www.xxxx.com</a><img src=\"http://服务地址:端口号/api/v2/file/download?key=Ym9zX2E1ZDczZWQ3LTgzNWEtNDJkNy05NzBmLWUwZjM1MThmMDc1Nw==\" style=\"\"></p>",
"tags": ["标签1", "标签2"],
"title": "文档库测试更新",
"wordNum": 17,
"plainText": "文档库内容www.xxxx.com[图片]"
}
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
contentVersion | int | 文档内容版本 |