更新时间:2025-07-28 GMT+08:00
分享

查询模块树形列表

功能介绍

查询模块树形列表

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

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

约束限制

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

取值范围

不涉及。

默认取值

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

key_word

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

sort

String

参数解释:

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

约束限制:

不涉及

取值范围:

不涉及

默认取值:

created_date

sort_type

String

参数解释:

排序方式,可选值为:asc,desc,asc表示升序,desc表示降序,默认为desc

约束限制:

不涉及

取值范围:

asc,desc

默认取值:

desc

offset

Integer

参数解释:

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

约束限制:

不涉及

取值范围:

最小值:0,最大值:350

默认取值:

0

limit

Integer

参数解释:

分页大小

约束限制:

不涉及

取值范围:

最小值:1,最大值:100

默认取值:

10

请求参数

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

ModuleListResult object

参数解释:

模块列表

status

String

参数解释:

查询结果状态

取值范围:

不涉及

message

String

参数解释:

错误信息

取值范围:

不涉及

表4 ModuleListResult

参数

参数类型

描述

modules

Array of ModuleEntity objects

参数解释:

模块列表

total

Integer

参数解释:

模块总数,项目下模块最多允许350个(包含子模块)

取值范围:

最大值:350

表5 ModuleEntity

参数

参数类型

描述

id

String

参数解释:

模块id

取值范围:

不涉及

sequence

String

参数解释:

模块顺序值,double类型

取值范围:

不涉及

level

Integer

参数解释:

模块层级,最多3层

取值范围:

1,2,3

description

String

参数解释:

模块描述信息

取值范围:

不涉及

created_by

String

参数解释:

模块创建人id

取值范围:

不涉及

created_time

String

参数解释:

模块创建时间,unix时间戳,单位:毫秒

取值范围:

不涉及

modified_by

String

参数解释:

模块最近修改人id

取值范围:

不涉及

modified_time

String

参数解释:

模块最近修改时间,unix时间戳,单位:毫秒

取值范围:

不涉及

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

错误描述

请求示例

https://{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

错误信息

错误码

请参见错误码

相关文档