查询子工作项列表V2
功能介绍
查询子工作项列表V2。
调用方法
请参见如何调用API。
URI
POST /v2/issues/child-issue-list
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
parent_id |
否 |
Integer |
参数解释: 工作项id,可通过高级查询工作项接口获取,响应消息体中的id字段的值就是工作项id。 约束限制: 长度在1位到10位之间的纯数字。 取值范围: 最小长度:1,最大长度:10 默认取值: 不涉及 |
project_uuid |
否 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
subject |
否 |
String |
参数解释: 工作项标题,可通过高级查询工作项接口获取,响应消息体中的name字段的值就是工作项标题。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 |
query_type |
否 |
String |
参数解释: 事务不同的查询方式。 约束限制: 不涉及。 取值范围: basic(基本查询) custom(临时过滤) query(过滤器) 默认取值: 不涉及。 |
page_no |
否 |
String |
参数解释: 分页索引。 约束限制: 不涉及 取值范围: 最小值0,最大值9,999,999,999。 默认取值: 不涉及。 |
page_size |
否 |
String |
参数解释: 分页大小。 约束限制: 不涉及。 取值范围: 最小值0,最大值9,999,999,999。 默认取值: 不涉及。 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
result |
result object |
参数解释: 响应结果。 |
status |
String |
参数解释: 响应状态。 |
参数 |
参数类型 |
描述 |
---|---|---|
total_count |
Integer |
参数解释: 子工作项总数。 取值范围: 不涉及 |
issues |
Array of issues objects |
参数解释: 工作项列表信息。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
updated_on |
String |
参数解释: 工作项更新时间(时间戳格式:1839340800000)。 取值范围: 不涉及。 |
subject |
String |
参数解释: 工作项标题。 取值范围: 不涉及。 |
parent_issue |
ParentIssue object |
参数解释: 父工作项。 取值范围: 不涉及。 |
description |
String |
参数解释: 工作项描述。 取值范围: 不涉及。 |
project |
Project object |
参数解释: 项目信息。 取值范围: 不涉及。 |
done_ratio |
Integer |
参数解释: 工作项完成度 ,如20,表示完成度为20 %。 取值范围: 最小值 0 最大值 100。 |
find_release_dev |
String |
参数解释: 发现发布版本。 取值范围: 不涉及。 |
tracker |
Tracker object |
参数解释: 工作项类型。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 工作项id。 取值范围: 0至9999999999。 |
release_dev |
String |
参数解释: 工作项发布版本号。 取值范围: 不涉及。 |
customValueNew |
Object |
参数解释: 工作项自定义字段值。 取值范围: 不涉及。 |
order |
IssueOrderV4 object |
参数解释: 工作项在列表中的顺序位置。 |
assigned_to |
IssueAuthorVO object |
参数解释: 处理人。 |
status_attribute |
StateAttribute object |
参数解释: 状态属性(开始态,进行态,结束态)。 取值范围: 不涉及。 |
severity |
Severity object |
参数解释: 工作项重要程度。 取值范围: 不涉及。 |
is_parent |
Boolean |
参数解释: 当前工作项是否是父工作项。 取值范围: 不涉及。 |
author |
IssueAuthorVO object |
参数解释: 提交人。 取值范围: 不涉及。 |
module |
Object |
参数解释: 工作项模块。 取值范围: 不涉及。 |
expected_work_hours |
Integer |
参数解释: 预计完成工时(人/时)。 取值范围: 最小值:0。 |
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 |
参数解释: 工作项的关闭者。 取值范围: 不涉及。 |
parent_issue_id |
Integer |
参数解释: 父工作项id。 取值范围: 不涉及。 |
position |
String |
参数解释: 工作项在界面的排序数值。 取值范围: 不涉及。 |
closed_flag |
Integer |
参数解释: 工作项是否为已关闭状态。 取值范围: 0:未关闭 1:已关闭。 |
assigned_cc_user |
Array of strings |
参数解释: 工作项的抄送人。 取值范围: 不涉及。 |
status |
Status object |
参数解释: 工作项的状态。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
subject |
String |
参数解释: 父工作项名称。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 父工作项数字id。 取值范围: 最小值:0。 |
参数 |
参数类型 |
描述 |
---|---|---|
identifier |
String |
参数解释: 项目uuid。 取值范围: 不涉及。 |
name |
String |
参数解释: 项目名称。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 项目数字id。 取值范围: 不涉及。 |
type |
String |
参数解释: 项目类型。 取值范围: scrum。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 类型名称。 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) |
id |
Integer |
参数解释: 类型id。 取值范围: 2,3,5,6,7 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
参数解释: 工作项在列表的顺序id。 取值范围: 不涉及。 |
name |
String |
参数解释: 工作项在列表的顺序。 取值范围: 不涉及。 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
参数解释: 工作项状态的属性id。 取值范围: 不涉及。 |
name |
String |
参数解释: 工作项状态的名称。 取值范围: 开始态 进行态 结束态。 |
参数 |
参数类型 |
描述 |
---|---|---|
name |
String |
参数解释: 工作项的重要程度。 取值范围: 10 (关键) 11 (重要) 12 (一般) 13 (提示) |
id |
Integer |
参数解释: 重要程度id。 取值范围: 10,11,12,13。 |
参数 |
参数类型 |
描述 |
---|---|---|
first_name |
String |
参数解释: 用户名称。 取值范围: 不涉及。 |
last_name |
String |
参数解释: 用户姓名。 取值范围: 不涉及。 |
identifier |
String |
参数解释: 作者唯一标识。 取值范围: 不涉及。 |
image_id |
String |
参数解释: 用户头像id。 取值范围: 不涉及。 |
assigned_nick_name |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
name |
String |
参数解释: 带租户信息的用户名(租户名称_用户名)。 取值范围: 不涉及。 |
id |
Integer |
参数解释: 用户id。 取值范围: 不涉及。 |
请求示例
POST http://{endpoint}/v2/issues/child-issue-list { "parent_id" : 69783229, "project_uuid" : "d00fd603ddf64115939e7d3609d6cb05", "subject" : "", "query_type" : "basic", "page_no" : "1", "page_size" : "10" }
响应示例
状态码:200
OK。
{ "result" : { "total_count" : 1, "issues" : [ { "updated_on" : "1753346232000", "subject" : "task-标签过滤01", "parent_issue" : { "subject" : "story-标签过滤01", "id" : 9184452 }, "description" : "<p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 作为 </span><用户角色></p><p><br /></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 我想要 </span><结果></p><p><br /></p><p style=\"padding-top: 5.0px;\"><span style=\"font-weight: bold;\"> 以便于 </span><目的> </p>", "project" : { "identifier" : "873ca7d1592f4921b4644dc16a1176f5", "name" : "Scrum-tree按标签过滤", "id" : 35165288, "type" : "scrum" }, "done_ratio" : 0, "tracker" : { "name" : "Task", "id" : 2 }, "id" : 9184453, "customValueNew" : { }, "order" : { "name" : 1, "id" : 1 }, "assigned_to" : { "first_name" : "devcloud_devcloud_s00404480_01", "last_name" : "devcloud_devcloud_s00404480_01", "identifier" : "a360371833bf4c558f796fd707b44daf", "image_id" : "photo01.png", "assigned_nick_name" : "张三丰1", "name" : "devcloud_devcloud_s00404480_01", "id" : 4091 }, "status_attribute" : { "name" : "开始态", "id" : 35160238 }, "severity" : { "name" : "一般", "id" : 12 }, "author" : { "first_name" : "devcloud_devcloud_s00404480_01", "last_name" : "devcloud_devcloud_s00404480_01", "identifier" : "a360371833bf4c558f796fd707b44daf", "image_id" : "photo01.png", "assigned_nick_name" : "张三丰1", "name" : "devcloud_devcloud_s00404480_01", "id" : 4091 }, "module" : { }, "expected_work_hours" : 0, "priority" : { "name" : "中", "id" : 2 }, "actual_work_hours" : 0, "is_watcher" : false, "deleted" : false, "fixed_version" : { }, "is_archived" : false, "created_on" : "1753346232000", "domain" : { }, "developer" : { }, "closeder" : { }, "parent_issue_id" : 9184452, "position" : "9184453.0000000000", "closed_flag" : 0, "assigned_cc_user" : [ ], "status" : { "name" : "新建", "id" : 1 } } ] }, "status" : "success" }
状态码
状态码 |
描述 |
---|---|
200 |
OK。 |
错误码
请参见错误码。