文档首页/ 需求管理 CodeArts Req/ API参考/ API/ IPD模块管理/ 查询模块树形列表
更新时间：2024-11-30 GMT+08:00
查看PDF
分享

查询模块树形列表

功能介绍

查询模块树形列表

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/ipdprojectservice/projects/{project_id}/modules/tree

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目 id
表2 Query参数

参数

是否必选

参数类型

描述

key_word

否

String

按关键字搜索，当前仅支持按名称关键字搜索

sort

否

String

排序规则，默认为创建时间降序，即最新创建的排在最前面

sort_type

否

String

排序方式，可选值为：asc、desc，asc表示升序，desc表示降序，默认为desc

offset

否

Integer

分页起始，从0开始，为limit整数倍,默认为0

limit

否

Integer

分页大小，默认为10

请求参数

无

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

result

ModuleListResult object

模块列表

status

String

查询结果状态

message

String

错误信息
表4 ModuleListResult

参数

参数类型

描述

modules

Array of ModuleEntity objects

模块列表

total

Integer

模块总数，项目下模块最多允许350个(包含子模块)
表5 ModuleEntity

参数

参数类型

描述

id

String

模块id

sequence

String

模块顺序值。double类型

level

Integer

模块层级，最多3层

description

String

模块描述信息

created_by

String

模块创建人id

created_time

String

模块创建时间

modified_by

String

模块最近修改人id

modified_time

String

模块最近修改时间

display_value

String

模块显示名

path_name

String

子模块的路径名

value

String

模块唯一标识，自定义模块value和id项目

parent_id

String

父模块id

child_modules

Array of ModuleEntity objects

子模块

assignee

String

模块责任人id

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

{endpoint}/v1/ipdprojectservice/projects/336ad84c67ea4783b2edc1bb5a112da0/modules/tree?offset=0&limit=20&sort_type=asc

响应示例

状态码： 200

OK

{
  "status" : "success",
  "message" : null,
  "result" : {
    "modules" : [ {
      "id" : "958663834527117312",
      "sequence" : "1.0",
      "level" : 1,
      "description" : "aaaa",
      "created_by" : "a360371833bf4c558f796fd707b44daf",
      "created_time" : "1706492869000",
      "modified_by" : "a360371833bf4c558f796fd707b44daf",
      "modified_time" : "1706492869000",
      "display_value" : "模块A",
      "path_name" : "模块A",
      "value" : "958663834527117312",
      "child_modules" : [ {
        "id" : "958663880396025857",
        "sequence" : "1.0",
        "level" : 2,
        "description" : "aaa1",
        "created_by" : "a360371833bf4c558f796fd707b44daf",
        "created_time" : "1706492880000",
        "modified_by" : "a360371833bf4c558f796fd707b44daf",
        "modified_time" : "1706492880000",
        "display_value" : "模块A-1",
        "path_name" : "模块A/模块A-1",
        "value" : "958663880396025857",
        "parent_id" : "958663834527117312",
        "child_modules" : [ {
          "id" : "958663903372423168",
          "sequence" : "1.0",
          "level" : 3,
          "description" : "",
          "created_by" : "a360371833bf4c558f796fd707b44daf",
          "created_time" : "1706492885000",
          "modified_by" : "a360371833bf4c558f796fd707b44daf",
          "modified_time" : "1706492885000",
          "display_value" : "模块A-1-1",
          "path_name" : "模块A/模块A-1/模块A-1-1",
          "value" : "958663903372423168",
          "parent_id" : "958663880396025857",
          "assignee" : "a360371833bf4c558f796fd707b44daf"
        } ],
        "assignee" : "a360371833bf4c558f796fd707b44daf"
      } ],
      "assignee" : "a360371833bf4c558f796fd707b44daf"
    } ],
    "total" : 1
  }
}

状态码： 400

错误信息

{
  "error_code" : "PM.02174103",
  "error_msg" : "分页参数错误"
}

状态码

状态码

描述

200

OK

400

错误信息

错误码

请参见错误码。

父主题： IPD模块管理

相关文档