选择应用类型
企业内部应用开发

获取节点新版SDK

更新于 2023-06-06

接口调用量说明钉钉标准版接口累计可调用次数为1万次/月,当前接口会消耗调用次数。若该调用量无法满足需求,你可升级钉钉专业版(Open API调用量50万次/月)钉钉专属版(Open API调用量500万次/月)扩容调用次数。
获取节点。

接口功能介绍

调用本接口,根据操作者unionId和节点id,获取单个节点信息。示例如下:

权限

要调用此API,需要以下权限之一。

应用类型

是否支持

权限

API Explorer调试

企业内部应用支持知识库节点读权限API Explorer
第三方企业应用支持知识库节点读权限API Explorer
第三方个人应用暂不支持知识库节点读权限暂不支持

请求方法

Loading...

Header参数

名称

类型

是否必填

描述

x-acs-dingtalk-access-token

String

调用该接口的访问凭证。

Path参数

名称

类型

是否必填

描述

nodeId

String

节点id(节点dentryUuid):

  • 企业内部应用,可通过调用获取知识库列表接口,获取返回参数rootNodeId字段。

  • 第三方企业应用,可通过调用获取知识库列表接口,获取返回参数rootNodeId字段。

Query参数

名称

类型

是否必填

描述

withStatisticalInfo

Boolean

是否获取统计信息:

  • true:获取
  • false:不获取
说明

默认值false。

withPermissionRole

Boolean

是否获取权限信息:

  • true:获取
  • false:不获取
说明

默认值false。

operatorId

String

操作人unionId。

返回参数

名称

类型

描述

node

Object

节点。

nodeId

String

节点id(dentryUuid)。

workspaceId

String

知识库id(spaceUuid)。

name

String

名称。

size

Long

大小。

type

String

类型,枚举值:

  • FILE:文件
  • FOLDER:文件夹

category

String

类别,枚举值:

  • ALIDOC:钉钉文档
  • DOCUMENT:本地文档
  • IMAGE:图片
  • VIDEO:视频
  • AUDIO:音频
  • ARCHIVE:归档文件
  • OTHER:其他类型

extension

String

后缀。

url

String

访问url。

creatorId

String

创建者userId。

modifierId

String

修改者userId。

createTime

String

创建时间。

modifiedTime

String

修改时间。

hasChildren

Boolean

是否有子节点。

statisticalInfo

Object

统计信息。

wordCount

Long

字数。

permissionRole

String

当前用户对知识库节点的权限角色,枚举值:

  • OWNER:拥有者
  • MANAGER:管理者
  • EDITOR:编辑者
  • DOWNLOADER:可查看下载者
  • READER:仅可查看者
  • NONE:无权限者

示例

请求示例

Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...

返回示例

Loading...

错误码

HttpCode

错误码

错误信息

说明

400

paramError

%s

参数错误

403

permissionDenied

%s

当前用户无此操作权限

404

nodeNotExist

%s

节点不存在

500

systemError

%s

服务繁忙,请稍后重试

500

unknownError

Unknown Error

未知错误

503

operationTimeout

%s

请求超时

点击纠错