文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ ThirdParty/ 获取仓库下工作项列表
更新时间：2025-07-15 GMT+08:00
查看PDF
分享

获取仓库下工作项列表

功能介绍

获取仓库下工作项列表

调试

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

URI

GET /v4/repositories/{repository_id}/work-items

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

仓库的ID，通过查询用户所有仓库接口查询项目列表获取。

约束限制：

不涉及。

取值范围：

1-2147483647
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

偏移量，从0开始。

取值范围：

0-2147483647

默认取值：

0

limit

否

Integer

参数解释：

返回数量。

取值范围：

1-100

默认取值：

20

project_id

是

String

参数解释：

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

取值范围：

字符串长度32。

is_ipd

是

Boolean

参数解释：

是否为IPD类型项目的工作项。

取值范围：

true/false

subject

否

String

参数解释：

工作项标题搜索关键字。

取值范围：

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

target_branch

否

String

参数解释：

合并请求的目标分支，如果要获取合并请求可关联的工作项列表，则需要传递该字段。

约束限制：

不支持以 - . refs/heads/ refs/remotes/ 开头，不支持空格 [ \ < ~ ^ : ? * ! ( ) ' " | 等特殊字符，不支持以. / .lock结尾。

取值范围：

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

默认取值：

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

必传。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Header参数

参数

参数类型

描述

X-Total

Integer

参数解释：

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

参数

参数类型

描述

[数组元素]

Array of ReqWorkItemDto objects

参数解释：

工作项数据。
表6 ReqWorkItemDto

参数

参数类型

描述

id

String

参数解释：

工作项ID。

subject

String

参数解释：

工作项标题。

sequence

String

参数解释：

工作项编号， scrum类型项目该值为空。

tracker

ReqWorkItemBasicDto object

参数解释：

工作项类型。

status

ReqWorkItemBasicDto object

参数解释：

工作项状态。

priority

ReqWorkItemBasicDto object

参数解释：

工作项优先级。
表7 ReqWorkItemBasicDto

参数

参数类型

描述

id

String

参数解释：

属性ID。

name

String

参数解释：

属性名称。

状态码：401

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

状态码：403

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

GET https://{endpoint}/v4/repositories/1/work-items?project_id=ac90e21856c04707a041fbe2a9a020dc&is_ipd=false&offset=0&limit=10

响应示例

状态码：200

OK

[ {
  "id" : "1096177668293902337",
  "subject" : "2",
  "sequence" : "IR20250211809298",
  "tracker" : {
    "id" : "7",
    "name" : "Story"
  },
  "status" : {
    "id" : "1",
    "name" : "新建"
  },
  "priority" : {
    "id" : "2",
    "name" : "中"
  }
} ]

状态码：401

Unauthorized

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

状态码：403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "您没有操作权限，请升级权限后重试。"
}

状态码

状态码

描述

200

OK

401

Unauthorized

403

Bad Request

错误码

请参见错误码。

父主题： ThirdParty

相关文档