文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Project/ 工作项关联的提交信息
更新时间：2025-09-29 GMT+08:00
查看PDF
分享

工作项关联的提交信息

功能介绍

工作项关联的提交信息

调试

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

URI

GET /v4/projects/{project_id}/items/{item_id}/commits

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口查询项目列表获取。

取值范围：

字符串长度32。

item_id

是

String

参数解释：

工作项Id。

约束限制：

不涉及

取值范围：

字符串长度不少于1，不超过128。
表2 Query参数

参数

是否必选

参数类型

描述

type

否

String

参数解释：

工作项关联的提交类型。

约束限制：

不涉及

取值范围：

  • commit，提交。

  • branch，分支。

  • mergerequest，合并请求。

默认取值：

commit

枚举值：

  • commit

  • branch

  • mergerequest

offset

否

Integer

参数解释：

偏移量，从0开始。

取值范围：

0-2147483647

默认取值：

0

limit

否

Integer

参数解释：

返回数量。

取值范围：

1-100

默认取值：

20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-Total

String

当前请求的结果总条数
表5 响应Body参数

参数

参数类型

描述

[数组元素]

Array of ItemCommitDto objects

工作项关联的提交信息列表
表6 ItemCommitDto

参数

参数类型

描述

id

Integer

参数解释：

关联Id。

取值范围：

不涉及

取值范围：

0-2147483647

title

String

参数解释：

合并请求标题。

取值范围：

不涉及。

result

Integer

参数解释：

仓库状态。

取值范围：

  • 1，关联成功。

  • 2，关联失败。

  • 3，流转成功。

取值范围：

0-10

type

String

参数解释：

关联提交类型。

取值范围：

  • commit，提交。

  • branch，分支。

  • mergerequest，合并请求。

message

String

参数解释：

关联失败的失败原因。

取值范围：

不涉及。

item_id

String

参数解释：

工作项Id。

取值范围：

不涉及。

repository_id

String

参数解释：

仓库Id。

取值范围：

不涉及。

branch_name

String

参数解释：

分支名。

取值范围：

不涉及。

user_name

String

参数解释：

用户名。

取值范围：

不涉及。

commit_id

String

参数解释：

提交Id。

取值范围：

不涉及。

commit_short_id

String

参数解释：

提交短Id。

取值范围：

不涉及。

commit_msg

String

参数解释：

提交信息。

取值范围：

不涉及。

commit_url

String

参数解释：

提交访问地址。

取值范围：

不涉及。

iam_id

String

参数解释：

iamId。

取值范围：

不涉及。

create_at

String

参数解释：

创建时间。

取值范围：

不涉及。

update_at

String

参数解释：

更新时间。

取值范围：

不涉及。

item_url

String

参数解释：

工作项访问地址。

取值范围：

不涉及。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/projects/936c6b54d29446958a7e668d04eceaac/items/9261401/commits

响应示例

状态码：200

OK

[ {
  "id" : 2111625445,
  "title" : null,
  "result" : 3,
  "type" : "commit",
  "message" : null,
  "iam_id" : "c369c68f1ff84679b5a8ed904d8bff1c",
  "repository_id" : "2111984490",
  "branch_name" : "dev1",
  "user_name" : "CodeHub_beta_dev",
  "commit_id" : "9052a9accb4b2838daefeda790bda8c871ee3551",
  "commit_short_id" : "9052a9ac",
  "commit_msg" : "更新 README.md fix #9261401 dev123",
  "commit_url" : "https://example.com/codehub/2111984490/9052a9accb4b2838daefeda790bda8c871ee3551/commitdetail",
  "item_id" : "9261401",
  "create_at" : "2025-09-17T07:58:59.000+00:00",
  "update_at" : "null,",
  "item_url" : "https://example.com/projectman/scrum/936c6b54d29446958a7e668d04eceaac/task/detail/9261401"
} ]

状态码：401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "认证信息过期"
}

状态码：403

Bad Request

{
  "error_code" : "DEV-23-50804",
  "error_msg" : "您没有操作权限，请升级权限后重试。"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Bad Request

错误码

请参见错误码。

父主题： Project

相关文档