文档首页/ 需求管理 CodeArts Req/ API参考/ API/ Scrum项目的规划/ 查询规划列表
更新时间：2025-08-11 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询规划列表

功能介绍

分页查询当前项目用户可见的所有规划。

调用方法

请参见如何调用API。

URI

POST /v3/plan/{project_id}/managements

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口获取，响应消息体中的project_id字段的值就是项目ID。

约束限制：

正则表达式，[A-Za-z0-9]{32}。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

search

否

String

参数解释：

分组名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

user_ids

否

Array of strings

参数解释：

创建人的uuid列表，用户通过获取当前用户信息接口获取，响应消息体中的user_id字段的值就是用户32位uuid。

约束限制：

不涉及。

sort

否

String

参数解释：

查询数据的排序规则。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

page_no

是

Integer

参数解释：

当前页数。

约束限制：

不涉及。

取值范围：

最小1，最大9999。

默认取值：

1。

type

否

String

参数解释：

规划类型。

约束限制：

不涉及。

取值范围：

gantt（甘特），

mind（思维导图）。

默认取值：

不涉及。

page_size

是

Integer

参数解释：

每页行数。

约束限制：

不涉及。

取值范围：

最小1，最大200。

默认取值：

1。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

plans

Array of PlanVO objects

参数解释：

项目规划列表。

total

Long

参数解释：

查询到的项目规划总条数。

取值范围：

不涉及。

minds

Long

参数解释：

查询到的类型为思维导图的规划条数。

取值范围：

不涉及。

gantts

Long

参数解释：

查询到的类型为甘特图的规划条数。

取值范围：

不涉及。
表4 PlanVO

参数

参数类型

描述

result

result object

参数解释：

规划列表的结果。

status

String

参数解释：

请求的处理状态。

取值范围：

success：成功

error：失败
表5 result

参数

参数类型

描述

id

String

参数解释：

规划的id。

取值范围：

不涉及。

name

String

参数解释：

规划的标题。

取值范围：

不涉及。

type

String

参数解释：

规划类型。

取值范围：

gantt（甘特）

mind（思维导图）

project_id

String

参数解释：

所属项目的id。

取值范围：

不涉及。

creator

creator object

参数解释：

创建人的信息。
表6 creator

参数

参数类型

描述

user_id

String

参数解释：

创建人的用户id。

取值范围：

不涉及。

domain_id

String

参数解释：

租户的id。

取值范围：

不涉及。

nick_name

String

参数解释：

创建人的昵称。

取值范围：

不涉及。

first_name

String

参数解释：

创建人的账户名。

取值范围：

不涉及。

请求示例

POST https://{endpoint}/v3/plan/919bb351ef424e2daaf3dd80c179fae9/managements

{
  "sort" : "",
  "search" : "",
  "page_no" : 1,
  "page_size" : 15,
  "type" : "gantt",
  "user_ids" : [ "a360371833bf4c558f796fd707b44daf" ]
}

响应示例

状态码：200

查询项目下当前用户可见的所有规划返回数据。

{
  "result" : {
    "plans" : [ {
      "id" : "bf56512ab4e544c29d03d068711ca56a",
      "name" : "甘特测试",
      "type" : "gantt",
      "project_id" : "919bb351ef424e2daaf3dd80c179fae9",
      "creator" : {
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "nick_name" : "张三丰",
        "first_name" : "devcloud_devcloud_s00404480_01"
      },
      "updater" : {
        "user_id" : "a360371833bf4c558f796fd707b44daf",
        "domain_id" : "4e919d73499648e3b0292cd3cbef806a",
        "nick_name" : "张三丰",
        "first_name" : "devcloud_devcloud_s00404480_01"
      },
      "created_on" : "1749730042000",
      "updated_on" : "1749730527000",
      "img_url" : "/v1/upload/919bb351ef424e2daaf3dd80c179fae9/202506/1749730526922581391.png"
    } ],
    "total" : "1",
    "minds" : "0",
    "gantts" : "1"
  },
  "status" : "success"
}

状态码

状态码

描述

200

查询项目下当前用户可见的所有规划返回数据。

错误码

请参见错误码。

父主题： Scrum项目的规划

相关文档