高级查询工作项
功能介绍
根据筛选条件查询工作项
URI
POST /v4/projects/{project_id}/issues
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
devcloud项目的32位id |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
subject |
否 |
String |
工作项标题 |
issue_ids |
否 |
Array of integers |
工作项数字id |
assigned_ids |
否 |
Array of strings |
处理人id(用户数字id和用户uuid均支持) |
creator_ids |
否 |
Array of strings |
创建者id(用户数字id和用户uuid均支持) |
developer_ids |
否 |
Array of strings |
开发人id(用户数字id和用户uuid均支持) |
domain_ids |
否 |
Array of integers |
id, 领域, 14 '性能', 15 '功能', 16 '可靠性', 17 '网络安全', 18 '可维护性', 19 '其他DFX', 20 '可用性', |
done_ratios |
否 |
Array of integers |
完成度 |
iteration_ids |
否 |
Array of integers |
迭代id |
limit |
否 |
Integer |
每页显示数量 |
offset |
否 |
Integer |
分页索引,偏移量,offset是limit的整数倍数,limit=10,offset=0,10,20... |
module_ids |
否 |
Array of integers |
模块id |
priority_ids |
否 |
Array of integers |
优先级(低-1, 中-2, 高-3) |
query_type |
否 |
String |
查询类型 backlog feature epic |
severity_ids |
否 |
Array of integers |
重要程度 |
status_ids |
否 |
Array of integers |
状态 id, 新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6, |
story_point_ids |
否 |
Array of integers |
故事点id(可选值:0,1/2,1,2,3,5,8,13,21,40,80,100),分别对应id(1,2,3,4,5,6,7,8,9,10,11,12) 故事点概念:故事点是一种基于敏捷的估算工作量的方法,故事综合了交付Story所要付出的努力、开发复杂度、风险,可以简单理解为开发所需要的成本。 |
tracker_ids |
否 |
Array of integers |
工作项类型,2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story |
include_deleted |
否 |
Boolean |
true 查询的工作项包含已经逻辑删除的,false 查询的工作项不包含已经删除的 |
created_time_interval |
否 |
String |
根据工作项的创建时间查询工作项,(查询的起始时间,查询的结束时间) |
updated_time_interval |
否 |
String |
根据工作项的更新时间查询工作项,(查询的起始时间,查询的结束时间) |
closed_time_interval |
否 |
String |
根据工作项的结束时间查询工作项,(查询的起始时间,查询的结束时间) |
custom_fields |
否 |
Array of custom_fields objects |
自定义字段 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
issues |
Array of ListIssueItemResponse objects |
工作项列表 |
total |
Integer |
总数 |
参数 |
参数类型 |
描述 |
---|---|---|
actual_work_hours |
Double |
实际工时(实际工时由详细工时自动累加和子工作项自动卷积计算) |
assigned_cc_user |
Array of IssueUser objects |
抄送人 |
assigned_user |
IssueUser object |
处理人 |
begin_time |
String |
预计开始时间,年-月-日 |
created_time |
String |
创建时间 年-月-日 时:分:秒 |
creator |
IssueUser object |
创建人 |
custom_fields |
Array of CustomField objects |
自定义属性值,不建议使用,建议参考new_custom_fields字段 |
new_custom_fields |
Array of NewCustomField objects |
自定义属性值 |
developer |
IssueUser object |
开发人员 |
domain |
domain object |
id, 领域 14, '性能', 15, '功能', 16, '可靠性' 17, '网络安全' 18, '可维护性' 19, '其他DFX' 20, '可用性' |
done_ratio |
Integer |
工作项进度值 |
end_time |
String |
预计结束时间,年-月-日 |
expected_work_hours |
Double |
预计工时 |
id |
Integer |
工作项项id |
project |
IssueProjectResponseV4 object |
项目信息 |
iteration |
iteration object |
迭代 |
module |
module object |
模块 |
name |
String |
标题 |
parent_issue |
parent_issue object |
父工作项 |
priority |
priority object |
工作项优先级 |
order |
order object |
工作项优先级顺序 |
severity |
severity object |
工作项重要程度 |
status |
status object |
工作项状态 |
release_dev |
String |
工作项发布版本号 |
find_release_dev |
String |
缺陷发现版本号(仅Bug类型工作项具备该字段) |
env |
env object |
缺陷发现环境(仅Bug类型工作项具备该字段) |
tracker |
tracker object |
工作项类型 2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story |
updated_time |
String |
更新时间 年-月-日 时:分:秒 |
closed_time |
String |
关闭时间 年-月-日 时:分:秒 |
deleted |
Boolean |
是否已经删除,true 已经删除, false 未删除 |
参数 |
参数类型 |
描述 |
---|---|---|
user_id |
String |
用户uuid |
user_num_id |
Integer |
用户数字id |
id |
Integer |
用户id |
name |
String |
带租户名的用户名(租户名_用户名) |
nick_name |
String |
昵称 |
first_name |
String |
用户名 |
参数 |
参数类型 |
描述 |
---|---|---|
custom_field |
String |
自定义字段 |
field_name |
String |
自定义字段名称 |
value |
String |
自定义属性对应的值,多个值以英文逗号区分开 |
参数 |
参数类型 |
描述 |
---|---|---|
project_id |
String |
项目id |
project_name |
String |
项目名称 |
project_num_id |
Integer |
项目数字id |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
状态码:401
参数 |
参数类型 |
描述 |
---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
请求示例
POST https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/issues
{
"status_ids" : [ 1 ]
}
响应示例
状态码:200
OK
{
"issues" : [ {
"actual_work_hours" : 0,
"assigned_cc_user" : [ {
"id" : 4091,
"name" : "demo_user_name",
"nick_name" : "张三"
} ],
"assigned_user" : {
"id" : 4091,
"name" : "demo_user_name",
"nick_name" : "张三"
},
"begin_time" : "2020-09-12",
"created_time" : "2020-09-13 14:40:11",
"creator" : {
"id" : 4091,
"name" : "demo_user_name",
"nick_name" : "张三"
},
"custom_fields" : [ {
"name" : "customField16",
"value" : "多选框",
"new_name" : "custom_field16"
} ],
"new_custom_fields" : [ {
"custom_field" : "custom_field16",
"field_name" : "field_name",
"value" : "多选框1,多选框2"
} ],
"developer" : {
"id" : 4091,
"name" : "demo_user_name",
"nick_name" : "张三"
},
"domain" : {
"id" : 14,
"name" : "性能"
},
"done_ratio" : 0,
"end_time" : "2020-09-19",
"expected_work_hours" : 9,
"id" : 4567,
"project" : {
"project_id" : "526cefde62004de2b62b5e8dd2c2b3af",
"project_name" : "testDemo",
"project_num_id" : 78953
},
"iteration" : {
"id" : 456,
"name" : "迭代1"
},
"module" : {
"id" : 456,
"name" : "Project"
},
"name" : "国际化整改",
"parent_issue" : {
"id" : 123,
"name" : "提供查询项目成员的功能"
},
"priority" : {
"id" : 1,
"name" : "低"
},
"order" : {
"id" : 1,
"name" : "1"
},
"severity" : {
"id" : 12,
"name" : "一般"
},
"status" : {
"id" : 1,
"name" : "新建"
},
"release_dev" : "0727",
"find_release_dev" : "0728",
"env" : {
"id" : 36,
"name" : "测试环境"
},
"tracker" : {
"id" : 7,
"name" : "story"
},
"updated_time" : "2020-09-14 14:40:11",
"closed_time" : "2020-09-15 14:40:11",
"deleted" : false
} ],
"total" : 1
}
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。