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

获取关联工作项信息

功能介绍

获取关联工作项信息。

调试

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

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

repository_uuid

是

String

仓库长ID

type

否

Integer

关联工作项类型

search

否

String

查询关键字

page

否

Integer

页码

per_page

否

Integer

每页数量

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

error

Object Error

响应错误

result

Object RelatedCommitListVo

关联工作项列表

status

String

响应状态

表4 响应Error参数

参数

参数类型

描述

code

String

错误码

message

String

错误信息
表5 响应RelatedCommitListVo参数

参数

参数类型

描述

total

Integer

返回结果条数

list

Array RelatedCommitVo

返回结果数组
表6 响应RelatedCommitVo参数

参数

参数类型

描述

id

String

主键ID

iam_id

String

用户ID

user_name

String

用户名称

repository_id

String

仓库ID

type

String

类型

user_id

String

用户ID

branch_name

String

分支名称

commit_id

String

Commit ID

commit_shortId

String

Commit 短ID

commit_msg

String

提交信息

commit_url

String

提交URL

commit_type

String

提交类型

related_id

String

工作项ID

create_at

String

创建时间

update_at

String

更新时间

related_url

String

工作項URL

message

String

描述

请求示例

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

响应示例

状态码： 200

OK 
{
    "result": [{
        "id": "1",
        "iamId": "66666",
        "userName": "test",
        "repositoryId": "8",
        "type": "commit",
        "userId": "6776",
        "branchName": "master",
        "commitId": "1",
        "commitShortId": "1",
        "commitMsg": "1",
        "commitUrl": "",
        "commitType": "",
        "relatedId": "",
        "relatedUrl": "",
        "message": "",
        "createdAt": "",
        "updatedAt": ""
    }],
    "status": "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码。

父主题： Repository

相关文档