- 最新动态
- 功能总览
- 产品介绍
- 计费说明
- 快速入门
-
用户指南
- 需求管理(CodeArts Req)使用流程
- 购买并授权使用CodeArts Req
- 访问CodeArts Req服务首页
- 创建CodeArts项目
- 管理Scrum类型项目需求
- 管理IPD系统设备类型项目需求
- 管理IPD独立软件类型项目需求
- 管理IPD自运营/云服务类型项目需求
- 管理看板类型项目需求
- 查看审计日志(可选)
- 知识库用户指南
- 最佳实践
-
API参考
- 使用前必读
- API概览
- 如何调用API
-
API
- 用户信息
- 项目成员
- 项目信息
- 项目指标
- 项目统计
- 项目及成员
- Scrum项目的迭代
-
Scrum项目的工作项
- 创建工作项类型自定义字段
- 上传图片
- 获取工作项完成率
- 获取指定工作项的评论列表
- 按用户查询工时(单项目)
- 按用户查询工时(多项目)
- 添加指定工作项工时
- 查询项目下的工时类型
- 获取工作项历史记录
- 创建工作项
- 查询项目的工作项
- 高级查询工作项
- 批量删除工作项
- 查询工作项详情
- 更新工作项
- 删除工作项
- 获取子工作项
- 查询项目下所有工作项的历史记录
- 查询Scrum项目的工作项流转配置
- 细粒度权限用户创建工作项
- 查询当前工作项已经关联的工作项
- 查询当前工作项已经关联的关联Wiki
- 查询当前工作项已经关联的代码提交记录 / 分支创建记录
- 查询关联用例
- 查询Scrum工作项自定义字段
- 下载图片
- 上传工作项附件
- 下载工作项附件
- 删除附件
- 查询迭代下工作项状态的统计数据(处理人维度)
- 获取指定工作项停留时间
- 高级查询我的待办工作项
- Scrum项目的模块
- Scrum项目的领域
- Scrum项目的状态
- 看板项目的工作项
- IPD项目计划管理
- IPD工作项管理
- IPD统计概览
- IPD模块管理
- IPD配置管理
- IPD评审单管理
- IPD标签管理
- OpenAPI管理
- 应用示例
- 附录
- 文档修订记录
- 常见问题
- 视频帮助
- 文档下载
- 通用参考
链接复制成功!
查询当前工作项已经关联的代码提交记录 / 分支创建记录
功能介绍
查询当前工作项已经关联的代码提交记录 / 分支创建记录
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/issues/{issue_id}/associated-commits
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表 约束限制:正则表达式, ^[A-Za-z0-9]{32}$ 取值范围:字符串,最小长度:32,最大长度:32 默认取值:不涉及 |
issue_id |
是 |
Integer |
参数解释:工作项id,可通过ListIssuesV4接口高级查询工作项 约束限制:正则表达式,[0-9]{1,10}$ 取值范围:最小长度:1,最大长度:10 默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
type |
否 |
String |
参数解释:查询类型: 约束限制:正则表达式, ^(commit|branch)$ 取值范围:commit(提交记录) || branch(分支记录) 默认取值:不涉及 |
limit |
否 |
Integer |
参数解释:每页数量 约束限制:不涉及 取值范围:最小值:1 最大值:100 默认取值:100 |
offset |
否 |
Integer |
参数解释:偏移量 从0开始 约束限制:正则表达式,^0|[1-9]\d{0,10}$ 取值范围:最小值:0 默认取值:0 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制:不涉及 取值范围:最小长度:10,最大长度:32768 默认取值:不涉及 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
commits |
Array of CommitRecordDetail objects |
提交记录列表 |
total |
Integer |
提交记录总数 |
参数 |
参数类型 |
描述 |
---|---|---|
repository_id |
String |
仓库ID |
branch_name |
String |
分支名称 |
commit_id |
String |
commit id |
commit_short_id |
String |
commit short id |
commit_msg |
String |
commit 信息 |
commit_url |
String |
commit URL |
user |
SimpleUser object |
用户信息 |
type |
String |
查询的类型 |
create_date |
String |
创建时间 |
update_date |
String |
更新时间 |
参数 |
参数类型 |
描述 |
---|---|---|
user_num_id |
Integer |
用户数字id |
user_id |
String |
用户32位uuid,用户唯一标识 |
user_name |
String |
账号名 |
nick_name |
String |
用户昵称 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
状态码: 401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
请求示例
GET https://{endpoint}/v4/projects/{project_id}/issues/{issue_id}/associated-commits GET https://{endpoint}/v4/projects/a360371833bf4c558f796fd707b44daf/issues/122344/associated-commits
响应示例
状态码: 200
{ "commits" : [ { "repository_id" : "1865706", "branch_name" : "master", "commit_id" : "f608b02311d90f311c41711fdf67003c31305b89", "commit_short_id" : "f608b023", "commit_msg" : "demo", "commit_url" : "https://xxx.xxx/xxxx/commit/791877f7d0e0b2032bc5e38425c1245e804e8741?ref=master", "user" : { "user_num_id" : 4091, "user_id" : "a360371833bf4c558f796fd707b44daf", "user_name" : "demo_user_name_xiongzhitest001", "nick_name" : "bear" }, "type" : "branch", "create_date" : "2021-11-18 19:47:34", "update_date" : "2021-11-18 19:47:34" } ], "total" : "success" }
状态码
状态码 |
描述 |
---|---|
200 |
Success |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。