文档库新建
更新时间:2023-03-10
文档库新建
1、接口地址:(POST) {IP}:{PORT}/open/v1/document/create
2、入参(需生成json字符串,放到请求的body中)
参数名 | 类型 | 是否可空 | 父节点 | 备注 |
---|---|---|---|---|
dirId | 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< string> | 是 | 标签列表 | |
linkNum | int | 是 | 链接数【页面展示用】 | |
pictureNum | int | 是 | 图片数【页面展示用】 | |
wordNum | int | 是 | 文档字符数(如果richText不为空,则此字段必传,数量为richText去掉标签和空格后所剩长度) |
示例
POST /open/v{versionId}/document/create
{
"dirId": "0",
"richText": "<p>文档库内容<a href=\"http://www.xxxx.com\" target=\"_blank\">www.xxxx.com</a></p>",
"plainText": "文档库内容www.xxxx.com",
"title": "文档库测试",
"attaches": [{
"url": "http://127.0.0.1:8888/api/v2/file/download?key=Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
"name": "测试图.jpg",
"key": "Ym9zX2FhODEwYWVkLWZmZTUtNDEzZS1hY2M2LWU3ZjY4ZDVlMWIyYw==",
"size": 23663,
}],
"faqs": ["id1"],
"tags": ["标签1", "标签2"],
"wordNum": 17,
"pictureNum": 0,
"linkNum": 1
}
3.返回值
参数名 | 类型 | 父节点 | 备注 |
---|---|---|---|
code | int | HTTP状态码 | |
time | long | 时间 | |
msg | string | 状态信息 | |
data | T | 返回数据 | |
id | string | data | 文档库ID |