如何通过REST API在ServiceNow中添加评论与工作笔记?求API详情
ServiceNow 提交评论/工作笔记的REST API 详细说明
ServiceNow中提交公开评论和内部工作笔记,核心是通过更新对应业务表记录字段的REST API实现,无需专门的独立端点,直接复用表记录的更新接口即可:
核心API端点
针对任意业务表(比如事件表incident、变更请求表change_request),接口格式为:POST /api/now/table/{table_name}/{sys_id} 或 PUT /api/now/table/{table_name}/{sys_id}
注:PUT更贴合“更新资源”的REST语义,POST也能正常生效,二者任选其一即可
关键字段说明
comments:公开评论字段,所有有权限查看该记录的用户均可看到work_notes:内部工作笔记字段,仅内部ITSM相关人员可见
请求示例
1. 提交公开评论(POST方式)
- 请求URL:
POST /api/now/table/incident/0a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p(替换为实际事件的sys_id) - 请求头:
Content-Type: application/jsonAuthorization: Basic dXNlcjE6cGFzc3dvcmQ=(替换为base64编码的用户名:密码)
- 请求体(JSON格式):
{ "comments": "用户反馈系统登录缓慢,已安排运维排查服务器负载情况" }
2. 提交工作笔记(PUT方式)
- 请求URL:
PUT /api/now/table/change_request/9z8y7x6w5v4u3t2s1r0q9p8o7n6m5l(替换为实际变更请求的sys_id) - 请求头同上
- 请求体(JSON格式):
{ "work_notes": "已完成预生产环境测试,未发现兼容性问题,可推进至生产环境" }
注意事项
- 必须替换
{table_name}为目标业务表的名称(比如problem、task等通用任务表) {sys_id}是目标记录的唯一系统标识,可通过ServiceNow前端页面URL或列表导出获取- 调用API的用户需拥有对应表的写入权限,以及添加评论/工作笔记的权限
- 支持同时提交评论和工作笔记,只需在请求体中同时包含
comments和work_notes字段 - 响应会返回更新后的完整记录,可在响应体中验证评论/工作笔记是否已添加成功
内容的提问来源于stack exchange,提问作者Akshay Babar
相关产品推荐
相关产品推荐

