查询看板项目下的工作项
功能介绍
查询看板项目下的工作项
调用方法
请参见如何调用API。
URI
GET /v4/projects/{project_id}/work-items
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
project_id |
是 |
String |
devcloud项目的32位id 最小长度：32 最大长度：32 |
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
offset |
否 |
Integer |
偏移量 从0开始 最小值：0 缺省值：0 |
limit |
否 |
Integer |
每页数量 最小1,最大100 最小值：1 最大值：100 缺省值：100 |
created_time_interval |
否 |
String |
创建工作项的时间(查询的起始时间,查询的结束时间) |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：10 最大长度：32768 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
work_items |
Array of Workitems objects |
工作项 |
total |
Integer |
总数 |
参数 |
参数类型 |
描述 |
|---|---|---|
id |
String |
工作项id |
description |
String |
工作项描述 |
actual_work_hours |
Double |
实际工时 |
assigned_user |
WorkitemUser object |
|
author |
WorkitemUser object |
|
begin_time |
String |
工作项开始时间 |
created_time |
String |
创建时间 |
tags |
Array of tags objects |
标签 |
developer |
WorkitemUser object |
|
assigned_cc_user |
Array of WorkitemUser objects |
抄送人 |
discover_version |
String |
发现问题的版本 |
end_time |
String |
工作项结束时间 |
done_ratio |
String |
工作项进度值 |
expected_work_hours |
Double |
预计工时 |
order |
String |
顺序 |
parent_work_item_id |
String |
父工作项的id |
release_version |
String |
发布的版本 |
story_point |
String |
故事点 |
domain |
domain object |
id, 领域 14, '性能', 15, '功能', 16, '可靠性' 17, '网络安全' 18, '可维护性' 19, '其他DFX' 20, '可用性' 其他 |
iteration |
iteration object |
迭代 |
module |
module object |
模块 |
priority |
String |
工作项优先级 |
severity |
String |
严重的程度 "提示", "一般", "严重", "致命" |
status |
status object |
工作项状态 |
subject |
String |
工作项标题 |
updated_time |
String |
更新时间 |
sequence |
String |
工作项编号 |
important |
String |
重要程度 "关键", "重要", "一般", "提示" |
custom_fields |
Array of WorkitemCustomField objects |
用户自定义字段 |
参数 |
参数类型 |
描述 |
|---|---|---|
field_id |
String |
自定义字段id |
field_name |
String |
自定义字段名称 |
field_type |
String |
自定义字段类型, "Date","Number","DateTime", "MultiLineText","SingleLineText", "Select", "Checkbox" |
field_option_source |
String |
自定义字段的选项源,CUSTOM，USER，DOMAIN，ITERATION，MODULE，TAG |
value |
String |
自定义字段值, (field_type为Date,Number,DateTime时,field_option_source为空，value值是数字的字符串)， (field_type为MultiLineText,SingleLineText时,field_option_source为空，value值是文本字符串)， (field_type为Select ,field_option_source为CUSTOM时，value值是文本字符串) (field_type为Select ,field_option_source为USER，DOMAIN，ITERATION，MODULE，TAG时，value值是Json格式{}), (field_type为Checkbox ,field_option_source为CUSTOM时，value值是字符串数组["aaa"]), (field_type为"Checkbox" ,field_option_source为USER，DOMAIN，ITERATION，MODULE，TAG时，value值是Json的数组[{},{}]) |
状态码： 400
参数 |
参数类型 |
描述 |
|---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
状态码： 401
参数 |
参数类型 |
描述 |
|---|---|---|
error_msg |
String |
错误描述 |
error_code |
String |
错误码 |
请求示例
GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/work-items
GET https://{endpoint}/v4/projects/526cefde62004de2b62b5e8dd2c2b3af/work-items
响应示例
状态码： 200
OK
{
"work_items" : [ {
"id" : "4633454879781163008",
"description" : "demo",
"actual_work_hours" : 10,
"assigned_user" : {
"id" : "665b542eb4c14b53a15ead449f28b0ba",
"name" : "demo_user_name",
"nick_name" : "demo"
},
"author" : {
"id" : "665b542eb4c14b53a15ead449f28b0ba",
"name" : "demo_user_name",
"nick_name" : "demo"
},
"begin_time" : "1590940800000",
"created_time" : "1590940800000",
"tags" : [ {
"id" : "456",
"name" : "tagdemo"
} ],
"developer" : {
"id" : "665b542eb4c14b53a15ead449f28b0ba",
"name" : "demo_user_name",
"nick_name" : "demo"
},
"assigned_cc_user" : [ {
"id" : "665b542eb4c14b53a15ead449f28b0ba",
"name" : "demo_user_name",
"nick_name" : "demo"
} ],
"discover_version" : "ProjectMan 8.0.0",
"end_time" : "1590940800000",
"done_ratio" : "10%",
"expected_work_hours" : 9,
"order" : "1",
"parent_work_item_id" : "4633454879781163001",
"release_version" : "ProjectMan 8.0.0",
"story_point" : "0",
"domain" : {
"id" : "14",
"name" : "性能"
},
"iteration" : {
"id" : "456",
"name" : "迭代1"
},
"module" : {
"id" : "456",
"name" : "Project"
},
"priority" : "低",
"severity" : "一般",
"status" : {
"id" : "d25fe91f7f6b489db5f804e66ac3b360",
"name" : "新建"
},
"subject" : "demosubject",
"updated_time" : "1595832054113",
"sequence" : "5500756",
"important" : "提示",
"custom_fields" : [ {
"field_id" : "d25fe91f7f6b489db5f804e66a0",
"field_name" : "customField",
"field_type" : "Select",
"field_option_source" : "USER",
"value" : "{\"id\":\"d25fe91f7f6b489db5f804e66a0\",\"name\":\"devcloud_test001\",\"nick_name\":\"demo\"}"
} ]
} ],
"total" : 1
}
状态码
状态码 |
描述 |
|---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
错误码
请参见错误码。
