查询栏目接口

场景描述

调用该接口，查询指定栏目的子栏目信息。

接口方法

该接口仅支持POST方法。

接口URI

https://域名/apiaccess/ccikbs/v1/columnkngapi/queryColumnsBySuperCode，例如域名是service.besclouds.com。

请求说明

表1 请求消息头参数说明
序号	名称	参数类型	是否必选	说明
1	Content-Type	String	True	固定填 application/json;charset=UTF-8（两种鉴权方式都填写）。
2	x-app-key	string	True	appKey字段，用户标识，请联系运营人员获取appKey。
3	Authorization	String	True	鉴权信息，格式如下所示。 Bearer Access Token。 Access Token的生成方式参见C1 系统配置类接口鉴权方式。

表2 请求消息体参数说明
序号	名称	参数类型	是否必选	说明
1	beyondColuId	String	True	所属栏目ID。首层栏目的所属栏目ID为0。如需获取其他栏目ID，可从根目录开始依次调用该接口向下查询。
4	userName	String	True	用于在AICC系统中查询栏目的操作员账号，该账号在AICC侧必须拥有“知识库 > 知识栏目”和“知识库 > 知识主页”中至少一个权限。

响应说明

当调用本接口响应失败，则返回相应的错误码信息，错误码响应数据结构请查看表3。

表3 响应消息体参数说明
序号	名称	参数类型	说明
1	resultCode	String	请求返回的结果码。取值范围： 0为成功 1为失败
2	description	String	请求结果描述。
3	datas	List	当前所属栏目ID的下一级子栏目列表。参数说明详见表4。

表4 datas对象参数说明
序号	名称	参数类型	说明
1	coluKngId	String	栏目知识ID。
2	coluKngName	String	栏目知识名称。
3	coluKngType	String	栏目知识类型。 1：栏目 2：普通知识 3：问答知识
4	beyondColuId	Number	所属栏目ID。首层栏目的所属栏目ID为0。
5	beyondColuPath	Number	所属栏目路径。首层栏目所属路径为/。
6	coluType	Number	栏目类型。
7	code	Number	栏目编码。为栏目或者知识在栏目知识树上的节点编码。
8	superCode	Number	栏目上级编码。
9	id	String	该栏目知识在数据库中存放的索引ID。
10	maintenancegroup	String	栏目知识维护群组，群组id，多个使用英文逗号分隔。
11	browsinggroup	String	栏目知识浏览群组，群组id，多个使用英文逗号分隔。

报文样例

请求头

x-app-key: b*************c7b
Authorization: Bearer 1fea*************1d6a15
Content-Type: application/json

请求参数

{
    "beyondColuId": "0",
    "userName": "aicc_test001"
}

响应参数

{
    "returnCode": "0",
    "description": "success",
    "datas": [
        {
            "coluKngName": "lzd0916父栏目",
            "maintenancegroup": "",
            "code": "001",
            "coluType": 1,
            "coluKngType": 1,
            "browsinggroup": "",
            "superCode": "-1",
            "id": "caBE000000wqY7oYeYPA",
            "beyondColuId": "0",
            "beyondColuPath": "/",
            "coluKngId": "63e3e4b42c94482b95e04e911f497fbb"
        }
    ]
}

父主题： 接口说明

上一篇：查询知识详情接口

下一篇：查询知识列表接口