查询工作项的关联代码 - GetCommitListByRelatedId

功能介绍

查询工作项的关联代码。

调用方法

请参见如何调用API。

授权信息

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

URI

GET /v2/issues/get-commit-list-by-related-id

表1 Query参数
参数	是否必选	参数类型	描述
pageNo	否	Integer	参数解释：分页索引。约束限制：不涉及取值范围：最小值0，最大值9,999,999,999。默认取值：不涉及。
pageSize	否	Integer	参数解释：分页大小。约束限制：不涉及。取值范围：最小值0，最大值9,999,999,999。默认取值：不涉及。
projectUUId	是	String	参数解释：项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。约束限制： 32位的数字和字母组成的字符串。取值范围：不涉及。默认取值：不涉及。
relatedId	否	Integer	参数解释：工作项id，可通过高级查询工作项接口获取，响应消息体中的id字段的值就是工作项id。约束限制：长度在1位到10位之间的纯数字。取值范围：最小长度：1，最大长度：10。默认取值：不涉及。
type	否	Integer	参数解释：查询类型。约束限制：不涉及。取值范围： commit（提交记录） branch（分支记录）默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制：必传。取值范围：最小长度：10，最大长度：32768。默认取值：不涉及。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
result	result object	参数解释：查询关联代码的返回结果。取值范围：不涉及。
status	String	参数解释：返回状态。取值范围： success：返回成功。 error：返回失败。

表4 result
参数	参数类型	描述
total	Integer	参数解释：关联代码总数。取值范围：不涉及。
list	Array of list objects	参数解释：关联代码详情。取值范围：不涉及。

表5 list
参数	参数类型	描述
id	String	参数解释：用户数字id。取值范围：不涉及。
iamId	String	参数解释：用户IAM账号id。取值范围：不涉及。
userName	String	参数解释：用户名。取值范围：不涉及。
type	String	参数解释：关联代码的类型。取值范围： commit（提交记录） branch（分支记录）默认取值：不涉及。
branchName	String	参数解释：分支名称。取值范围：不涉及。
commitMsg	String	参数解释：提交信息。默认取值：不涉及。
commitUrl	String	参数解释：提交的URL地址。默认取值：不涉及。
relatedId	String	参数解释：关联代码的id。默认取值：不涉及。
createAt	String	参数解释：关联代码的创建时间时间戳（示例：1754361449000）。取值范围：不涉及。
updateAt	String	参数解释：关联代码的更新时间时间戳（示例：1754361449000）。取值范围：不涉及。
result	Integer	参数解释：结果。默认取值：不涉及。
relatedUrl	String	参数解释：关联代码的URL地址。默认取值：不涉及。

请求示例

查询关联代码。

GET https://{endpoint}/v1/issue/getCommitListByRelatedId?type=branch&relatedId=2882611&projectUUId=781f0e01ebe74fcba89a540cea7792ef&pageSize=10&pageNo=1&_=1755748261141

响应示例

状态码：200

查询工作项的关联代码接口成功的响应。

{
  "result" : {
    "total" : 1,
    "list" : [ {
      "id" : "0000",
      "iamId" : "xxxxxxxxxxxxxxxxxxx",
      "userName" : "xxxxxxxxxx",
      "type" : "branch",
      "branchName" : "xxxxxxxxxx",
      "commitMsg" : "xxxxxxxxxx",
      "commitUrl" : "https://xxxxx.com/home?xxxxx",
      "relatedId" : "000000",
      "createAt" : "2025-08-08T08:33:48.000+00:00",
      "updateAt" : "2025-08-08T08:33:48.000+00:00",
      "result" : 1,
      "relatedUrl" : "https://xxxxx.com/home?xxxxx"
    } ]
  },
  "status" : "success"
}