根据条件分页获取脑图对象
功能介绍
根据条件分页获取脑图对象
调用方法
请参见如何调用API。
URI
POST /v3/{project_id}/mindmaps/page
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目的32位uuid,项目唯一标识,通过获取CodeArts项目ID接口查询项目列表获取。 取值范围: 字符串长度32。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 必传。 取值范围: 字符串长度不少于1,不超过10万。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
params |
是 |
MindmapPageParam object |
参数解释: 脑图分页查询参数 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
参数解释: 起始偏移量,表示从此偏移量开始查询,offset大于等于0,小于等于100000 |
|
limit |
否 |
Integer |
参数解释: 每页显示的条目数量,最大支持200条 |
|
name |
否 |
String |
参数解释: 脑图名称 取值范围: 大小写字母、数字、符号、中文。 长度限制1-500位 长度限制1-500位 |
|
id_collection |
否 |
Array of strings |
参数解释: ID集合 |
|
folder_id_collection |
否 |
Array of strings |
参数解释: 目录ID集合 |
|
project_id |
是 |
String |
参数解释: 项目ID 取值范围: 大小写字母、数字。 长度限制固定32位 |
|
folder_root_id |
否 |
String |
参数解释: 所属目录的根目录ID 取值范围: 1.-1:特性目录其他目录 2.requirement_root_id:需求根目录 3.feature_root_id:特性根目录 |
|
branch_uri |
否 |
String |
参数解释: 分支uri 取值范围: 大小写字母、数字。 长度限制1-34位 |
|
iterator_uri |
否 |
String |
参数解释: 计划uri 取值范围: 大小写字母、数字。 长度限制0-34位 |
|
is_master |
否 |
Integer |
参数解释: 是否基线 取值范围:
|
|
creator_name_collection |
否 |
Array of strings |
参数解释: 创建者名称集合 |
|
updater_name_collection |
否 |
Array of strings |
参数解释: 更新人名称集合 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 接口调用错误码 取值范围: 大小写字母、数字。 长度限制0到20位 |
|
data |
BasePageInfoMindmap object |
参数解释: 脑图分页结果 |
|
message |
String |
参数解释: 接口调用错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total |
Long |
参数解释: 总数 |
|
list |
Array of Mindmap objects |
参数解释: 脑图列表 |
|
offset |
Integer |
参数解释: 起始偏移量,表示从此偏移量开始查询,offset大于等于0,小于等于100000 |
|
limit |
Integer |
参数解释: 每页显示的条目数量,最大支持200条 |
|
pages |
Integer |
参数解释: 总页数量 |
|
size |
Integer |
参数解释: 列表个数 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: 脑图主键ID 取值范围: 大小写字母、数字。 长度限制固定32位 |
|
mindmap |
String |
参数解释: 脑图JSON 取值范围: 大小写字母、数字、符号。 长度限制1-2000位 |
|
name |
String |
参数解释: 脑图名称 取值范围: 大小写字母、数字、符号、中文。 长度限制1-500位 |
|
privacy |
String |
参数解释: 是否私有 取值范围:
|
|
app |
String |
参数解释: 所属app 取值范围: 大小写字母、数字、符号。 长度限制1-255位 |
|
create_time |
String |
参数解释: 创建时间 |
|
creator_name |
String |
参数解释: 创建人名称。 取值范围: 大小写字母、数字、符号、中文。 长度限制1-255位 |
|
creator_num |
String |
参数解释: 创建者,用户在IAM中的ID。 取值范围: 大小写字母、数字。 长度限制固定32位 长度限制固定32位 |
|
update_name |
String |
参数解释: 更新人名称。 取值范围: 大小写字母、数字、符号、中文。 |
|
update_num |
String |
参数解释: 更新者,用户在IAM中的ID。 取值范围: 大小写字母、数字。 |
|
update_time |
String |
参数解释: 更新时间 取值范围: 格式固定为yyyy-MM-dd HH:mm:ss。 |
|
folder_id |
String |
目录ID 取值范围: 1.大小写字母、数字。 长度限制固定32位 2.-1:特性目录其他目录 3.requirement_root_id:需求根目录 4.feature_root_id:特性根目录 |
|
project_id |
String |
参数解释: 项目ID 取值范围: 大小写字母、数字。 长度限制固定32位 |
|
folder_root_id |
String |
参数解释: 所属目录的根目录ID 取值范围: 1.-1:特性目录其他目录 2.requirement_root_id:需求根目录 3.feature_root_id:特性根目录 |
|
branch_uri |
String |
参数解释: 分支uri 取值范围: 大小写字母、数字。 长度限制1-34位 |
|
iterator_uri |
String |
参数解释: 计划uri 取值范围: 大小写字母、数字。 长度限制0-34位 |
|
is_master |
Integer |
参数解释: 是否基线 取值范围:
|
|
max_depth |
Integer |
参数解释: 脑图最大深度 取值范围: 值小于83 |
|
map_version |
String |
参数解释: 脑图版本。 取值范围: 大小写字母、数字、符号。 长度限制1-255位 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 接口调用错误码。 取值范围: 大小写字母、数字。 长度限制0到20位 |
|
data |
String |
参数解释: 接口调用返回体 取值范围: 不涉及 |
|
message |
String |
参数解释: 接口调用错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
状态码:401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
code |
String |
参数解释: 接口调用错误码。 取值范围: 大小写字母、数字。 长度限制0到20位 |
|
data |
String |
参数解释: 接口调用返回体 取值范围: 不涉及 |
|
message |
String |
参数解释: 接口调用错误信息 取值范围: 大小写字母、数字、符号、中文。 长度限制0到1000位 |
请求示例
根据条件分页获取脑图对象
post https://{endpoint}/v3/b94c9a6947a44597891e0a7362e7383f/mindmaps/page
{
"params" : {
"folder_id_collection" : [ ],
"name" : "",
"project_id" : "b94c9a6947a44597891e0a7362e7383f",
"folder_root_id" : "feature_root_id",
"branch_uri" : "v92t00010a9h5c3e",
"iterator_uri" : "",
"is_master" : 1,
"offset" : 1,
"limit" : 10
}
}
响应示例
状态码: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",
"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
}
状态码:400
Bad Request
{
"error_code" : "TESTMIND.00021882",
"error_msg" : "分支、计划id长度不合法,请稍后重试"
}
状态码:401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。