文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 在树形模式查询中,有过滤条件下的查询工作项列表接口
更新时间:2025-08-18 GMT+08:00
分享

在树形模式查询中,有过滤条件下的查询工作项列表接口

功能介绍

在树形模式查询中,有过滤条件下的查询工作项列表接口。

调用方法

请参见如何调用API

URI

POST /v5/scrum/issue-tree

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

最小长度:10,最大长度:32768。

默认取值:

不涉及。

表2 请求Body参数

参数

是否必选

参数类型

描述

pageNo

String

参数解释:

分页索引。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

pageSize

String

参数解释:

分页大小。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

projectUUId

String

参数解释

项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。

约束限制

由数字和英文组成的32字符串。

取值范围

不涉及。

默认取值

不涉及。

tracker_id

String

参数解释

工作项类型。

约束限制

不涉及。

取值范围

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

默认取值

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释:

返回状态

取值范围:

success:返回成功

error :返回失败

result

IssueTreeResult object

参数解释:

返回结果。

表4 IssueTreeResult

参数

参数类型

描述

total_count

Integer

参数解释

工作项总条数。

取值范围

不涉及。

issues

Array of IssueNew objects

参数解释

工作项列表。

取值范围

不涉及。

表5 IssueNew

参数

参数类型

描述

updated_on

String

参数解释:

工作项的更新日期。时间戳格式(示例:1839340800000) 。

取值范围:

不涉及。

story_point

StoryPoint object

参数解释:

工作项的故事点。

取值范围:

不涉及。

subject

String

参数解释:

工作项的负责者。

取值范围:

不涉及。

project

Project object

参数解释:

项目。

取值范围:

不涉及。

isParent

Boolean

参数解释:

是否有子工作项。

取值范围:

true(有子工作项)

false(没有子工作项)

done_ratio

Integer

参数解释:

工作项完成度。

取值范围:

不涉及。

findReleaseDev

String

参数解释:

发布人 。

取值范围:

不涉及。

tracker

Tracker object

参数解释:

工作项的类型。

取值范围:

不涉及。

id

Integer

参数解释:

工作项列表id。

取值范围:

不涉及。

start_date

String

参数解释:

工作项的开始日期。时间戳格式(示例:1839340800000)。

取值范围:

不涉及。

assigned_to

assigned_to object

参数解释:

工作项责任人。

取值范围:

不涉及。

status_attribute

Object

参数解释:

工作项的状态属性。

取值范围:

不涉及。

severity

Severity object

参数解释:

重要程度。

取值范围:

不涉及。

releaseDev

String

参数解释:

工作项发布版本号。

取值范围:

不涉及。

author

author object

参数解释:

工作项负责人。

取值范围:

不涉及。

module

Object

参数解释:

工作项的模块。

取值范围:

不涉及。

due_date

String

参数解释:

工作项的截止日期,时间戳格式(示例:1839340800000)。

取值范围:

不涉及。

expected_work_hours

Integer

参数解释:

工作项的预计工时(单位:人时)。

取值范围:

不涉及。

priority

Priority object

参数解释:

优先级。

取值范围:

不涉及。

actual_work_hours

Integer

参数解释:

工作项的实际工时(单位:人/时)。

取值范围:

不涉及。

is_watcher

Boolean

参数解释:

是否关注 。

取值范围:

true(是)

false(不是)

deleted

Boolean

参数解释:

是否删除 。

取值范围:

true(是)

false(不是)

fixed_version

Object

参数解释:

问题解决版本。

取值范围:

不涉及。

is_archived

Boolean

参数解释:

是否归档。

取值范围:

true(是)

false(不是)

created_on

String

参数解释:

工作项的创建时间,时间戳格式(示例:1839340800000)。

取值范围:

不涉及。

domain

Object

参数解释:

工作项的领域 。

取值范围:

不涉及。

developer

Object

参数解释:

工作项的开发人员。

取值范围:

不涉及。

closeder

Object

参数解释:

关闭人员。

取值范围:

不涉及。

position

String

参数解释:

工作项在列表的展示位置 。

取值范围:

不涉及。

closed_flag

Integer

参数解释:

关闭标志 。

取值范围:

0(打开)

1(关闭)

assigned_cc_user

String

参数解释:

工作项的抄送人。

取值范围:

不涉及。

custom_value_new

Object

参数解释:

自定义字段。

取值范围:

不涉及。

status

Status object

参数解释:

工作项的状态。

取值范围:

不涉及。

表6 StoryPoint

参数

参数类型

描述

id

Integer

参数解释:

故事点id。

取值范围:

不涉及。

name

String

参数解释:

故事点名称。

取值范围:

不涉及。

表7 Project

参数

参数类型

描述

identifier

String

参数解释:

项目uuid。

取值范围:

不涉及。

name

String

参数解释:

项目名称。

取值范围:

不涉及。

id

Integer

参数解释:

项目数字id。

取值范围:

不涉及。

type

String

参数解释:

项目类型。

取值范围:

scrum。

表8 Tracker

参数

参数类型

描述

name

String

参数解释:

类型名称。

取值范围:

2(任务/Task)

3(缺陷/Bug)

5(Epic)

6(Feature)

7(Story)

id

Integer

参数解释:

类型id。

取值范围:

2,3,5,6,7

表9 assigned_to

参数

参数类型

描述

firstName

String

参数解释:

用户名。

取值范围:

不涉及。

lastName

String

参数解释:

用户姓名。

取值范围:

不涉及。

identifier

String

参数解释:

用户32位uuid。

取值范围:

不涉及。

image_id

String

参数解释:

用户头像id。

取值范围:

不涉及。

assignedNickName

String

参数解释:

用户昵称。

取值范围:

不涉及。

name

String

参数解释:

用户名。

取值范围:

不涉及。

id

Integer

参数解释:

用户数字id。

取值范围:

不涉及。

表10 Severity

参数

参数类型

描述

name

String

参数解释:

工作项的重要程度。

取值范围:

10 (关键)

11 (重要)

12 (一般)

13 (提示)

id

Integer

参数解释:

重要程度id。

取值范围:

10,11,12,13。

表11 author

参数

参数类型

描述

firstName

String

参数解释:

用户名称。

取值范围:

不涉及。

lastName

String

参数解释:

用户姓名。

取值范围:

不涉及。

identifier

String

参数解释:

作者唯一标识。

取值范围:

不涉及。

image_id

String

参数解释:

用户头像id。

取值范围:

不涉及。

authorNickName

String

参数解释:

用户昵称。

取值范围:

不涉及。

name

String

参数解释:

带租户信息的用户名(租户名称_用户名)。

取值范围:

不涉及。

id

Integer

参数解释:

用户id。

取值范围:

不涉及。

表12 Priority

参数

参数类型

描述

name

String

参数解释:

工作项的优先级。

取值范围:

1(低)

2(中)

3(高)

id

Integer

参数解释:

优先级id 。

取值范围:

1,2,3。

表13 Status

参数

参数类型

描述

name

String

参数解释:

状态名称

取值范围:

1(新建)

2(进行中)

3(已解决)

4(测试中)

5( 已关闭)

6(已拒绝)

id

Integer

参数解释:

状态id。

取值范围:

1,2,3,4,5,6

请求示例

POST http://{endpoint}/v5/scrum/issue-tree

{
  "pageNo" : "1",
  "pageSize" : "15",
  "projectUUId" : "fe06772d851542ad812da15891bb6b22",
  "tracker_id" : "5,6,7,2,3"
}

响应示例

状态码:200

OK。

{
  "result" : {
    "total_count" : 25,
    "issues" : [ {
      "updated_on" : "1752825637000",
      "subject" : "作为管理员应该可以进行配件统计",
      "project" : {
        "identifier" : "381fcca9c056482d92da3e8b9da71db5",
        "name" : "DevOps全流程示例项目xxxx",
        "id" : 13222601
      },
      "done_ratio" : 0,
      "findReleaseDev" : "",
      "tracker" : {
        "name" : "Story",
        "id" : 7
      },
      "id" : 69782398,
      "releaseDev" : "",
      "assigned_to" : {
        "firstName" : "hw_008618814464665_01",
        "lastName" : "hw19145027",
        "assignedNickName" : "asdf4",
        "name" : "hw19145027",
        "id" : 233087
      },
      "status_attribute" : { },
      "severity" : {
        "name" : "一般",
        "id" : 12
      },
      "isParent" : true,
      "author" : {
        "firstName" : "hw_008618814464665_01",
        "lastName" : "hw19145027",
        "name" : "hw19145027",
        "id" : 233087,
        "authorNickName" : "asdf4"
      },
      "module" : { },
      "due_date" : "1751731200000",
      "expected_work_hours" : 50,
      "priority" : {
        "name" : "中",
        "id" : 2
      },
      "actual_work_hours" : 0,
      "is_watcher" : false,
      "deleted" : false,
      "fixed_version" : {
        "name" : "迭代3",
        "id" : 21723087
      },
      "is_archived" : false,
      "created_on" : "1751270437000",
      "domain" : { },
      "developer" : { },
      "closeder" : { },
      "position" : "69782398.0000000000",
      "closed_flag" : 1,
      "assigned_cc_user" : [ ],
      "status" : {
        "name" : "已关闭",
        "id" : 5
      }
    } ]
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK。

错误码

请参见错误码

相关文档