高级查询工作项
功能介绍
根据筛选条件查询工作项
调用方法
请参见如何调用API。
URI
POST /v4/projects/{project_id}/issues
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释:项目的32位uuid,项目唯一标识,可以通过ListProjectsV4接口查询项目列表 约束限制:正则表达式, ^[A-Za-z0-9]{32}$ 取值范围:字符串,最小长度:32,最大长度:32 默认取值:不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释:用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制:不涉及 取值范围:最小长度:10,最大长度:32768 默认取值:不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
assigned_ids |
否 |
Array of integers |
参数解释:处理人id,可通过ListProjectMembersV4接口获取指定项目的成员用户列表 约束限制:正则表达式,^\d+$ 取值范围:最小值 0 默认取值:不涉及 |
creator_ids |
否 |
Array of integers |
参数解释:创建者id,可通过ListProjectMembersV4接口获取指定项目的成员用户列表 约束限制:正则表达式,^\d+$ 取值范围:最小值 0 默认取值:不涉及 |
developer_ids |
否 |
Array of integers |
参数解释:开发人id, 可通过ListProjectMembersV4接口获取指定项目的成员用户列表 约束限制:正则表达式,^\d+$ 取值范围:最小值 0 默认取值:不涉及 |
domain_ids |
否 |
Array of integers |
参数解释:领域id, 14 '性能', 15 '功能', 16 '可靠性' 17 '网络安全' 18 '可维护性' 19 '其他DFX' 20 '可用性' 约束限制:正则表达式,^\d+$ 取值范围:最小值 14 最大值 20 默认取值:不涉及 |
done_ratios |
否 |
Array of integers |
参数解释:工作项完成度 约束限制:0 '0%'(输入数字0代表完成度为0%的工作项), 10 '10%', 20 '20%' , 30 '30%', 40 '40%', 50 '50%', 60 '60%', 70 '70%' 80 '80%', 90 '90%', 100 '100%' 取值范围:最小值 0 最大值 100 默认取值:不涉及 |
iteration_ids |
否 |
Array of integers |
参数解释:迭代id,可通过ListProjectIterationsV4接口获取指定项目的迭代列表 约束限制:正则表达式,^\d+$ 取值范围:最小长度 0 默认取值:不涉及 |
limit |
否 |
Integer |
参数解释:每页数量 约束限制:不涉及 取值范围:最小值:1 最大值:100 默认取值:100 |
offset |
否 |
Integer |
参数解释:偏移量 offset是limit的整数倍数,limit=10,offset=0,10,20... 约束限制:正则表达式,^0|[1-9]\d{0,10}$ 取值范围:最小值:0 默认取值:0 |
module_ids |
否 |
Array of integers |
参数解释:模块id, 设置-工作项设置-模块设置内用户可新建模块 约束限制:正则表达式,^\d+$ 取值范围:最小长度 0 默认取值:不涉及 |
priority_ids |
否 |
Array of integers |
参数解释: 优先级, 约束限制:正则表达式,^\d+$ 取值范围:1 低, 2 中, 3 高, 默认取值:不涉及 |
query_type |
否 |
String |
参数解释: 查询类型, 约束限制:正则表达式,^(epic|feature|backlog|\s*)$ 取值范围:backlog(Story|Task|Bug), feature, epic 默认取值:backlog |
severity_ids |
否 |
Array of integers |
参数解释: 重要程度, 约束限制:正则表达式,^\d+$ 取值范围:10 关键, 11 重要, 12 一般, 13 提示, 默认取值:不涉及 |
status_ids |
否 |
Array of integers |
参数解释: 状态id, 约束限制:正则表达式,^\d+$ 取值范围:新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6 默认取值:不涉及 |
story_point_ids |
否 |
Array of integers |
参数解释: 故事点id, 故事点是一种基于敏捷的估算工作量方法,故事点综合了交付Story所付出的所有努力、开发复杂度、风险,可以简单理解为开发所需要的成本。 约束限制:正则表达式,^\d+$ 取值范围:(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) 默认取值:不涉及 |
tracker_ids |
否 |
Array of integers |
参数解释: 工作项类型, 约束限制:任务/Task,3缺陷/Bug,5Epic,6Feature,7Story; 取值范围:最小值 2 最大值 7 默认取值:不涉及 |
include_deleted |
否 |
Boolean |
参数解释: 查询条件是否包含已删除工作项 约束限制:正则表达式,^(true|false)$ 取值范围:true 查询的工作项包含已经逻辑删除的,false 查询的工作项不包含已经删除的 默认取值:不涉及 |
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})?$ 取值范围:不涉及 默认取值:不涉及 |
closed_time_interval |
否 |
String |
参数解释: 根据工作项的结束时间查询工作项,(查询的起始时间,查询的结束时间) 约束限制:正则表达式,^([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})?$ 取值范围:不涉及 默认取值:不涉及 |
custom_fields |
否 |
Array of custom_fields objects |
参数解释: 用户自定义字段,可以通过ListIssueCustomFields查询Scrum工作项自定义字段 约束限制:不涉及 取值范围:不涉及 默认取值:不涉及 |
响应参数
状态码: 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 |
工作项编号 |
project |
IssueProjectResponseV4 object |
项目信息 |
iteration |
iteration object |
迭代 |
module |
module object |
模块 |
name |
String |
工作项标题 |
parent_issue |
parent_issue object |
当前工作项的父工作项信息 |
priority |
priority object |
优先级,可选值:1 '低',2 '中',3 '高' |
order |
order object |
工作项优先级顺序 |
severity |
severity object |
重要程度, 13 '提示',12 '一般',11'重要',10 '关键' |
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 |
用户32位uuid,用户唯一标识,需要通过IAM获取 |
user_num_id |
Integer |
用户数字id |
id |
Integer |
用户id |
name |
String |
用户名 |
nick_name |
String |
用户昵称 |
参数 |
参数类型 |
描述 |
---|---|---|
custom_field |
String |
自定义字段 |
field_name |
String |
自定义字段名称 |
value |
String |
自定义字段对应的值,多个值以英文逗号区分开 |
参数 |
参数类型 |
描述 |
---|---|---|
project_id |
String |
项目32为uuid,唯一标识,可通过IAM获取 |
project_name |
String |
项目名称 |
project_num_id |
Integer |
项目数字id |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
工作项重要程度id,13 '提示',12 '一般',11'重要',10 '关键' |
name |
String |
工作项重要程度名称, '提示','一般','重要','关键' |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
工作项状态id,新建 1, 进行中 2, 已解决 3, 测试中 4, 已关闭 5, 已拒绝 6 |
name |
String |
工作项状态名称,新建, 进行中, 已解决, 测试中, 已关闭, 已拒绝 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Integer |
工作项类型id,2任务/Task,3缺陷/Bug,5Epic,6Feature,7Story |
name |
String |
工作项类型名称, 任务/Task, 缺陷/Bug, Epic, Feature, Story |
状态码: 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 }
SDK代码示例
SDK代码示例如下。
Java
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.projectman.v4.region.ProjectManRegion; import com.huaweicloud.sdk.projectman.v4.*; import com.huaweicloud.sdk.projectman.v4.model.*; import java.util.List; import java.util.ArrayList; public class ListIssuesV4Solution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); ProjectManClient client = ProjectManClient.newBuilder() .withCredential(auth) .withRegion(ProjectManRegion.valueOf("<YOUR REGION>")) .build(); ListIssuesV4Request request = new ListIssuesV4Request(); ListIssueRequestV4 body = new ListIssueRequestV4(); List<Integer> listbodyStatusIds = new ArrayList<>(); listbodyStatusIds.add(1); body.withStatusIds(listbodyStatusIds); request.withBody(body); try { ListIssuesV4Response response = client.listIssuesV4(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Python
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 |
# coding: utf-8 from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdkprojectman.v4.region.projectman_region import ProjectManRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdkprojectman.v4 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = __import__('os').getenv("CLOUD_SDK_AK") sk = __import__('os').getenv("CLOUD_SDK_SK") credentials = BasicCredentials(ak, sk) \ client = ProjectManClient.new_builder() \ .with_credentials(credentials) \ .with_region(ProjectManRegion.value_of("<YOUR REGION>")) \ .build() try: request = ListIssuesV4Request() listStatusIdsbody = [ 1 ] request.body = ListIssueRequestV4( status_ids=listStatusIdsbody ) response = client.list_issues_v4(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Go
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" projectman "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/projectman/v4/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() client := projectman.NewProjectManClient( projectman.ProjectManClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.ListIssuesV4Request{} var listStatusIdsbody = []int32{ int32(1), } request.Body = &model.ListIssueRequestV4{ StatusIds: &listStatusIdsbody, } response, err := client.ListIssuesV4(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。