1. 大屏端查询知识库树节点数据

大屏端查询知识库树节点数据

注意

  • 如果接口需要提供auth-token,你需要通过轻筑开放平台创建应用来获取appid和secret,然后通过appid和secret来获取接口访问凭证auth-token。
  • 如果需要获取当前用户的使用信息,授权确保你能获取到qzcode,然后通过网页授权接口获取相关信息。

1.1. 1. 基本信息

概况 内容
接口地址 /api/inspect/openListBy
请求方法 GET
请求数据类型 URL参数
响应数据类型 JSON

1.2. 2. 请求数据

1.2.1. 请求头(request-header)

请求头除了默认的参数还需要添加如下请求头参数:

字段 描述
auth-token 接口访问凭据,你可以通过平台下发的appid和secret获取凭据

1.2.2. 请求参数(request-parameter)

字段 是否必传 描述
projectId 项目ID 是项目端传项目ID
teamId 团队ID
enterpriseId 企业ID 企业端传企业ID

参数请求示例:

http://api.example.com/xxx?key=value

1.3. 3. 响应数据

响应数据中 code, message, data 为默认字段,所有字段如下表所示:

字段 类型 是否必填 描述
code number
message string
data array
createTime number 创建时间戳
name string 企业名称或者项目名称
id string 主键ID
title string 标题
version number 版本
contentType string 内容类型(0-文件夹 1-链接 2-文件 3-二维图纸
parentId string 上级ID
child array 子列表
createTime number 创建时间
parentIds string 所属上级的全部ID
name string 企业名称或者项目名称
id string 主键ID
title string 标题
parentId string 上级ID
content string 内容
remarks string 备注

响应数据结构如下所示:

{
    "code": 0,
    "message": null,
    "data": [
        {
            "createTime": 1526628900000,
            "name": "公共团队",
            "id": "hhhhhhhhhhhhhhhhhhhhhhhhhhh",
            "title": "知识库",
            "version": 1,
            "contentType": "0",
            "parentId": "0",
            "child": [
                {
                    "createTime": 1526628900000,
                    "parentIds": "hhhhhhhhhhhhhhhhhhhhhhhhhhh,",
                    "name": "公共团队",
                    "id": "xxxxxxxxxxxx",
                    "title": "图纸",
                    "version": 218,
                    "contentType": "0",
                    "parentId": "hhhhhhhhhhhhhhhhhhhhhhhhhhh",
                    "child": [
                        {
                            "createUserId": "xxxxxxxxxxxx",
                            "parentIds": "hhhhhhhhhhhhhhhhhhhhhhhhhhh,xxxxxxxxxxxx",
                            "title": "xx",
                            "version": 1,
                            "parentId": "b80260545da311e8942c005056bd7534",
                            "content": "https://www.baidu.com",
                            "createTime": 1642785521000,
                            "teamId": "xxxxxxxxxxxx",
                            "name": "xxxx",
                            "id": "xxxxxxxxxxxx",
                            "contentType": "3",
                            "remarks": "",
                            "child": [
                                {
                                    "createUserId": "xxxxxxxxxxxx",
                                    "parentIds": "hhhhhhhhhhhhhhhhhhhhhhhhhhh,xxxxxxxxxxxx",
                                    "title": "xx",
                                    "version": 1,
                                    "parentId": "xxxxxxxxxxxx",
                                    "content": "https://www.baidu.com",
                                    "createTime": 1642785500000,
                                    "teamId": "xxxxxxxxxxxx",
                                    "name": "xxxx",
                                    "id": "xxxxxxxxxxxx",
                                    "contentType": "3",
                                    "remarks": "",
                                    "child": []
                                }
                            ]
                        }
                    ]
                },
                {
                    "createTime": 1526628900000,
                    "parentIds": "hhhhhhhhhhhhhhhhhhhhhhhhhhh,",
                    "name": "公共团队",
                    "id": "b80716b95da311e8942c005056bd7534",
                    "title": "视频",
                    "version": 224,
                    "contentType": "0",
                    "parentId": "hhhhhhhhhhhhhhhhhhhhhhhhhhh",
                    "child": []
                }
            ]
        }
    ]
}

1.4. 4. 错误码

当返回数据中的 code 不为 0 时,为错误返回。其中errCode为详细的错误码。

© All Rights Reserved            updated 2024-08-23 10:14:55

results matching ""

    No results matching ""