文档首页/代码托管 CodeArts Repo/API参考/API/Repository/获取关联工作项信息
更新时间：2026-01-23 GMT+08:00
查看PDF
分享

获取关联工作项信息

功能介绍

获取仓库关联工作项信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v2/repositories/{repository_uuid}/related-commits

表1 路径参数

参数

是否必选

参数类型

描述

repository_uuid

是

String

参数解释：

仓库UUID(参考获取仓库详情接口返回uuid)。

约束限制：

不涉及。

取值范围：

由数字和字母组成，且长度为32个字符。

默认取值：

不涉及。

type

否

Integer

参数解释：

关联工作项类型。

约束限制：

不涉及。

取值范围：

  • 0，表示源自Commit的关联工作项。
  • 1，表示源自合并请求的关联工作项。

默认取值：

0

search

否

String

参数解释：

查询关键字。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

page

否

Integer

参数解释：

页码。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

1

per_page

否

Integer

参数解释：

每页数量。

约束限制：

不涉及。

取值范围：

1-100

默认取值：

20

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

长度为[1,100000]个字符。

默认取值：

不涉及。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

error

Object Error

参数解释：

响应错误码。

取值范围：

不涉及。

result

Object RelatedCommitListVo

参数解释：

关联工作项列表。

取值范围：

不涉及。

status

String

参数解释：

调用此接口的响应状态。

取值范围：

  • success，表示接口调用成功。
  • failed，表示接口调用失败。

表4 响应Error参数

参数

参数类型

描述

code

String

参数解释：

错误码。

取值范围：

符合错误码格式字符串，长度[0,100]。

message

String

参数解释：

错误信息。

取值范围：

不涉及。

表5 响应RelatedCommitListVo参数

参数

参数类型

描述

total

Integer

参数解释：

返回结果条数

取值范围：

不涉及。

list

Array RelatedCommitVo

参数解释：

返回结果数组

取值范围：

不涉及。

表6 响应RelatedCommitVo参数

参数

参数类型

描述

id

String

参数解释：

关联工作项主键ID。

取值范围：

不涉及。

iamId

String

参数解释：

用户IAM ID。

取值范围：

不涉及。

userName

String

参数解释：

用户名称。

取值范围：

不涉及。

repoId

String

参数解释：

仓库ID。

取值范围：

不涉及。

tenantName

String

参数解释：

租户名。

取值范围：

不涉及。

nickName

String

参数解释：

用户昵称。

取值范围：

不涉及。

branchName

String

参数解释：

分支名称。

取值范围：

不涉及。

commitId

String

参数解释：

Commit ID

取值范围：

不涉及。

commitShortId

String

参数解释：

Commit短ID

取值范围：

不涉及。

commitMsg

String

参数解释：

提交信息。

取值范围：

不涉及。

commitUrl

String

参数解释：

提交URL。

取值范围：

不涉及。

relatedId

String

参数解释：

工作项ID。

取值范围：

不涉及。

createAt

String

参数解释：

创建时间。

取值范围：

不涉及。

updateAt

String

参数解释：

更新时间。

取值范围：

不涉及。

relatedUrl

String

参数解释：

工作项URL。

取值范围：

不涉及。

result

String

参数解释：

关联结果。

取值范围：

  • 0，表示关联不成功。
  • 1，表示关联成功。

请求示例

GET https://{endpoint}/v2/repositories/{repository_uuid}/related-commits

响应示例

状态码： 200

OK 
{
  "result": {
    "total": 1,
    "list": [
      {
        "id": "1",
        "iamId": "eab0854acdda4b3d90f51de6f9d6349e",
        "userName": "test",
        "tenantName": "tenant_name",
        "nickName": "nick_name",
        "repoId": "8",
        "userId": "6776",
        "branchName": "master",
        "commitId": "30baec6147897d404f1ed1f44a7dec0e300a2d271",
        "commitShortId": "30baec61",
        "commitMsg": "1",
        "commitUrl": "https://example.com/codehub/2111986349/30baec6147897d404f1ed1f44a7dec0e300a2d27/commitdetail",
        "relatedId": "9152325",
        "relatedUrl": "https://example.com/projectman/scrum/c1f7364751e0406b8d9a46f492cba662/task/detail/9152325",
        "result": 1,
        "createdAt": "",
        "updatedAt": ""
      }
    ]
  },
  "status": "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题：Repository

相关文档