文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的工作项/ 查询项目的工作项
更新时间：2024-08-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询项目的工作项

功能介绍

工作项类型id, 分页参数，创建时间查询项目的工作项

调用方法

请参见如何调用API。

URI

GET /v4/projects/{project_id}/issues

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：项目的32位uuid，项目唯一标识，可以通过ListProjectsV4接口查询项目列表

约束限制：正则表达式， ^[A-Za-z0-9]{32}$

取值范围：字符串，最小长度：32，最大长度：32

默认取值：不涉及
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：偏移量 从0开始

约束限制：正则表达式，^0|[1-9]\d{0,10}$

取值范围：最小值：0

默认取值：0

limit

否

Integer

参数解释：每页数量

约束限制：不涉及

取值范围：最小值：1 最大值：100

默认取值：100

tracker_id

否

Integer

参数解释: 工作项类型,

约束限制：任务/Task,3缺陷/Bug,5Epic,6Feature,7Story;

取值范围：最小值 2 最大值 7

默认取值：不涉及

created_time_interval

否

String

参数解释: 创建工作项的时间(查询的起始时间,查询的结束时间)

约束限制：正则表达式，^([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?$

取值范围：不涉及

默认取值：不涉及

updated_time_interval

否

String

参数解释： 更新工作项的时间(查询的起始时间,查询的结束时间)

约束限制：正则表达式，^([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?$

取值范围：不涉及

默认取值：不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

约束限制：不涉及

取值范围：最小长度：10，最大长度：32768

默认取值：不涉及

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

issues

Array of IssueItemSfV4 objects

工作项信息

total

Integer

工作项总数
表5 IssueItemSfV4

参数

参数类型

描述

actual_work_hours

Double

实际工时

assigned_user

IssueUser object

处理人信息

author

IssueUser object

作者信息

begin_time

Long

工作项开始时间

closed_time

Long

关闭工作项的时间

created_time

Long

创建时间 年-月-日 时:分:秒

custom_feilds

Array of CustomFeildRecord objects

自定义字段信息

developer

IssueUser object

开发人员信息

discover_version

String

发现问题的版本

end_time

Long

工作项结束时间 年-月-日 时:分:秒

done_ratio

Integer

完成度 示例：0 '0%'(输入数字0代表完成度为0%的工作项), 10 '10%', 20 '20%' , 30 '30%', 40 '40%', 50 '50%', 60 '60%', 70 '70%' 80 '80%', 90 '90%', 100 '100%'

expected_work_hours

Double

预计工时

order

Integer

顺序

最小值：1

最大值：100

parent_issue_id

Integer

当前工作项的父工作项的id

release_version

String

发布的版本

root_issue_id

Integer

当前工作项对应根节点工作项id

story_point

story_point object

故事点id (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 分别对应故事点值0, 1/2, 1, 2, 3, 5, 8, 13, 21, 40, 80, 100)

domain

domain object

领域信息 14, '性能', 15, '功能', 16, '可靠性' 17, '网络安全' 18, '可维护性' 19, '其他DFX' 20, '可用性'

iteration

iteration object

迭代信息

module

module object

模块信息

priority

priority object

优先级，可选值：1 '低'，2 '中'，3 '高'

severity

severity object

重要程度, 13 '提示'，12 '一般'，11'重要'，10 '关键'

status

status object

工作项状态id, 新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6,

tracker

tracker object

工作项类型， 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story

subject

String

工作项标题

updated_time

Long

工作项更新时间 年-月-日 时:分:秒
表6 CustomFeildRecord

参数

参数类型

描述

key

String

自定义字段属性

name

String

自定义字段名称

value

String

自定义字段值
表7 IssueUser

参数

参数类型

描述

user_id

String

用户32位uuid，用户唯一标识

user_num_id

Integer

用户数字id， 可通过调用ShowCurUserInfo接口获取当前用户信息

id

Integer

用户id

name

String

用户名

nick_name

String

用户昵称
表8 story_point

参数

参数类型

描述

id

Integer

故事点id

name

String

故事点
表9 domain

参数

参数类型

描述

id

Integer

领域id, 14, '性能', 15, '功能', 16, '可靠性' 17, '网络安全' 18, '可维护性' 19, '其他DFX' 20, '可用性'

name

String

领域, '性能', '功能', '可靠性', '网络安全', '可维护性', '其他DFX'
表10 iteration

参数

参数类型

描述

id

Integer

迭代id

name

String

迭代名
表11 module

参数

参数类型

描述

id

Integer

模块id

name

String

模块
表12 priority

参数

参数类型

描述

id

Integer

优先级id， 1 低，2 中, 3高

name

String

优先级，低， 中，高
表13 severity

参数

参数类型

描述

id

Integer

重要程度id， 13 提示，12 一般， 11 重要， 10 关键

name

String

重要程度， 提示，一般， 重要， 关键
表14 status

参数

参数类型

描述

id

Integer

状态id， 1 新建， 2 进行中， 3 已解决， 4 测试中， 5 已关闭， 6已拒绝

name

String

状态名称， 新建，进行中，已解决，测试中，已关闭，已拒绝
表15 tracker

参数

参数类型

描述

id

Integer

工作项类型id 2 任务/Task, 3 缺陷/Bug, 5 Epic, 6 Feature, 7 Story

name

String

类型名称, 任务/Task, 缺陷/Bug, Epic, Feature, Story

状态码： 400

表16 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

状态码： 401

表17 响应Body参数

参数

参数类型

描述

error_msg

String

错误描述

error_code

String

错误码

请求示例

Get https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues

Get https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues

响应示例

状态码： 200

OK

{
  "issues" : [ {
    "actual_work_hours" : 10,
    "assigned_user" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "demo"
    },
    "author" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "demo"
    },
    "begin_time" : 1590940800000,
    "closed_time" : 1590940800000,
    "created_time" : 1590940800000,
    "custom_feilds" : [ {
      "key" : "customField15",
      "name" : "single",
      "value" : "15Demo"
    } ],
    "developer" : {
      "id" : 4091,
      "name" : "demo_user_name",
      "nick_name" : "demo"
    },
    "discover_version" : "ProjectMan 8.0.0",
    "end_time" : 1590940800000,
    "done_ratio" : 0,
    "expected_work_hours" : 9,
    "order" : 1,
    "parent_issue_id" : 123,
    "release_version" : "ProjectMan 8.0.0",
    "root_issue_id" : 0,
    "story_point" : {
      "id" : 1,
      "name" : "0"
    },
    "domain" : {
      "id" : 14,
      "name" : "性能"
    },
    "iteration" : {
      "id" : 456,
      "name" : "迭代1"
    },
    "module" : {
      "id" : 456,
      "name" : "Project"
    },
    "priority" : {
      "id" : 1,
      "name" : "低"
    },
    "severity" : {
      "id" : 12,
      "name" : "一般"
    },
    "status" : {
      "id" : 1,
      "name" : "新建"
    },
    "tracker" : {
      "id" : 7,
      "name" : "story"
    },
    "subject" : "demo",
    "updated_time" : 1576114296000
  } ],
  "total" : 1
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

相关文档