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

工作项添加关注

功能介绍

工作项添加关注。

调用方法

请参见如何调用API

URI

POST /v2/issues/watch

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

type

String

参数解释:

当前项目的类型。

约束限制:

不涉及。

取值范围:

SCRUM

默认取值:

不涉及。

issue_id

String

参数解释:

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

约束限制:

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

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

result object

参数解释:

关注完成后返回的结果。

status

String

参数解释:

当前请求的状态。

取值范围:

success:成功

error:失败

表4 result

参数

参数类型

描述

watcher

watcher object

参数解释:

关注的工作项的结构体。

表5 watcher

参数

参数类型

描述

id

Integer

参数解释:

当前关注记录的唯一id。

取值范围:

不涉及。

watchable_type

String

参数解释:

关注的工作项的类型。

取值范围:

Issue:关注工作项

project:关注项目。

watchable_id

Integer

参数解释:

关注的工作项id或项目id。

取值范围:

不涉及。

user_id

Integer

参数解释:

关注者的用户id。

取值范围:

不涉及。

region

String

参数解释:

当前项目所在的区域位置。

取值范围:

不涉及。

请求示例

{endpoint}/v2/issues/watch?_=1754368218398

{
  "issue_id" : 9192160,
  "type" : "scrum"
}

响应示例

状态码:200

当前请求的响应体。

{
  "result" : {
    "watcher" : {
      "id" : 226991,
      "watchable_type" : "Issue",
      "watchable_id" : 9192160,
      "user_id" : 4091,
      "region" : "cn-north-7"
    }
  },
  "status" : "success"
}

状态码

状态码

描述

200

当前请求的响应体。

错误码

请参见错误码

相关文档