请求方式:PUT (HTTPS)
请求地址:
https://open.welink.huaweicloud.com/api/knowledge/v1/articles/update
认证方式: access_token,请参考获取access_token
请求头部:
Accept-Charset:UTF-8
Content-Type:application/json
x-wlk-Authorization:access_token
lang:zh
请求参数:
{
"sourceArticleId":"id123",
"sourceName":"example",
"title":"标题示例",
"contentType":1,
"content":"内容示例",
"lang":0,
"isRecommended":1,
"isTopped":0,
"pubTime":1562633528,
"coverImg":"http://example.ex/cover.jpg",
"recDataStyle":1,
"excerpt":"摘要示例",
"cateName":["分类示例"],
"userId":"WeLink@tenant",
"uploadedDocumentIds":[3889]
}
请求参数说明:
参数 | 参数类型 | 必填 | 说明 |
---|---|---|---|
sourceArticleId | String | 是 | 当前来源识别文章的id【允许数字、字母、下划线,最大50个字符】 |
sourceName | String | 是 | 自定义来源识别字串【允许数字、字母、下划线,最大50个字符】 |
title | String | 否 | 标题【不传或为空表示不修改】 |
corpUserId | String | 否 | 作者在客户系统的登录标示,客户内唯一。corpUserId、userId都存在时优先使用corpUserId。【不传或为空表示不修改】 |
userId | String | 否 | 作者在WeLink中的用户账号【可在用户管理看到类似 xx@tenant 】。corpUserId、userId都存在时优先使用corpUserId。【不传或为空表示不修改】 |
contentType | Integer | 否 | 类型【0:链接型,1:内容型,4:文档型,不传或为空表示不修改】 |
content | String | 否 | 内容【不传或为空表示不修改】 |
link | String | 否 | 链接型文章的链接【不传或为空表示不修改】 |
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"}]。与uploadedDocumentIds同时存在时,以uploadedDocumentIds为准。 |
uploadedDocumentIds | Array | 否 | 附件ID列表【通过附件上传接口上传成功的附件ID,不传或为空表示不修改】。与documents同时存在时,以uploadedDocumentIds为准。 |
lang | Integer | 否 | 语言【0:中文 1:英文,不传或为空表示不修改】 |
isRecommended | Integer | 否 | 是否推荐【0:否 1:是,不传或为空表示不修改】 |
isTopped | Integer | 否 | 是否置顶【0:否 1:是,不传或为空表示不修改】 |
permissionDeptCodes | String | 否 | 指定可访问的部门,code为部门在WeLink中的部门编号,存在多个时用,分隔。默认所有部门都有权限 |
pubTime | Long | 否 | 发布时间,秒为单位的时间戳【不传或为空表示不修改】 |
coverImg | String | 否 | 封面图URL【不传表示不修改,为空表示置空】 |
recDataStyle | Integer | 否 | 条目模板【1:'左文右图',2:'大图卡',3:'视频(大)',4:'视频(小)',5:'直播',6:'音频',7:'博客',8:问答,9:文档式,不传或为空表示不修改】 |
excerpt | String | 否 | 摘要信息【不传表示不修改,为空表示置空】 |
isAutoCreateCate | Integer | 否 | 是否自动创建分类【0:否 1:是,默认:1】。 |
cateName | Array | 否 | 文章所属分类中文名。示例:["一级分类中文名", "二级分类中文名"]。为空时取一级默认分类;非空时,如果分类不存在,当isAutoCreateCate为0时返回分类不存在,当isAutoCreateCate为1时自动创建分类。 |
请求示例:
curl -X PUT \
'https://open.welink.huaweicloud.com/api/knowledge/v1/articles/update' \
-H 'Accept-Charset: UTF-8' \
-H 'Content-Type: application/json' \
-H 'x-wlk-Authorization: access_token' \
-d '{"sourceName":"example", "sourceArticleId":"id123"}'
响应格式说明
返回结果:
正常返回结果:
{
"code": "0",
"message": "success",
"data": {
"sourceArticleId" : "123456"
}
}
异常返回结果:
{
"code": "43011",
"message": "参数错误!"
}
返回参数说明:
参数 | 必选 | 参数类型 | 说明 |
---|---|---|---|
code | 是 | String | 数据正常返回“0”,如果发生错误,会返回对应的错误码。 |
message | 否 | String | 返回接口请求发生错误时的详细信息。正常情况无此信息 |
data | 否 | Object | 成功返回的数据 |
data.sourceArticleId | 是 | String | 成功的文章的sourceArticleId |
错误码说明:
错误码 | 说明 |
---|---|
0 | 成功 |
43021 | 认证异常 |
43011 | 参数错误 |
43012 | 操作失败 |
43051 | 用户异常:用户不存在 |
43052 | 部门异常:部门不存在 |
43053 | 分类异常:分类不存在 |
43054 | 附件异常:附件不存在、云盘获取附件信息失败 |
43999 | 系统错误 |