Common data structures

DentryModel

Name	Type	Example	Description
contentType	String	alidoc	Content type. - alidoc: DingTalk Docs - link: shortcut - archive: compressed package - document: file
createdTime	Long	1663912334000	Created timestamp, in milliseconds.
updatedTime	Long	1663912334000	Updated timestamp, in milliseconds.
creator	Object		Creator information.
unionId	String	chyxxxxx	The unionId of the creator.
name	String	Xiaoding	The name of the creator.
dentryId	String	4BYmxxxxx	Node ID.
spaceId	String	4BYmaKexxxxx	Knowledge Base ID.
docKey	String	LAJdlxxxxx	The docKey of the document, used to identify a DingTalk Docs document. Note Returned only when the content type is alidoc.
space	SpaceModel		Knowledge Base information.
dentryUuid	String	m0Xwxxxxx	The globally unique identifier of the node.
dentryType	String	file	Node type. - file: file - folder: folder.
extension	String	adoc	File extension. Note Returned only for files.
name	String	DingTalk Docs.adoc	Node name.
url	String	https://xxx.yy	The access URL of the node.
path	String	Test Organization/Test Knowledge Base/abc	The path of the node.
hasChildren	Boolean	false	Whether the node has child nodes.
updater	Object		Last modified by information.
unionId	String	abc	The unionId of the last modifier.
name	String	abc	The name of the last modifier.
linkSourceInfo	LinkSourceInfo		The original data information that a shortcut node points to.
visitorInfo	Object		Permissions and other information of the visitor on the current node.
spaceActions	Array of String	PUBLIC_SHARE_SPACE,GET_SPACE	The action list of the space. - PUBLIC_SHARE_SPACE: publish the Knowledge Base publicly - HANDOVER_WORKSPACE: transfer the space - UPDATE_SPACE: update the basic information of the space - GET_SPACE: query the basic information of the space - GET_SPACE_SECURITY: query the security settings of the space - DELETE_SPACE: permanently delete the space - MANAGE_SPACE_SECURITY: manage the security settings of the space - GET_SPACE_MEMBER: query space users - MANAGE_SPACE_PIN: manage space pinning - USE_SPACE_TEMPLATE: create using a space template - RECYCLE_SPACE: archive the space - GET_SPACE_TEMPLATE: query and preview the space template - RECOVER_SPACE: recover the space - MANAGE_SPACE_TEMPLATE: manage the space template - MANAGE_SPACE_MEMBER: manage space users - RENAME_SPACE: rename the space
dentryActions	Array of String	COPY_DENTRY, GET_DENTRY_MEMBER	The action list of the node. - GET_DENTRY: query the basic information of the node - LIST_CHILD: list child nodes - CREATE_CHILD: create child nodes - RENAME_DENTRY: rename the node - MOVE_DENTRY: move the node - COPY_DENTRY: copy the node - RECYCLE_DENTRY: recycle the node - RECOVER_DENTRY: recover the node - DELETE_DENTRY: delete the node - GET_DENTRY_MEMBER: get the user list of the node - MANAGE_DENTRY_MEMBER: manage the users of the node - PREVIEW: preview the document - CONTENT_COPY: copy content - DOWNLOAD_ATTACHMENT: download attachments, images, and other resources within the document - EXPORT: export to other formats - EXPORT_IMAGE: export as a long image - UPLOAD_ATTACHMENT: upload attachments, images, and other resources within the document - EDIT: edit the document - READ_HISTORY: view history versions - EDIT_HISTORY: edit history versions - SAVE_AS: save as - SAVE_AS_TEMPLATE: save as a template - LINK_SHARE: share via link or card - PUBLIC_SHARE: share publicly - CHANGE_PERMISSION_MODE: change the permission mode - TEMPORARY_SHARE_NODE: temporarily share the node - DOWNLOAD: download - UPLOAD: upload - SAVE_AS_QUICK_LINK: save as a shortcut - SEND_COPY_FILE: send a copy - CLOUD_PRINT: cloud print - MANAGE_SECURITY_SETTING: manage security settings - UPLOAD_FOLDER: upload folder - IMPORT: import - IMPORT_FOLDER: import folder
roleCode	String	5	The access role of the current user for this space. - 0: no permission - 1: view only - 2: view/download - 3: edit - 4: manage - 5: owner

DentryVO

Data structure of a Knowledge Base node.

Name	Type	Example	Description
contentType	String	alidoc	Content type. - alidoc: DingTalk Docs - link: shortcut - archive: compressed package - document: file
createdTime	Long	1663912334000	Created timestamp, in milliseconds.
updatedTime	Long	1663912334000	Updated timestamp, in milliseconds.
creator	Object		Creator information.
unionId	String	chyxxxxx	The unionId of the creator.
name	String	Xiaoding	The name of the creator.
dentryId	String	4BYmaNxxxxx	Node ID.
spaceId	String	4BYxxxxx	Knowledge Base ID.
docKey	String	LAJdl6xxxxx	The docKey of the document, used to identify a DingTalk Docs document. Note Returned only when the content type is alidoc.
space	SpaceModel		Knowledge Base information.
dentryUuid	String	cdefg	The globally unique identifier of the node.
dentryType	String	file	Node type. - file: file - folder: folder
extension	String	adoc	File extension.
name	String	DingTalk Docs.adoc	Node name.
url	String	https://xxx.yy	The access URL of the node.
path	String	Test Organization/Test Knowledge Base/abc	The path of the node.
hasChildren	Boolean	false	Whether the node has child nodes.
updater	Object		Last modified by information.
unionId	String	xhyxxxxx	The unionId of the last modifier.
name	String	Xiaoding	The name of the last modifier.
linkSourceInfo	LinkSourceInfo		The original data information that a shortcut node points to.
visitorInfo	Object		Permissions and other information of the visitor on the current node.
spaceActions	Array of String	PUBLIC_SHARE_SPACE,GET_SPACE	The action list of the space. - PUBLIC_SHARE_SPACE: publish the Knowledge Base publicly - HANDOVER_WORKSPACE: transfer the space - UPDATE_SPACE: update the basic information of the space - GET_SPACE: query the basic information of the space - GET_SPACE_SECURITY: query the security settings of the space - DELETE_SPACE: permanently delete the space - MANAGE_SPACE_SECURITY: manage the security settings of the space - GET_SPACE_MEMBER: query space users - MANAGE_SPACE_PIN: manage space pinning - USE_SPACE_TEMPLATE: create using a space template - RECYCLE_SPACE: archive the space - GET_SPACE_TEMPLATE: query and preview the space template - RECOVER_SPACE: recover the space - MANAGE_SPACE_TEMPLATE: manage the space template - MANAGE_SPACE_MEMBER: manage space users - RENAME_SPACE: rename the space
dentryActions	Array of String	COPY_DENTRY, GET_DENTRY_MEMBER	The action list of the node. - GET_DENTRY: query the basic information of the node - LIST_CHILD: list child nodes - CREATE_CHILD: create child nodes - RENAME_DENTRY: rename the node - MOVE_DENTRY: move the node - COPY_DENTRY: copy the node - RECYCLE_DENTRY: recycle the node - RECOVER_DENTRY: recover the node - DELETE_DENTRY: delete the node - GET_DENTRY_MEMBER: get the user list of the node - MANAGE_DENTRY_MEMBER: manage the users of the node - PREVIEW: preview the document - CONTENT_COPY: copy content - DOWNLOAD_ATTACHMENT: download attachments, images, and other resources within the document - EXPORT: export to other formats - EXPORT_IMAGE: export as a long image - UPLOAD_ATTACHMENT: upload attachments, images, and other resources within the document - EDIT: edit the document - READ_HISTORY: view history versions - EDIT_HISTORY: edit history versions - SAVE_AS: save as - SAVE_AS_TEMPLATE: save as a template - LINK_SHARE: share via link or card - PUBLIC_SHARE: share publicly - CHANGE_PERMISSION_MODE: change the permission mode - TEMPORARY_SHARE_NODE: temporarily share the node - DOWNLOAD: download - UPLOAD: upload - SAVE_AS_QUICK_LINK: save as a shortcut - SEND_COPY_FILE: send a copy - CLOUD_PRINT: cloud print - MANAGE_SECURITY_SETTING: manage security settings - UPLOAD_FOLDER: upload folder - IMPORT: import - IMPORT_FOLDER: import folder
roleCode	String	5	The access role of the current user for this space. - 0: no permission - 1: view only - 2: view/download - 3: edit - 4: manage - 5: owner

LinkSourceInfo

The original data information that a link points to.

Name	Type	Example	Description
id	String	abc	The ID of the source file associated with the shortcut (unique within the space).
spaceId	String	def	The ID of the space to which the source file associated with the shortcut belongs.
linkType	Long	0	Shortcut type. - 0: general shortcut - 1: Quick Meeting shortcut - 2: log shortcut - 3: Quick Meeting 2.0 shortcut
extension	String	docx	The extension of the source file associated with the shortcut.
iconUrl	Object		Icon information for non-general shortcuts.
small	String	def	The highlighted icon when selected.
line	String	gh	The default table of contents icon.

OpenActionModel

Data structure of action information.

Name	Type	Example	Description
name	String	sky	The name of the operator.
timestamp	Long	273829092	Action timestamp.

SpaceModel

Data structure of a Knowledge Base.

Name	Type	Example	Description
id	String	n9XJxxxxx	Knowledge Base ID.
name	String	Test Knowledge Base	Knowledge Base name.
type	Integer	1	Knowledge Base type.
url	String	https://docs.dingtalk.io/i/spaces/n9XJ\\\\\\\*Xy/overview	The access URL of the Knowledge Base.
owner	Object		The owner of the Knowledge Base.
unionId	String	qXExxxxx	The unionId of the user.
name	String	Xiaoding	The name of the user.
visitorInfo	Object		Permissions and other information of the visitor on the current Knowledge Base.
spaceActions	Array of String	GET_SPACE	The action list of the space. - PUBLIC_SHARE_SPACE: publish the Knowledge Base publicly - HANDOVER_WORKSPACE: transfer the space - UPDATE_SPACE: update the basic information of the space - GET_SPACE: query the basic information of the space - GET_SPACE_SECURITY: query the security settings of the space - DELETE_SPACE: permanently delete the space - MANAGE_SPACE_SECURITY: manage the security settings of the space - GET_SPACE_MEMBER: query space users - MANAGE_SPACE_PIN: manage space pinning - USE_SPACE_TEMPLATE: create using a space template - RECYCLE_SPACE: archive the space - GET_SPACE_TEMPLATE: query and preview the space template - RECOVER_SPACE: recover the space - MANAGE_SPACE_TEMPLATE: manage the space template - MANAGE_SPACE_MEMBER: manage space users - RENAME_SPACE: rename the space
dentryActions	Array of String	GET_DENTRY	The action list of the node. - GET_DENTRY: query the basic information of the node - LIST_CHILD: list child nodes - CREATE_CHILD: create child nodes - RENAME_DENTRY: rename the node - MOVE_DENTRY: move the node - COPY_DENTRY: copy the node - RECYCLE_DENTRY: recycle the node - RECOVER_DENTRY: recover the node - DELETE_DENTRY: delete the node - GET_DENTRY_MEMBER: get the user list of the node - MANAGE_DENTRY_MEMBER: manage the users of the node - PREVIEW: preview the document - CONTENT_COPY: copy content - DOWNLOAD_ATTACHMENT: download attachments, images, and other resources within the document - EXPORT: export to other formats - EXPORT_IMAGE: export as a long image - UPLOAD_ATTACHMENT: upload attachments, images, and other resources within the document - EDIT: edit the document - READ_HISTORY: view history versions - EDIT_HISTORY: edit history versions - SAVE_AS: save as - SAVE_AS_TEMPLATE: save as a template - LINK_SHARE: share via link or card - PUBLIC_SHARE: share publicly - CHANGE_PERMISSION_MODE: change the permission mode - TEMPORARY_SHARE_NODE: temporarily share the node - DOWNLOAD: download - UPLOAD: upload - SAVE_AS_QUICK_LINK: save as a shortcut - SEND_COPY_FILE: send a copy - CLOUD_PRINT: cloud print - MANAGE_SECURITY_SETTING: manage security settings - UPLOAD_FOLDER: upload folder - IMPORT: import - IMPORT_FOLDER: import folder
roleCode	String	3	Permissions. - 0: no permission - 1: view only - 2: view/download - 3: edit - 4: manage - 5: owner
recentList	Array of DentryModel		The three most recently edited documents in the Knowledge Base.
iconVO	Object		Knowledge Base icon.
type	String	url	Icon type.
icon	String	https://img.alicdn.com/imgextra/i1/O1xxxxx.png	The URL of the icon.
cover	String	https://img.alicdn.com/imgextra/i1/O1xxxxx.png	The URL of the cover.
description	String	This is the description	Knowledge Base description.

SpaceVO

Data structure of a Knowledge Base.

Name	Type	Example	Description
id	String	n9XJxxxxx	Knowledge Base ID.
name	String	Test Knowledge Base	Knowledge Base name.
type	Integer	1	Knowledge Base type.
url	String	https://docs.dingtalk.io/i/spaces/n9XJ\\\\\\\*Xy/overview	The access URL of the Knowledge Base.
owner	Object		The owner of the Knowledge Base.
unionId	String	qXExxxxx	The unionId of the user.
name	String	Xiaoding	The name of the user.
visitorInfo	Object		Permissions and other information of the visitor on the current Knowledge Base.
spaceActions	Array of String	GET_SPACE	The action list of the space. - PUBLIC_SHARE_SPACE: publish the Knowledge Base publicly - HANDOVER_WORKSPACE: transfer the space - UPDATE_SPACE: update the basic information of the space - GET_SPACE: query the basic information of the space - GET_SPACE_SECURITY: query the security settings of the space - DELETE_SPACE: permanently delete the space - MANAGE_SPACE_SECURITY: manage the security settings of the space - GET_SPACE_MEMBER: query space users - MANAGE_SPACE_PIN: manage space pinning - USE_SPACE_TEMPLATE: create using a space template - RECYCLE_SPACE: archive the space - GET_SPACE_TEMPLATE: query and preview the space template - RECOVER_SPACE: recover the space - MANAGE_SPACE_TEMPLATE: manage the space template - MANAGE_SPACE_MEMBER: manage space users - RENAME_SPACE: rename the space
dentryActions	Array of String	GET_DENTRY	The action list of the node. - GET_DENTRY: query the basic information of the node - LIST_CHILD: list child nodes - CREATE_CHILD: create child nodes - RENAME_DENTRY: rename the node - MOVE_DENTRY: move the node - COPY_DENTRY: copy the node - RECYCLE_DENTRY: recycle the node - RECOVER_DENTRY: recover the node - DELETE_DENTRY: delete the node - GET_DENTRY_MEMBER: get the user list of the node - MANAGE_DENTRY_MEMBER: manage the users of the node - PREVIEW: preview the document - CONTENT_COPY: copy content - DOWNLOAD_ATTACHMENT: download attachments, images, and other resources within the document - EXPORT: export to other formats - EXPORT_IMAGE: export as a long image - UPLOAD_ATTACHMENT: upload attachments, images, and other resources within the document - EDIT: edit the document - READ_HISTORY: view history versions - EDIT_HISTORY: edit history versions - SAVE_AS: save as - SAVE_AS_TEMPLATE: save as a template - LINK_SHARE: share via link or card - PUBLIC_SHARE: share publicly - CHANGE_PERMISSION_MODE: change the permission mode - TEMPORARY_SHARE_NODE: temporarily share the node - DOWNLOAD: download - UPLOAD: upload - SAVE_AS_QUICK_LINK: save as a shortcut - SEND_COPY_FILE: send a copy - CLOUD_PRINT: cloud print - MANAGE_SECURITY_SETTING: manage security settings - UPLOAD_FOLDER: upload folder - IMPORT: import - IMPORT_FOLDER: import folder
roleCode	String	1	Permissions. - 0: no permission - 1: view only - 2: view/download - 3: edit - 4: manage - 5: owner
iconVO	Object		Knowledge Base icon information.
type	String	1	Icon type.
icon	String	https://img.alicdn.com/imgextra/i1/xxxxx.png	Icon.
cover	String	https://img.alicdn.com/imgextra/i1/xxxxx.png	Cover.
description	String	This is the description	Knowledge Base description.

API calling guide

Authentication & authorization

Contacts

Calendar

Conferencing

AI Table

Docs & files

IM

DentryModel

DentryVO

LinkSourceInfo

OpenActionModel

SpaceModel

SpaceVO

​DentryModel

​DentryVO

​LinkSourceInfo

​OpenActionModel

​SpaceModel

​SpaceVO

DentryModel

DentryVO

LinkSourceInfo

OpenActionModel

SpaceModel

SpaceVO