文档首页/ 测试计划 CodeArts TestPlan/ API参考/ API/ 测试设计接口管理/ 根据条件分页获取脑图对象
更新时间：2024-11-19 GMT+08:00
查看PDF
分享

根据条件分页获取脑图对象

功能介绍

根据条件分页获取脑图对象

URI

POST /v3/{project_id}/mindmaps/page

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目唯一标识，固定长度32位字符

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

params

是

MindmapPageParam object

脑图分页查询参数
表4 MindmapPageParam

参数

是否必选

参数类型

描述

offset

否

Integer

起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000

limit

否

Integer

每页显示的条目数量，最大支持200条

name

否

String

脑图名称

id_collection

否

Array of strings

主键集合id

folder_id_collection

否

Array of strings

目录id

project_id

是

String

项目id

folder_root_id

否

String

根目录id

branch_uri

否

String

分支uri

iterator_uri

否

String

计划uri

is_master

否

Integer

是否基线

creator_name_collection

否

Array of strings

创建者名称集合

updater_name_collection

否

Array of strings

更新人名称集合

响应参数

状态码： 200

表5 响应Body参数

参数

参数类型

描述

code

String

接口调用状态码

data

BasePageInfoMindmap object

脑图分页结果

message

String

接口调用返回信息
表6 BasePageInfoMindmap

参数

参数类型

描述

total

Long

总数

list

Array of Mindmap objects

脑图列表

offset

Integer

起始偏移量，表示从此偏移量开始查询，offset大于等于0，小于等于100000

limit

Integer

每页显示的条目数量，最大支持200条

pages

Integer

总页数量

size

Integer

列表个数
表7 Mindmap

参数

参数类型

描述

id

String

脑图主键

mindmap

String

脑图JSON

name

String

脑图名称

privacy

String

是否私有

app

String

所属app

create_time

String

创建时间

creator_name

String

创建人名称

creator_num

String

创建人编号

update_name

String

更新人名称

update_num

String

更新人编号

update_time

String

更新时间

folder_id

String

文件路径

project_id

String

项目id

folder_root_id

String

根目录id

branch_uri

String

分支uri

iterator_uri

String

计划uri

is_master

Integer

是否为Master分支

max_depth

Integer

脑图最大深度

map_version

String

脑图版本

状态码： 400

表8 响应Body参数

参数

参数类型

描述

code

String

接口调用错误码

data

String

接口调用返回体

message

String

接口调用错误信息

状态码： 401

表9 响应Body参数

参数

参数类型

描述

code

String

接口调用错误码

data

String

接口调用返回体

message

String

接口调用错误信息

状态码： 404

表10 响应Body参数

参数

参数类型

描述

code

String

接口调用错误码

data

String

接口调用返回体

message

String

接口调用错误信息

状态码： 500

表11 响应Body参数

参数

参数类型

描述

code

String

接口调用错误码

data

String

接口调用返回体

message

String

接口调用错误信息

请求示例

无

响应示例

状态码： 200

OK

{
  "code" : "success",
  "data" : {
    "total" : 1,
    "list" : [ {
      "id" : "e0fd499609614f12b2fca889ada32162",
      "mindmap" : null,
      "name" : "思维导图",
      "privacy" : null,
      "app" : null,
      "create_time" : "2024/05/22 07:38:58 GMT+08:00",
      "creator_name" : "lwx1开发人员21",
      "creator_num" : "e8ad9e7478c94f4eaf90d5a379af9cb1",
      "updator_name" : "--",
      "updator_num" : null,
      "update_name" : "lwx1开发人员21",
      "update_num" : "e8ad9e7478c94f4eaf90d5a379af9cb1",
      "update_time" : "2024/05/22 07:39:39 GMT+08:00",
      "folder_id" : "feature_root_id",
      "project_id" : "fb07002bf4ae4317a855b590a86a52e0",
      "folder_root_id" : "feature_root_id",
      "branch_uri" : "v91j0000viceusv6",
      "iterator_uri" : "",
      "is_master" : 1,
      "max_depth" : null,
      "map_version" : null
    } ],
    "offset" : 1,
    "limit" : 10,
    "pages" : 1,
    "size" : 1
  },
  "message" : null
}

状态码

状态码

描述

200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

错误码

请参见错误码。

相关文档