简体中文
更新知识条目
约 686 字大约 2 分钟
2026-09-14
描述
更新指定知识条目的标题、所属文件夹、正文等内容字段。
本接口为平台标准对象更新接口,通过 dataObjectApiName 指定对象,固定取值 ServiceKnowledgeObj;仅传入需要变更的字段,未传字段保持原值。
请求说明
请求方式 :POST + application/json
请求路径 :https://${填入所在云的域名}/cgi/crm/v2/data/update?thirdTraceId=${随机字符串}
请求头填写 :参考公共参数填写
请求参数
详细字段说明请参考 参数填写说明
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| triggerApprovalFlow | Boolean | 否 | 是否触发审批流,不传时默认为 true,表示触发 |
| triggerWorkFlow | Boolean | 否 | 是否触发工作流,不传时默认为 true,表示触发 |
| data | Map | 是 | 数据 |
| object_data | Map | 是 | 待更新的知识条目对象,仅需传入需要变更的字段 |
| object_data.dataObjectApiName | String | 是 | 对象 apiName,固定值 ServiceKnowledgeObj |
| object_data._id | String | 是 | 知识条目 ID |
| object_data.title | String | 否 | 标题 |
| object_data.category | String | 否 | 所属知识文件夹 code |
| object_data.content_type | String | 否 | 内容类型:text 纯文本、rich_text 富文本、enclosure 附件 |
| object_data.text | String | 否 | 纯文本内容 |
| object_data.rich_text | String | 否 | 富文本内容(HTML) |
| object_data.material_message | Array | 否 | 附件列表 |
| object_data.summary | String | 否 | 简介 |
| object_data.permanent_validity | Boolean | 否 | 是否永久有效 |
| object_data.validity_begin_time | Long | 否 | 有效期开始时间,毫秒时间戳 |
| object_data.validity_end_time | Long | 否 | 有效期结束时间,毫秒时间戳 |
请求示例
{
"data": {
"object_data": {
"dataObjectApiName": "ServiceKnowledgeObj",
"_id": "68c1a0f0abcd0001",
"title": "设备安装说明(修订)",
"category": "16",
"content_type": "rich_text",
"rich_text": "<p>修订后的步骤</p>"
}
}
}返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| traceId | string | 请求唯一ID |
| errorDescription | string | 错误描述 |
| dataId | String | 更新后的知识条目 ID |
| errorMessage | string | 错误信息 |
| errorCode | Int | 查看错误码 |
返回示例
{
"traceId": "E-O.fktest4234.1000-20260914101000-xxxxxx",
"errorDescription": "success",
"dataId": "68c1a0f0abcd0001",
"errorMessage": "OK",
"errorCode": 0
}注意事项
- 更新不会改变条目的发布状态:已发布条目更新成功后仍保持「已发布」。
- 变更发布状态请使用发布、下架接口;不建议通过本接口直接写入
public_status字段,那样不会触发发布流程的副作用(如同步索引)。 - 附件字段(
material_message、large_attachment)元素中传入的预览/下载地址类键值(preview_path、download_path等)会被服务端清除,无需传入。 - 更换
content_type时请同时传入对应正文字段,否则正文可能为空。 - 人员、附件类字段遵循标准对象接口的 openUserId / mediaId 约定,网关自动完成双向转换。
- 更新结果可通过知识条目列表查询确认。
- 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
