批量获取知识库新版SDK
更新于 2023-06-06
接口功能介绍
调用本接口,根据操作人unionId和知识库ID,查询知识库信息。示例如下:

权限
要调用此API,需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 支持 | 知识库读权限 | API Explorer |
第三方企业应用 | 支持 | 知识库读权限 | API Explorer |
第三方个人应用 | 暂不支持 | 知识库读权限 | 暂不支持 |
请求方法
Header参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
x-acs-dingtalk-access-token | String | 是 | 调用该接口的访问凭证。
|
Query参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
operatorId | String | 是 | 操作人unionId。 |
Body参数
返回参数
名称 | 类型 | 描述 |
---|---|---|
workspaces | Array | 知识库列表。 |
workspaceId | String | 知识库id(spaceUuid)。 |
corpId | String | 知识库归属企业的corpId。 |
teamId | String | 知识库归属知识小组的id。 说明
不归属任何知识小组的时候, 返回空。 |
rootNodeId | String | 根节点id(根节点dentryUuid)。 |
name | String | 知识库名称。 |
type | String | 知识库类型,枚举值:
|
description | String | 知识库简介。 |
url | String | 知识库访问url。 |
icon | Object | 知识库图标。 |
type | String | 图标类型,枚举值:
|
value | String | 图标值:
|
cover | String | 知识库封面url。 |
creatorId | String | 知识库创建者userId。 |
modifierId | String | 知识库修改者userId。 |
createTime | String | 知识库创建时间。 |
modifiedTime | String | 知识库修改时间。 |
permissionRole | String | 查询人对知识库的权限角色,枚举值:
|
示例
请求示例
返回示例
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | paramError | %s | 参数错误 |
403 | permissionDenied | %s | 当前用户无此操作权限 |
404 | workspaceNotExist | %s | 知识库不存在 |
500 | systemError | %s | 服务繁忙,请稍后重试 |
500 | unknownError | Unknown Error | 未知错误 |
503 | operationTimeout | %s | 请求超时 |