查询分类

最近更新时间:2023-07-12 14:23:22

我的收藏

接口描述

接口名称:/Material/DescribeClass
接口功能:查询分类。

调用方式

具体调用方式参见 客户端 API 调用方式综述,您也可以使用 CME 客户端 API 调试工具 快速进行调试。

输入参数

字段
类型
必填
描述
Platform
String
平台。
Owner
分类归属。
BaseClassId
Integer
查询基类的 ID,默认为 -1,表示从根分类查询。
FirstLevel
bool
是否仅查询一层分类。

输出参数

接口输出参数由 公共返回参数 和接口自身返回参数两部分组成。接口自身返回参数详情如下。
字段
类型
描述
PathInfoSet
Array of ClassInfo
分类对应的路径信息,只有指定具体分类时候才返回对应的路径信息。
ClassInfoSet
Array of ClassInfo
分类信息。

示例

示例1:查询分类成功

查询根分类下的一级子分类,成功返回子分类。

输入示例

{
"Platform": "my_platform",
"Owner": {
"Id": "5fd977677a23b40001ca3aff",
"Type": "PERSON"
},
"FirstLevel": true
}

输出示例

{
"Code": "Success",
"Message": "成功",
"EnglishMessage": "success",
"Data": {
"ClassInfoSet": [
{
"ClassId": 9,
"Name": "个人",
"ParentClassId": -1,
"ClassPath": "/个人"
}
]
}
}

示例2:查询分类失败

查询无权限的分类,返回失败无权限操作。

输入示例

{
"BaseClassId": 6,
"Platform": "my_platform",
"Owner": {
"Id": "5fd977677a23b40001ca3aff",
"Type": "PERSON"
},
"FirstLevel": true
}

输出示例

{
"Code": "OperationDenied.PermissionDeny",
"Message": "权限不足",
"EnglishMessage": "permission denied"
}