发布/迭代计划列表查询
功能介绍
发布/迭代计划列表查询
调用方法
请参见如何调用API。
URI
GET /v1/planservice/projects/{project_id}/plans/query
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释: 项目的32位uuid,项目唯一标识,通过查询项目列表接口获取,响应消息体中的project_id字段的值就是项目ID。 约束限制: 正则表达式,^[A-Za-z0-9]{32}$。 取值范围: 不涉及。 默认取值: 不涉及。 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
key_word | 是 | String | 参数解释: 发布/迭代名称 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
updated_time_interval | 是 | String | 参数解释: 更新发布/迭代时间,unix时间戳,单位:毫秒 样例:1576114296000,1576114396000 约束限制: 正则表达式,([1-9][0-9]{0,12})?(,)?([1-9][0-9]{0,12})? 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
x-auth-token | 是 | String | 参数解释:用户token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制:不涉及 取值范围:最小长度10,最大长度:32768 默认取值:不涉及 |
响应参数
状态码:200
参数 | 参数类型 | 描述 |
|---|---|---|
status | String | 参数解释: 返回状态。 取值范围: success:响应成功 error:响应失败 |
message | String | 参数解释: 提示信息 取值范围: 不涉及 |
result | Array of PlanVO objects | 参数解释: 计划列表 |
page | page object | 参数解释: 计划列表页表 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释: id(发布、迭代、里程碑的id) 取值范围: 不涉及 |
title | String | 参数解释: 标题 取值范围: 不涉及 |
category | String | 参数解释: 分类,枚举类型 取值范围: PI,Iteration,PlanMilestone |
description | String | 参数解释: 描述 取值范围: 不涉及 |
state | String | 参数解释: 作废标识,枚举类型。 取值范围: 正在工作:可正常操作的发布 作废:软删除后的发布,可在回收站恢复 删除:彻底删除后的发布,无法恢复 |
status | String | 参数解释: 发布/迭代的状态,枚举类型。 取值范围: planned:发布/计划未开始 going:发布/计划进行中 ended:发布/计划已结束 |
children | Array of PlanVO objects | 参数解释: 子项目迭代信息 |
created_by | String | 参数解释: 创建人 取值范围: 不涉及 |
modified_by | String | 参数解释: 更新人 取值范围: 不涉及 |
plan_start_date | Long | 参数解释: 计划开始时间,unix时间戳,单位:毫秒 取值范围: 不涉及 |
plan_end_date | Long | 参数解释: 计划完成时间,unix时间戳,单位:毫秒 取值范围: 不涉及 |
created_date | Long | 参数解释: 创建时间,unix时间戳,单位:毫秒 取值范围: 不涉及 |
parent_id | String | 参数解释: 父工作项id 取值范围: 不涉及 |
baseline | String | 参数解释: 基线状态,枚举类型 取值范围: baselined,unbaseline,baseline-reviewing |
workload | String | 参数解释: 预估工作量 取值范围: 不涉及 |
owner | String | 参数解释: 责任人ID 取值范围: 不涉及 |
参数 | 参数类型 | 描述 |
|---|---|---|
page | Integer | 参数解释: 页码 取值范围: 不涉及 |
size | Integer | 参数解释: 分页数量 取值范围: 不涉及 |
count | Integer | 参数解释: 当前页数量 取值范围: 不涉及 |
状态码:400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 错误码 |
error_msg | String | 错误描述 |
请求示例
GET https://{endpoint}/v1/planservice/projects/{project_id}/plans/query?key_word=gzy&updated_time_interval=1706845235000,1706845835000 响应示例
状态码:200
OK
{
"status" : "success",
"message" : null,
"result" : [ {
"id" : "956200745322848257",
"title" : "IR-01",
"category" : "PI",
"description" : "描述",
"state" : "正在工作",
"status" : "ended",
"children" : null,
"created_by" : "a360371833bf4c558f796fd707b44daf",
"modified_by" : "a360371833bf4c558f796fd707b44daf",
"plan_start_date" : "1706845715000",
"plan_end_date" : "1706845715000",
"created_date" : "1706845715000",
"parent_id" : "956239067176935424",
"baseline" : "baselined",
"workload" : "workload",
"owner" : "a360371833bf4c558f796fd707b44daf"
} ],
"page" : {
"page" : 1,
"size" : 10,
"count" : 1
}
} 状态码
状态码 | 描述 |
|---|---|
200 | OK |
400 | 错误信息 |
错误码
请参见错误码。

