更新时间:2025-09-11 GMT+08:00
分享

更新工作项评论

功能介绍

更新工作项评论。

调用方法

请参见如何调用API

URI

POST /v2/workitem/issue-note

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

id

String

参数解释:

工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。

约束限制:

长度在1位到10位之间的纯数字。

取值范围:

最小长度:1,最大长度:10。

默认取值:

不涉及。

notes

String

参数解释:

工作项的评论内容。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

projectUUId

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

由数字和英文组成的32字符串。

取值范围

不涉及。

默认取值

不涉及。

type

String

参数解释

工作项所属项目类型。

约束限制

不涉及。

取值范围

scrum。

默认取值

不涉及。

noteId

String

参数解释:

工作项的评论id。通过获取工作项的评论V2接口查询工作项的评论信息,返回数据的comments中的id为评论id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

返回结果。

取值范围:

不涉及。

status

String

参数解释:

返回状态。

取值范围:

success:返回成功。

error:返回失败。

表4 result

参数

参数类型

描述

status

String

参数解释:

返回更新状态。

取值范围:

success:更新成功。

error:更新失败。

请求示例

POST http://{endpoint}/v2/workitem/issue-note

{
  "id" : 9206017,
  "noteId" : 87298751,
  "notes" : "TEST",
  "projectUUId" : "a8ac165097ff4e42bcfb234dd27d30a6",
  "type" : "scrum"
}

响应示例

状态码:200

更新工作项评论接口成功的响应。

{
  "result" : {
    "status" : "success"
  },
  "status" : "success"
}

状态码

状态码

描述

200

更新工作项评论接口成功的响应。

错误码

请参见错误码

相关文档