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

统计目录下脑图数量

功能介绍

统计目录下脑图数量

调用方法

请参见如何调用API

URI

POST /v1/{project_id}/mindmaps/mindmap-total

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过获取CodeArts项目ID接口查询项目列表获取。

取值范围:

字符串长度32。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

params

CountMindmapTotalParam object

参数解释:

统计脑图数量参数对象

表4 CountMindmapTotalParam

参数

是否必选

参数类型

描述

parent_folder_id_collection

Array of strings

参数解释:

ID集合

project_type

String

参数解释:

项目类型

取值范围:

ipd,scrum,xboard

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

参数解释:

是否基线

取值范围:

  • 0,表示非基线。

  • 1,表示是基线。

upward_recursion

Boolean

参数解释:

是否向上卷积

响应参数

状态码:200

表5 响应Body参数

参数

参数类型

描述

code

String

参数解释:

错误码

取值范围:

大小写字母、数字。

长度限制0到20位

data

Map<String,Integer>

参数解释:

返回体

取值范围:

不涉及

message

String

参数解释:

错误信息

取值范围:

大小写字母、数字、符号、中文。

长度限制0到1000位

状态码:400

表6 响应Body参数

参数

参数类型

描述

code

String

参数解释:

接口调用错误码。

取值范围:

大小写字母、数字。

长度限制0到20位

data

String

参数解释:

接口调用返回体

取值范围:

不涉及

message

String

参数解释:

接口调用错误信息

取值范围:

大小写字母、数字、符号、中文。

长度限制0到1000位

状态码:401

表7 响应Body参数

参数

参数类型

描述

code

String

参数解释:

接口调用错误码。

取值范围:

大小写字母、数字。

长度限制0到20位

data

String

参数解释:

接口调用返回体

取值范围:

不涉及

message

String

参数解释:

接口调用错误信息

取值范围:

大小写字母、数字、符号、中文。

长度限制0到1000位

请求示例

统计目录下脑图数量

post https://{endpoint}/v1/b94c9a6947a44597891e0a7362e7383f/mindmaps/mindmap-total

{
  "params" : {
    "parent_folder_id_collection" : [ ],
    "project_type" : "scrum",
    "folder_root_id" : "feature_root_id",
    "branch_uri" : "v92t00010a9h5c3e",
    "iterator_uri" : "",
    "is_master" : 1,
    "upward_recursion" : false
  }
}

响应示例

状态码:200

OK

{
  "code" : "success",
  "data" : {
    "feature_root_id" : 15,
    "-1" : 4,
    "v92s00010etsb5ij" : 0
  },
  "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

错误码

请参见错误码

相关文档