查询规划
功能介绍
查询规划。
调用方法
请参见如何调用API。
URI
GET /v2/workitem/plan
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
page_size |
否 |
Integer |
参数解释: 分页大小。 约束限制: 不涉及。 取值范围: 最小值0,最大值9,999,999,999。 默认取值: 不涉及。 |
|
page_no |
否 |
Integer |
参数解释: 分页索引。 约束限制: 不涉及。 取值范围: 最小值0,最大值9,999,999,999。 默认取值: 不涉及。 |
|
status_id |
否 |
String |
参数解释: 工作项状态id。 约束限制: 不涉及。 取值范围: 1(新建) 2(进行中) 3(已解决) 4(测试中) 5(已关闭) 6(已拒绝) 默认取值: 不涉及。 |
|
plan_id |
否 |
String |
参数解释: 规划的id,通过分页查询当前项目用户可见的所有规划接口获取,响应消息体中的id字段的值就是规划的id。 约束限制: 32位的数字和字母组成的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 最小长度:10,最大长度:32768。 默认取值: 不涉及。 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
result |
result object |
参数解释: 查询规划的返回结果。 取值范围: 不涉及。 |
|
status |
String |
参数解释: 查询规划的返回状态。 取值范围: success:返回成功。 error:返回失败。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Integer |
参数解释: 工作项总数。 取值范围: 不涉及。 |
|
total_count |
Integer |
参数解释: 工作项数量。 取值范围: 不涉及。 |
|
issues |
Array of IssueNew objects |
参数解释: 工作项信息。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
updated_on |
String |
参数解释: 工作项的更新日期。时间戳格式(示例:1839340800000) 。 取值范围: 不涉及。 |
|
story_point |
StoryPoint object |
参数解释: 工作项的故事点。 取值范围: 不涉及。 |
|
subject |
String |
参数解释: 工作项的负责者。 取值范围: 不涉及。 |
|
project |
Project object |
参数解释: 项目。 取值范围: 不涉及。 |
|
isParent |
Boolean |
参数解释: 是否有子工作项。 取值范围: true(有子工作项) false(没有子工作项) |
|
done_ratio |
Integer |
参数解释: 工作项完成度。 取值范围: 不涉及。 |
|
findReleaseDev |
String |
参数解释: 发布人 。 取值范围: 不涉及。 |
|
tracker |
Tracker object |
参数解释: 工作项的类型。 取值范围: 不涉及。 |
|
id |
Integer |
参数解释: 工作项列表id。 取值范围: 不涉及。 |
|
start_date |
String |
参数解释: 工作项的开始日期。时间戳格式(示例:1839340800000)。 取值范围: 不涉及。 |
|
assigned_to |
assigned_to object |
参数解释: 工作项责任人。 取值范围: 不涉及。 |
|
status_attribute |
StatusAttributeVO object |
参数解释: 工作项的状态属性。 取值范围: 不涉及。 |
|
severity |
Severity object |
参数解释: 重要程度。 取值范围: 不涉及。 |
|
releaseDev |
String |
参数解释: 工作项发布版本号。 取值范围: 不涉及。 |
|
author |
author object |
参数解释: 工作项负责人。 取值范围: 不涉及。 |
|
module |
Object |
参数解释: 工作项的模块。 取值范围: 不涉及。 |
|
due_date |
String |
参数解释: 工作项的截止日期,时间戳格式(示例:1839340800000)。 取值范围: 不涉及。 |
|
expected_work_hours |
Integer |
参数解释: 工作项的预计工时(单位:人时)。 取值范围: 不涉及。 |
|
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 |
参数解释: 关闭人员。 取值范围: 不涉及。 |
|
position |
String |
参数解释: 工作项在列表的展示位置 。 取值范围: 不涉及。 |
|
closed_flag |
Integer |
参数解释: 关闭标志 。 取值范围: 0(打开) 1(关闭) |
|
assigned_cc_user |
String |
参数解释: 工作项的抄送人。 取值范围: 不涉及。 |
|
custom_value_new |
Object |
参数解释: 自定义字段。 取值范围: 不涉及。 |
|
status |
Status object |
参数解释: 工作项的状态。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
identifier |
String |
参数解释: 项目uuid。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 项目名称。 取值范围: 不涉及。 |
|
id |
Integer |
参数解释: 项目数字id。 取值范围: 不涉及。 |
|
type |
String |
参数解释: 项目类型。 取值范围: scrum。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 类型名称。 取值范围: Task。 Bug。 Epic。 Feature。 Story。 |
|
id |
Integer |
参数解释: 类型id。 取值范围: 2(任务/Task) 3(缺陷/Bug) 5(Epic) 6(Feature) 7(Story) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
firstName |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
|
lastName |
String |
参数解释: 用户姓名。 取值范围: 不涉及。 |
|
identifier |
String |
参数解释: 用户32位uuid。 取值范围: 不涉及。 |
|
image_id |
String |
参数解释: 用户头像id。 取值范围: 不涉及。 |
|
assignedNickName |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 用户名。 取值范围: 不涉及。 |
|
id |
Integer |
参数解释: 用户数字id。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释: 工作项的重要程度。 取值范围: 关键 重要 一般 提示 |
|
id |
Integer |
参数解释: 重要程度id。 取值范围: 10 (关键) 11 (重要) 12 (一般) 13 (提示) |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
firstName |
String |
参数解释: 用户名称。 取值范围: 不涉及。 |
|
lastName |
String |
参数解释: 用户姓名。 取值范围: 不涉及。 |
|
identifier |
String |
参数解释: 作者唯一标识。 取值范围: 不涉及。 |
|
image_id |
String |
参数解释: 用户头像id。 取值范围: 不涉及。 |
|
authorNickName |
String |
参数解释: 用户昵称。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 带租户信息的用户名(租户名称_用户名)。 取值范围: 不涉及。 |
|
id |
Integer |
参数解释: 用户id。 取值范围: 不涉及。 |
请求示例
{endpoint}/v2/workitem/plan
响应示例
状态码:200
查询规划接口成功的响应。
{
"result" : {
"total" : 1,
"total_count" : 1,
"issues" : [ {
"subject" : "维尔额",
"project" : { },
"findReleaseDev" : "",
"tracker" : {
"name" : "Epic",
"id" : 5
},
"id" : 69824084,
"releaseDev" : "",
"start_date" : "2025-07-28",
"assigned_to" : {
"firstName" : "hw_008618814464665_01",
"assignedNickName" : "asdf4",
"name" : "hw19145027",
"id" : 233087
},
"status_attribute" : {
"name" : "开始态",
"id" : 31845847
},
"severity" : { },
"author" : {
"firstName" : "hw_008618814464665_01",
"name" : "hw19145027",
"id" : 233087,
"authorNickName" : "asdf4"
},
"module" : { },
"due_date" : "2025-07-29",
"priority" : {
"name" : "中",
"id" : 2
},
"deleted" : false,
"fixed_version" : { },
"is_archived" : false,
"domain" : { },
"developer" : { },
"closeder" : { },
"position" : "69824084.0000000000",
"closed_flag" : 0,
"assigned_cc_user" : [ ],
"status" : {
"name" : "新建",
"id" : 1
}
} ]
},
"status" : "success"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询规划接口成功的响应。 |
错误码
请参见错误码。