知识管理新增文章
【摘要】 创建知识接受文章信息,同步新增WeLink知识。此接口为同步接口,返回的信息是文章的ID。请求格式说明请求方式:POST (HTTPS)请求地址:https://open.welink.huaweicloud.com/api/knowledge/v1/articles/add认证方式: access_token,请参考获取access_token请求头部:Accept-Charset:UTF...
创建知识
接受文章信息,同步新增WeLink知识。
此接口为同步接口,返回的信息是文章的ID。
请求格式说明
请求方式:POST (HTTPS)
请求地址:
https://open.welink.huaweicloud.com/api/knowledge/v1/articles/add
认证方式: access_token,请参考获取access_token
请求头部:
Accept-Charset:UTF-8 Content-Type:application/json x-wlk-Authorization:access_token
请求参数:
{ "sourceName":"example", "sourceArticleId":"id123", "title":"标题示例", "contentType":1, "content":"内容示例", "link":"http://example.ex/", "lang":0, "isRecommended":1, "isTopped":0, "pubTime":1562633528, "coverImg":"http://example.ex/cover.jpg", "recDataStyle":1, "excerpt":"摘要示例", "cateName":"分类示例", "userId":"WeLink@tenant", "documents":"[{\"name\":\"text.doc\",\"url\":\"http://example.ex/abc.doc\"}]" }
请求参数说明:
参数 | 参数类型 | 必填 | 说明 |
---|---|---|---|
sourceName | String | 是 | 自定义来源识别字串【允许数字、字母、下划线,最大50个字符】 |
sourceArticleId | String | 是 | 当前来源识别某篇文章的唯一id【允许数字、字母、下划线,最大50个字符】 |
title | String | 是 | 标题 |
corpUserId | String | 特殊可选 | 作者在客户系统的登录标示,客户内唯一。corpUserId、userId不可同时为空,都存在时优先使用corpUserId |
userId | String | 特殊可选 | 作者在WeLink中的用户账号【可在用户管理看到类似 xx@tenant 】。corpUserId、userId不可同时为空,都存在时优先使用corpUserId |
contentType | Integer | 否 | 类型【0:链接型,1:内容型,默认为:1】 |
content | String | 否 | 内容【contentType为1必传,其它非必须传】 |
link | String | 否 | 链接型文章的链接【contentType为0必传 】 |
documents | Array | 否 | 附件信息。每个文件内容,name:文档完整名,包含后缀;size:文件大小,单位B;url:下载地址。示例:[{"name":"文档名称.doc","size":"1024","url":"http://xxx.com/xxx.doc"}, {"name":"Excel文件名称.xls","size":"1024","url":"http://xxx.com/xxx.xls"}] |
moduleType | String | 否 | 文章模块【bulletins:信息发布文章,默认为bulletins】 |
lang | Integer | 否 | 语言【0:中文 1:英文,默认:0】 |
isRecommended | Integer | 否 | 是否推荐【0:否 1:是,默认:0】 |
isTopped | Integer | 否 | 是否置顶【0:否 1:是,默认:0】 |
pubTime | Long | 否 | 发布时间,秒为单位的时间戳【不传则取当前时间】 |
coverImg | String | 否 | 封面图URL |
recDataStyle | Integer | 否 | 条目模板,【1:'左文右图',2:'大图卡',3:'视频(大)',4:'视频(小)',5:'直播',6:'音频',7:'博客',8:问答,9:文档式。默认为:1】 |
excerpt | String | 否 | 摘要信息 |
cateName | String | 否 | 文章所属分类,不传则取默认分类或第一个分类,传则取传过来的分类,没有则新建分类 |
请求示例:
curl -X POST \ 'https://open.welink.huaweicloud.com/api/knowledge/v1/articles/add' \ -H 'Accept-Charset: UTF-8' \ -H 'Content-Type: application/json' \ -H 'x-wlk-Authorization: access_token' \ -d '{"sourceName":"example", "sourceArticleId":"id123"}'
响应格式说明
返回结果:
正常返回结果:
{ "code": "0", "data": { "sourceArticleId" : "123456" } }
异常返回结果:
{ "code": "43011", "message": "parameter user is empty!" }
返回参数说明:
参数 | 必选 | 参数类型 | 说明 |
---|---|---|---|
code | 是 | String | 数据正常返回“0”,如果发生错误,会返回对应的错误码。 |
message | 否 | String | 返回接口请求发生错误时的详细信息。正常情况无此信息 |
data | 否 | Object | 成功返回的数据 |
data.sourceArticleId | 是 | String | 成功的文章的sourceArticleId |
错误码说明:
错误码 | 说明 |
---|---|
0 | 成功 |
43021 | 认证异常 |
43011 | 参数错误 |
43012 | 操作失败 |
【版权声明】本文为华为云社区用户原创内容,未经允许不得转载,如需转载请自行联系原作者进行授权。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱:
cloudbbs@huaweicloud.com
- 点赞
- 收藏
- 关注作者
评论(0)