查询工作项列表
功能介绍
查询工作项列表
调用方法
请参见如何调用API。
URI
POST /v1/ipdprojectservice/projects/{project_id}/issues/query
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID 约束限制: 正则表达式,[A-Za-z0-9]{32} 取值范围: 不涉及 默认取值: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
issue_type |
是 |
String |
参数解释: 工作项类型,区分大小写,传入错误的工作项类型时不返回数据,系统设备类和独立软件类型的项目当issue_type传入没有父子关系的工作项时,仅返回第一个工作项类型数据 约束限制: 支持多种工作项类型,使用英文逗号分隔 取值范围: RR/SF/IR/SR/AR/Task/Bug(系统设备类项目可选值) RR/SF/IR/US/Task/Bug(独立软件类项目可选值) RR/Epic/FE/US/Task/Bug(云服务类项目可选值) 默认取值: 不涉及 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
filter |
否 |
Array of Map<String,ConditionVO> objects |
参数解释: 查询过滤器 约束限制: 最大长度200 |
filter_mode |
否 |
String |
参数解释: 过滤模式 约束限制: 最大长度512 取值范围: 不涉及 默认取值: 不涉及 |
page |
否 |
PageInfoVO object |
参数解释: 分页信息 约束限制: 不涉及 |
sort |
否 |
Array of SortInfo objects |
参数解释: 排序条件 约束限制: 不涉及 |
return_fields |
否 |
Array of strings |
参数解释: 返回字段 约束限制: 不涉及 |
model_ids |
否 |
Array of strings |
参数解释: 模型Id 约束限制: 不涉及 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
values |
否 |
Array of strings |
参数解释: 条件数组 约束限制: 最大长度200 |
operator |
否 |
String |
参数解释: 操作符 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
参数解释: 状态 取值范围: 不涉及 |
message |
String |
参数解释: 信息 取值范围: 不涉及 |
result |
Map<String,Object> |
参数解释: 结果数据 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
Post https://{endpoint}/v1/ipdprojectservice/projects/{project_id}/issues/query?issue_type=IR,US
{
"filter" : [ {
"descendants.plan_pi" : {
"values" : [ "956200745322848257" ],
"operator" : "||"
},
"descendants.plan_iteration" : {
"values" : [ "956200745322848257-child" ],
"operator" : "||"
}
}, {
"descendants.priority" : {
"values" : [ "中" ],
"operator" : "||"
}
}, {
"descendants.assignee" : {
"values" : [ "a360371833bf4c558f796fd707b44daf" ],
"operator" : "||"
}
}, {
"descendants.status" : {
"values" : [ "Start" ],
"operator" : "||"
}
}, {
"parent_id" : {
"values" : [ "" ],
"operator" : "||"
}
} ],
"page" : {
"page_no" : 1,
"page_size" : 20
}
}
响应示例
状态码:200
OK
{
"status" : "success",
"message" : null,
"result" : {
"total" : 1,
"issues" : [ {
"promised" : null,
"type" : "raw requirement",
"src_domain" : {
"id" : "965714701520515072",
"name" : "IPD-系统设备类-0217",
"title" : "IPD-系统设备类-0217",
"project_id" : "e4b0424709934bd1a54753e70336564d",
"parent_id" : null,
"category" : "Project",
"created_by" : "a360371833bf4c558f796fd707b44daf",
"model_id" : "10001"
},
"domain_id" : {
"id" : "965714701520515072",
"name" : "IPD-系统设备类-0217",
"title" : "IPD-系统设备类-0217",
"project_id" : "e4b0424709934bd1a54753e70336564d",
"parent_id" : null,
"category" : "Project",
"created_by" : "a360371833bf4c558f796fd707b44daf",
"model_id" : "10001"
},
"send_from" : "",
"number" : "RR20240402742063",
"send_to" : "",
"convolution_actual_hours" : null,
"workload_man_day" : null,
"id" : "981935538274476033",
"state" : "正在工作",
"stay_days" : 1,
"assigned_cc" : null,
"submit_time" : "1712041275000",
"workitem2label" : null,
"close_time" : null,
"priority" : {
"id" : "965714705672876036",
"display_value" : "中",
"value" : "中",
"code" : "中",
"value_py" : "2",
"sequence" : 2,
"level" : 1,
"domain_id" : "965714701520515072",
"belong_definition_type" : "5"
},
"modified_date" : "1712041276000",
"created_by" : {
"watcher" : null,
"user_id" : "a360371833bf4c558f796fd707b44daf",
"user_num_id" : 4091,
"user_name" : "devcloud_devcloud_s00404480_01",
"domain_id" : "4e919d73499648e3b0292cd3cbef806a",
"domain_name" : "devcloud_devcloud_s00404480_01",
"nick_name" : "测试账号",
"role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6",
"role_name" : "项目管理员,项目经理",
"role_code" : "project_admin,Project manager",
"image_id" : null,
"region" : null,
"has_removed" : null
},
"break_status" : {
"id" : "965714705672876041",
"display_value" : "未分解",
"value" : "undecomposed",
"code" : "undecomposed",
"value_py" : "undecomposed",
"sequence" : 2,
"level" : 1,
"domain_id" : "965714701520515072",
"belong_definition_type" : "5"
},
"status_modified_date" : "1712041276000",
"canceled" : null,
"expect_delivery_time" : null,
"parent_id" : null,
"assignee" : {
"watcher" : null,
"user_id" : "a360371833bf4c558f796fd707b44daf",
"user_num_id" : 4091,
"user_name" : "devcloud_devcloud_s00404480_01",
"domain_id" : "4e919d73499648e3b0292cd3cbef806a",
"domain_name" : "devcloud_devcloud_s00404480_01",
"nick_name" : "测试账号",
"role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6",
"role_name" : "项目管理员,项目经理",
"role_code" : "project_admin,Project manager",
"image_id" : null,
"region" : null,
"has_removed" : null
},
"region" : "region01",
"status" : {
"id" : "965714705815482388",
"belonging" : "START",
"space_id" : "965714701520515072",
"name" : "分析",
"status_category" : null,
"code" : "Analyse",
"definition_type" : "5",
"belong_definition_type" : 3,
"belong_scope" : null,
"display_value" : "分析",
"position" : 2,
"displayable" : 1,
"editable" : 1,
"deletable" : 1,
"mutable" : 1,
"title_py" : "fx",
"builtin" : null,
"label" : null,
"description" : null,
"created_by" : "a360371833bf4c558f796fd707b44daf",
"created_userinfo" : null,
"created_on" : null,
"created_date" : 1708202727000,
"modified_date" : 1708202727000,
"modified_by" : "a360371833bf4c558f796fd707b44daf",
"category_code" : null,
"editing_fields" : null,
"associate" : null,
"linkage_node_fields" : false
},
"tenant_id" : "4e919d73499648e3b0292cd3cbef806a",
"link" : "",
"is_suspended" : null,
"change_status" : null,
"title" : "RR-01",
"sum_workload_man_day" : null,
"plan_end_date" : null,
"rr2ir" : "",
"convolution_plan_hours" : null,
"submitted_by" : [ {
"watcher" : null,
"user_id" : "a360371833bf4c558f796fd707b44daf",
"user_num_id" : 4091,
"user_name" : "devcloud_devcloud_s00404480_01",
"domain_id" : "4e919d73499648e3b0292cd3cbef806a",
"domain_name" : "devcloud_devcloud_s00404480_01",
"nick_name" : "测试账号",
"role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6",
"role_name" : "项目管理员,项目经理",
"role_code" : "project_admin,Project manager",
"image_id" : null,
"region" : null,
"has_removed" : null
} ],
"rr2us" : "",
"cascade_delete" : "none",
"recipient" : [ {
"watcher" : null,
"user_id" : "a360371833bf4c558f796fd707b44daf",
"user_num_id" : 4091,
"user_name" : "devcloud_devcloud_s00404480_01",
"domain_id" : "4e919d73499648e3b0292cd3cbef806a",
"domain_name" : "devcloud_devcloud_s00404480_01",
"nick_name" : "测试账号",
"role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6",
"role_name" : "项目管理员,项目经理",
"role_code" : "project_admin,Project manager",
"image_id" : null,
"region" : null,
"has_removed" : null
} ],
"modified_by" : {
"watcher" : null,
"user_id" : "a360371833bf4c558f796fd707b44daf",
"user_num_id" : 4091,
"user_name" : "devcloud_devcloud_s00404480_01",
"domain_id" : "4e919d73499648e3b0292cd3cbef806a",
"domain_name" : "devcloud_devcloud_s00404480_01",
"nick_name" : "测试账号",
"role_id" : "8dc2cd191a104148a77f937681f9a5d6,6af50476ba89492698d237fb6fa456d6",
"role_name" : "项目管理员,项目经理",
"role_code" : "project_admin,Project manager",
"image_id" : null,
"region" : null,
"has_removed" : null
},
"created_date" : "1712041275000",
"closed_flag" : null,
"category" : "RR",
"collaborative_status" : [ ],
"setup" : true,
"parent_status" : "no"
} ]
}
}
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
错误信息 |
错误码
请参见错误码。