文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 删除工作项评论 - DeleteIssueNote
更新时间:2026-10-22 GMT+08:00
分享

删除工作项评论 - DeleteIssueNote

功能介绍

删除指定工作项下的评论。仅评论创建者可删除,删除评论后工作项的备注内容将被清空。

该接口会同步触发 testman 需求通知,用于跨系统数据同步。

调用方法

请参见如何调用API。

授权信息

当前API调用无需身份策略权限。

URI

DELETE /v2/workitem/issue-note

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户访问凭证。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

长度为10~32768个字符。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

id

是

Integer

参数解释:

评论ID。标识需要删除的工作项评论唯一记录。

约束限制:

评论必须存在,且当前用户必须是该评论的创建者。

取值范围:

不涉及。

默认取值:

不涉及。

projectId

是

String

参数解释:

项目ID。标识当前评论所属的项目,用于权限校验与服务可用性校验。

约束限制:

32位UUID字符串,且必须与评论对应工作项所属项目保持一致。

取值范围:

32个字符,由小写字母和数字组成。

默认取值:

不涉及。

type

否

String

参数解释:

工作项类型。标识当前操作对应的工作项类型分类。

约束限制:

不涉及。

取值范围:

  • scrum:Scrum项目类型工作项

  • 其他类型取值请参考实际业务定义。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

删除操作返回的业务结果,包含删除状态标识。

status

String

参数解释:

接口整体响应状态。

取值范围:

  • success:接口请求成功。

  • error:接口请求失败,详见错误码说明。

表4 result

参数

参数类型

描述

status

String

参数解释:

删除工作项评论的业务处理结果。

取值范围:

  • success:删除工作项评论成功。

请求示例

删除项目类型为scrum,项目ID为0e97bec7b32f4e0d8d9c1905e7274123,评论ID为13775504的评论

GET https://{endpoint}/v2/workitem/issue-note

{
  "id" : 13775504,
  "projectId" : "0e97bec7b32f4e0d8d9c1905e7274123",
  "type" : "scrum"
}

响应示例

无

状态码

状态码

描述

200

删除成功

401

未授权,Token无效或已过期

403

权限不足,非评论创建者或非项目成员

错误码

请参见错误码。

相关文档