通过

NetDocuments

NetDocuments 是一种云内容管理服务，适用于各种规模的企业，可以随时随地安全地创建、存储、管理和共享其文档工作。

此连接器在以下产品和区域中可用：

服务 Class 区域
Copilot Studio 标准 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部（DoD）
Power Apps 标准 除以下各项外的所有 Power Apps 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
Power Automate 标准 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
联系人​​
URL https://support.netdocuments.com/hc/en-us
连接器元数据
发布者 NetDocuments Software， Inc.
网站 https://www.netdocuments.com/
隐私策略 https://www.netdocuments.com/privacy-policy/

正在创建连接

连接器支持以下身份验证类型：
默认 用于创建连接的参数。 所有区域 不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
区域 字符串 你的网络文档所在的区域。 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

关注文件夹

将新内容添加到文件夹时接收警报
关注文档

更新文档时接收警报
创建 CollabSpace

创建新的 CollabSpace
创建内阁外部组

创建内阁外部组
创建存储库组

创建存储库组
创建安全链接

生成可供任何人访问的文档的链接
创建或更新子查阅表格项

创建或更新子查阅表格项
创建或更新查阅表格项

创建或更新查阅表格项
创建文件夹

创建新文件夹
创建文档

创建新文档
创建文档的新版本

创建新版本的文档
创建用户

在存储库中创建用户
删除子查阅表格项

删除子查阅表格项
删除存储库组

删除存储库组
删除文件夹

删除文件夹
删除文档

删除文档
删除查阅表格条目

删除查阅表格条目
刷新工作区

刷新工作区
在内阁中添加或删除组

将组添加到内阁和默认访问权限
将用户添加到存储库或从存储库中删除用户

将用户添加到存储库或从存储库中删除用户
搜索一个或多个内阁

搜索一个或多个内阁
搜索内阁并修改 ACL

搜索内阁并修改 ACL
搜索查阅表格条目

搜索查阅表格条目
文件或取消文件文档到文件夹

在文件夹中提交项目，或者从文件夹中取消存档项目。
文档历史记录

检索对文档执行的作列表
更新文档

更新文档的内容
添加或删除组成员

添加或删除组成员
签入文档

签入签出的文档
签出文档

签出文档
获取内阁信息

获取内阁信息
获取内阁组

获取添加到内阁中的所有组
获取内阁自定义属性

获取内阁自定义属性
获取内阁设置

获取内阁设置
获取子查阅表格项

获取子查阅表格项
获取存储库信息

获取存储库信息
获取存储库日志

获取存储库日志
获取存储库用户

获取存储库用户
获取存储库组

获取存储库组
获取容器内容

获取所选容器的内容
获取工作区信息

获取工作区信息
获取当前用户信息

获取有关当前用户的信息，不需要 ID
获取或创建工作区（具有单个属性）

获取或创建工作区（具有单个属性）
获取或创建工作区（具有父属性和子属性）

获取或创建工作区（具有父属性和子属性）
获取文件夹项

检索文件夹的内容，包括文档和子文件夹
获取文档内容

检索文档
获取文档版本

获取文档版本
获取文档配置文件

获取有关文档的信息
获取未隐藏的内阁组访问权限

获取未隐藏的内阁组访问权限
获取查阅表格条目或搜索子表项

获取查阅表格条目或搜索子表项
获取用户信息

获取有关用户的信息
获取用户内阁列表

获取用户内阁
获取组信息

获取组信息
获取组成员身份

获取组成员身份
解锁文档

取消停靠文档
重命名文件夹

重命名文件夹
重命名文档

重命名文档
锁定文档

锁定文档
锁定文档版本

锁定文档版本

关注文件夹

操作 ID:
FollowFolder

将新内容添加到文件夹时接收警报

参数

名称 密钥 必需 类型 说明
文件夹 ID
 id True string

12 位文件夹 ID。
收件人
 recipients True string

一个或多个有效的电子邮件地址，用分号分隔。 忽略重复项。
发送
 send string

应接收警报的用户类别。

关注文档

操作 ID:
FollowDocument

更新文档时接收警报

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。
收件人
 recipients True string

一个或多个有效的电子邮件地址，用分号分隔。 忽略重复项。
发送
 send string

应接收警报的用户类别。

创建 CollabSpace

操作 ID:
CreateCollabSpace

创建新的 CollabSpace

参数

名称 密钥 必需 类型 说明
工作区 ID
 workspaceID True string

工作区 ID
CollabSpace 名称
 name True string

CollabSpace 名称
Description
 description string

Description

返回

名称 路径 类型 说明
Id
 Id string
EnvUrl
 EnvUrl string

创建内阁外部组

操作 ID:
CreateCabinetExternalGroup

创建内阁外部组

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabinetID True string

（从NG开始）
组名称
 name True string

组名称
组选项
 options string

组选项
内阁默认访问
 access string

内阁默认访问
CollabSpace ID
 collaborationSpaceId string

（将此设置为 CollabSpace-external 组）
CollabSpace 访问
 collaborationspaceaccess string

CollabSpace 访问
顶部工作区属性值
 topwsattributegroupkey string

（对于常规内阁外部组;将组与特定的顶级工作区属性值相关联）

返回

名称 路径 类型 说明
类型
 Type integer
Id
 Id string
Name
 Name string
选项
 Options string
Access
 Access string

创建存储库组

操作 ID:
CreateRepositoryGroup

创建存储库组

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
组名称
 name True string

组名称
External
 external True boolean

External
隐藏在列表中
 hidden True boolean

隐藏在列表中
隐藏成员身份
 hideMembership True boolean

隐藏成员身份

返回

名称 路径 类型 说明
外部
 external boolean
隐藏
 hidden boolean
hideMembership
 hideMembership boolean
id
 id string
姓名
 name string

创建安全链接

操作 ID:
CreateSecuredLink

生成可供任何人访问的文档的链接

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。
安全链接的密码
 password string

根据内阁配置，密码可能是可选的，也可能是必需的。
安全链接的到期日期。
 expirationdate string

输入格式：yyyy-MM-dd。
文档版本
 version string

要共享的文档版本。 如果为空，则共享官方版本。
下载文档
 download boolean

如果为 true，则收件人可能会下载文档。
通知我
 notifyme boolean

如果为 true，请在访问安全链接时通知发件人。
锁定文档
 lock boolean

（可选）锁定所选文档版本。 这需要编辑权限。

返回

名称 路径 类型 说明
视图
 standardAttributes.view string
下载
 standardAttributes.download string

创建或更新子查阅表格项

操作 ID:
CreateChildEntry

创建或更新子查阅表格项

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
子属性 ID
 childAttributeID True string

（删除前导“10”）
父参数
 parentID True string

父参数
子密钥
 childID True string

子密钥
Description
 description string
类型
 defaulting string
诉讼保留
 hold boolean
关闭日期
 closed string

格式“/Date（从 1970 年 1 月 1 日起的米利斯数量+UTC”，例如：“/Date（1582261200000-0500）/”
筛选的权限
 filtered_permissions True boolean
强制 permssions
 force_permissions True boolean
查看
 view True boolean
Edit
 edit True boolean
分享
 share True boolean
管理员
 administer True boolean
无访问权限
 noAccess True boolean
内阁默认值
 cabDefault True boolean
校长
 principal True string

（用户或组 ID）

返回

名称 路径 类型 说明
计数
 count integer

创建或更新查阅表格项

操作 ID:
CreateEntry

创建或更新查阅表格项

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
属性 ID
 attributeID True string

（删除前导“10”）
Key
 parentID True string

Key
Description
 description string
类型
 defaulting string
诉讼保留
 hold boolean
关闭日期
 closed string

格式“/Date（从 1970 年 1 月 1 日起的米利斯数量+UTC”，例如：“/Date（1582261200000-0500）/”
筛选的权限
 filtered_permissions True boolean
强制 permssions
 force_permissions True boolean
查看
 view True boolean
Edit
 edit True boolean
分享
 share True boolean
管理员
 administer True boolean
无访问权限
 noAccess True boolean
内阁默认值
 cabDefault True boolean
校长
 principal True string

（用户或组 ID）

返回

名称 路径 类型 说明
计数
 count integer

创建文件夹

操作 ID:
CreateFolder

创建新文件夹

参数

名称 密钥 必需 类型 说明
文件夹名称
 name True string

文件夹名称。
父 ID
 parent string

新文件夹的父容器的 12 位 ID 或 EnvID。
内阁 ID
 cabinet string

（从NG开始）如果在父级中指定了文件夹或工作区 ID，则可以省略该 ID。

返回

名称 路径 类型 说明
id
 standardAttributes.id string
姓名
 standardAttributes.name string

创建文档

操作 ID:
CreateDocument

创建新文档

参数

名称 密钥 必需 类型 说明
目的地
 destination True string

文件夹、筛选器或工作区的 12 位 ID 或 EnvID。
文档内容
 file True file

将文件名加扩展名放在随附的文件名字段中。
添加到最近
 addToRecent boolean

添加到最近
文档配置文件
 profile string

设置文档配置文件（JSON 格式）

返回

名称 路径 类型 说明
id
 id string
扩展
 extension string
姓名
 name string

创建文档的新版本

操作 ID:
NewVersion

创建新版本的文档

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。
文档扩展
 extension string

不要包括前导期。
版本说明
 version_description string

版本说明
新版本的名称
 verName string

新版本的名称
制作官方版本
 official boolean

如果未设置此参数，则新版本将不会是官方版本。
添加到最近使用的文档
 addToRecent boolean

添加到最近使用的文档
源版本号
 srcVer string

如果从以前的版本复制内容，则为要复制的文档版本。
创建为颠覆
 allocatesubversion boolean

创建为颠覆而不是完整版本。
新版本文档内容
 body binary

新版本的内容（如果未复制其他版本或官方版本）。

返回

名称 路径 类型 说明
latestVersionNumber
 latestVersionNumber integer
newVer
 newVer integer
newVersionLabel
 newVersionLabel string
officialVer
 officialVer integer
officialVerName
 officialVerName string
版本
 versions integer

创建用户

操作 ID:
CreateUser

在存储库中创建用户

参数

名称 密钥 必需 类型 说明
用户名
 username True email

（与用户的电子邮件地址相同）
名字
 displayFirstName True string

名字
中间名
 displayMiddleName string

中间名
姓氏
 displayLastName True string

姓氏
电子邮件地址
 email True email

电子邮件地址
用户是外部用户
 external True boolean

（仅适用于添加）
发送欢迎电子邮件
 sendWelcome True boolean

发送欢迎电子邮件
仓库 ID
 repository True string

（从 CA 开始）

返回

名称 路径 类型 说明
displayName
 displayName string
电子邮件
 email email
id
 id string
外部
 external boolean

删除子查阅表格项

操作 ID:
DeleteChildEntry

删除子查阅表格项

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
子属性 ID
 childAttributeID True string

（删除前导“10”）
父参数
 parentID True string

父参数
子密钥
 childID True string

子密钥

返回

名称 路径 类型 说明
计数
 count integer

删除存储库组

操作 ID:
DeleteRepositoryGroup

删除存储库组

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
群组标识符
 groupID True string

（以 UG 开头）

删除文件夹

操作 ID:
DeleteFolder

删除文件夹

参数

名称 密钥 必需 类型 说明
文件夹 ID
 id True string

12 位文件夹 ID。
永久删除
 permanent boolean

指示应永久删除文件夹，而不是移动到“已删除邮件”。 文件夹的内容（包括后代子文件夹）不会永久删除。
删除文件夹内容
 deleteContents boolean

指示应同时删除已删除文件夹（以及任何子文件夹中）中的文档，而不是简单地取消文件。

删除文档

操作 ID:
DeleteDoc

删除文档

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。
永久删除
 permanent boolean

指示应永久删除文档，而不是移动到“已删除邮件”。

删除查阅表格条目

操作 ID:
DeleteLookupEntry

删除查阅表格条目

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
属性 ID
 attributeID True string

（删除前导“10”）
Key
 parentID True string

Key

返回

名称 路径 类型 说明
计数
 count integer

刷新工作区

操作 ID:
RefreshWorkspace

刷新工作区

参数

名称 密钥 必需 类型 说明
工作区 ID
 workspaceID True string

工作区 ID

在内阁中添加或删除组

操作 ID:
AddToOrRemoveGroupFromCabinet

将组添加到内阁和默认访问权限

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabinetID True string

（从NG开始）
添加或删除组
 action True string

添加或删除组
群组标识符
 id True string

组 ID （以 UG 开头）。
查看权限
 view True boolean

查看权限 （V） - 仅适用于添加。
编辑权限
 edit True boolean

编辑权限 （E） - 仅适用于添加。
共享权限
 share True boolean

共享权限 （S） - 仅适用于添加。
管理权限
 administer True boolean

管理权限 （A） - 仅适用于添加。
无访问权限
 noAccess True boolean

无访问权限 （N） - 仅适用于添加。

将用户添加到存储库或从存储库中删除用户

操作 ID:
AddOrRemoveUserRepository

将用户添加到存储库或从存储库中删除用户

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
添加或删除用户
 action True string

添加或删除用户
用户 ID
 member True string

用户 ID
用户是外部用户
 external True boolean

用户是外部用户
删除用户（如果联合）
 deleteIfFederated boolean

（仅适用于删除）

搜索一个或多个内阁

操作 ID:
SearchCabinets

搜索一个或多个内阁

参数

名称 密钥 必需 类型 说明
柜
 cabinets True string

（逗号分隔）
Query
 q True string

（查看查询格式的文档）
要返回的信息
 select True string

（查看返回格式的文档）
订单依据
 orderby string

（格式：field#|desc 或 field#|asc）
要返回的结果数（默认值为 50）
 top integer

（每页最多 500 个）
要跳过的结果数
 skip integer

要跳过的结果数
用于分页结果的令牌
 skiptoken string

用于分页结果的令牌

搜索内阁并修改 ACL

操作 ID:
SearchCabinetModifyACLs

搜索内阁并修改 ACL

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabinetID True string

（从NG开始）
Query
 q True string

（查看查询格式的文档）
修改 ACL 模式
 mode True string

修改 ACL 模式
新建 ACL
 newAcl True string

（查看正确的 json 格式的文档）
电子邮件地址
 email email

（改为向此地址发送通知）
发送完成电子邮件
 completionEmail string

（true = 始终发送（默认值），false = 不发送，失败 = 仅在失败时发送）

搜索查阅表格条目

操作 ID:
SearchLookupEntries

搜索查阅表格条目

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
属性 ID
 attributeID True string

（删除前导“10”）
过滤器
 $filter string

（请参阅可用筛选器的文档）
要检索的字段
 $select string

（包括逗号分隔的列表：“key”、“description”、“parent”、“hold”、“closed”、“defaulting”、“type”、“user”和/或“access”）
要跳过的匹配记录数
 $skip integer

（检索多个结果块时会用到此代码块。
要返回的最大记录数
 $top integer

要返回的最大记录数

返回

名称 路径 类型 说明
行
 rows array of object
违约
 rows.defaulting string
描述
 rows.description string
拿
 rows.hold boolean
关键值
 rows.key string
闭
 rows.closed string
访问
 rows.access string

文件或取消文件文档到文件夹

操作 ID:
FileFolder

在文件夹中提交项目，或者从文件夹中取消存档项目。

参数

名称 密钥 必需 类型 说明
文件夹 ID
 id True string

12 位文件夹 ID。
文档 ID
 item True string

12 位文档 ID。
文件或取消文件
 action True string

文件或取消文件

文档历史记录

操作 ID:
GetDocHistory

检索对文档执行的作列表

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。

更新文档

操作 ID:
UpdateDocument

更新文档的内容

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。
文档扩展
 extension string

仅当更改文档的扩展时才是必需的。 不要包括前导期。
Base64 编码？
 base64 boolean

Base64 编码？
更新的文档内容
 body True byte

文档的内容。

添加或删除组成员

操作 ID:
AddOrRemoveGroupMember

添加或删除组成员

参数

名称 密钥 必需 类型 说明
群组标识符
 groupID True string

（以 UG 开头）
添加或删除用户
 action True string

添加或删除用户
用户 ID
 member True string

（必须是存储库的成员。

签入文档

操作 ID:
CheckinDoc

签入签出的文档

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。
文档扩展
 extension string

不要包括前导期。
文档内容
 file file

多部分形式的文档。
添加到最近
 addToRecent boolean

添加到用户最近的文档列表。

签出文档

操作 ID:
CheckOutDoc

签出文档

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。
注释
 comment string

注释
下载文档
 download boolean

返回文档内容。
要下载的版本
 version string

指定应下载哪个版本的内容。 默认为官方版本。
添加到最近
 addToRecent boolean

添加到最近

获取内阁信息

操作 ID:
GetCabinetInformation

获取内阁信息

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabinetID True string

（从NG开始）

获取内阁组

操作 ID:
GetCabinetGroups

获取添加到内阁中的所有组

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabinetID True string

（从NG开始）

返回

名称 路径 类型 说明
array of object
Id
 Id string
Name
 Name string
External
 External boolean
隐藏
 Hidden boolean

获取内阁自定义属性

操作 ID:
GetCabinetCustomAttributes

获取内阁自定义属性

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabinetID True string

（从NG开始）

返回

名称 路径 类型 说明
array of object
items
 object

获取内阁设置

操作 ID:
GetCabinetSettings

获取内阁设置

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabinetID True string

（从NG开始）

获取子查阅表格项

操作 ID:
GetChildEntry

获取子查阅表格项

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
子属性 ID
 childAttributeID True string

（删除前导“10”）
父参数
 parentID True string

父参数
子密钥
 childID True string

子密钥

获取存储库信息

操作 ID:
GetRepositoryInformation

获取存储库信息

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）

获取存储库日志

操作 ID:
GetRepositoryLog

获取存储库日志

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
开始日期/时间
 start string

（默认值为 30 天;格式为 yyyy-MM-dd 或 yyyy-MM-ddThh：mm：ssZ）
结束日期/时间
 end string

（与开始格式相同;默认为今天）
日志类型
 Logtype True string

日志类型

获取存储库用户

操作 ID:
GetRepositoryUsers

获取存储库用户

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）

返回

名称 路径 类型 说明
array of object
displayName
 displayName string
电子邮件
 email string
外部
 external boolean
id
 id string
lastLogin
 lastLogin string
注册
 registered string

获取存储库组

操作 ID:
GetRepositoryGroups

获取存储库组

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
过滤器
 $filter string

（请参阅筛选器条件的文档）
结果数
 $top string

（默认值为 5,000。最大值为 10,000）
Paging
 paging boolean

（以页面返回结果;默认值为 false）
分页令牌
 $skiptoken string

（出于分页目的;前一次调用返回为“next”）
返回信息
 returnInfo string

所有将返回组名称。 默认值为空，仅返回 ID

返回

名称 路径 类型 说明
array of string

获取容器内容

操作 ID:
GetContainerContents

获取所选容器的内容

参数

名称 密钥 必需 类型 说明
容器 ID
 containerID True string

容器 ID
要返回的信息
 select True string

（查看返回格式的文档）
要返回的结果数（默认值为 50）
 top integer

（每页最多 500 个）
用于分页结果的令牌
 skiptoken string

用于分页结果的令牌
订单依据
 orderby string

（格式：field#|desc 或 field#|asc）

获取工作区信息

操作 ID:
GetWorkspaceInformation

获取工作区信息

参数

名称 密钥 必需 类型 说明
工作区 ID
 workspaceID True string

工作区 ID

获取当前用户信息

操作 ID:
GetCurrentUserInfo

获取有关当前用户的信息，不需要 ID

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabGuid string

（从NG开始）

返回

名称 路径 类型 说明
displayName
 displayName string
电子邮件
 email email
id
 id string
组织
 organization string
isRepositoryMember
 isRepositoryMember boolean
primaryCabinet
 primaryCabinet string
sortLookupBy
 sortLookupBy string
外部
 external boolean

获取或创建工作区（具有单个属性）

操作 ID:
CreateWorkspaceSingle

获取或创建工作区（具有单个属性）

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabinetID True string

（从NG开始）
唯一值
 parentID True string

用于定义内阁中工作区的唯一值。

返回

名称 路径 类型 说明
id
 standardAttributes.id string

获取或创建工作区（具有父属性和子属性）

操作 ID:
CreateWorkspaceParentChild

获取或创建工作区（具有父属性和子属性）

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabinetID True string

（从NG开始）
父值
 parentID True string

用于在内阁中定义工作区的父值。
子值
 childID True string

用于在内阁中定义工作区的子值。

返回

名称 路径 类型 说明
id
 standardAttributes.id string

获取文件夹项

操作 ID:
GetFldContent

检索文件夹的内容，包括文档和子文件夹

参数

名称 密钥 必需 类型 说明
文件夹 ID
 id True string

12 位文件夹 ID。
要返回的属性
 $select string

属性值的逗号分隔列表。 有关更多详细信息，请参阅 REST API 文档。

获取文档内容

操作 ID:
GetDocContent

检索文档

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。
Base64 编码？
 base64 boolean

Base64 编码？

获取文档版本

操作 ID:
GetDocumentVersions

获取文档版本

参数

名称 密钥 必需 类型 说明
文档 ID
 documentID True string

12 位文档 ID。

获取文档配置文件

操作 ID:
GetDocInfo

获取有关文档的信息

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。

获取未隐藏的内阁组访问权限

操作 ID:
GetCabinetDefaultAccess

获取未隐藏的内阁组访问权限

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabinetID True string

（从NG开始）

返回

名称 路径 类型 说明
array of object
管理
 administer boolean
cabDefault
 cabDefault boolean
编辑
 edit boolean
姓名
 name string
noAccess
 noAccess boolean
主体
 principal string
共享
 share boolean
视图
 view boolean

获取查阅表格条目或搜索子表项

操作 ID:
GetLookupEntry

获取查阅表格条目或搜索子表项

参数

名称 密钥 必需 类型 说明
仓库 ID
 repositoryID True string

（从 CA 开始）
属性 ID
 attributeID True string

（删除前导“10”。若要返回单个值，请输入父属性 ID，或搜索子项，请输入子属性 ID。
Key
 parentID True string

（若要返回单个值，请输入单个属性的键，或搜索子项，请输入父项的键。
筛选器（仅在搜索时）
 $filter string

（请参阅可用筛选器的文档）
要检索的字段
 $select string

（包括逗号分隔的列表：“key”、“description”、“parent”、“hold”、“closed”、“defaulting”、“type”、“user”和/或“access”）
要跳过的匹配记录数
 $skip integer

（检索多个结果块时会用到此代码块。
要返回的最大记录数
 $top integer

要返回的最大记录数
按以下方式对结果进行排序
 $orderby string

按以下方式对结果进行排序

获取用户信息

操作 ID:
GetUserInfo

获取有关用户的信息

参数

名称 密钥 必需 类型 说明
用户 ID
 id True string

NetDocuments 分配的用户 ID。
内阁 ID
 cabGuid string

（从NG开始）

返回

名称 路径 类型 说明
displayName
 displayName string
电子邮件
 email email
id
 id string
组织
 organization string
isRepositoryMember
 isRepositoryMember boolean
primaryCabinet
 primaryCabinet string
sortLookupBy
 sortLookupBy string
外部
 external boolean

获取用户内阁列表

操作 ID:
GetUserCabinets

获取用户内阁

返回

名称 路径 类型 说明
array of object
id
 id string
isCollaborationSpacesEnabled
 isCollaborationSpacesEnabled string
姓名
 name string
repositoryId
 repositoryId string
repositoryName
 repositoryName string
wsAttrNum
 wsAttrNum integer
wsOrgAttrNum
 wsOrgAttrNum integer

获取组信息

操作 ID:
GetGroupInformation

获取组信息

参数

名称 密钥 必需 类型 说明
群组标识符
 groupID True string

组 ID （以 UG 开头）。
组内阁成员身份
 cabMembership boolean

（如果设置为“true”，则此组是该组的成员，并且将包括每个内阁的默认文档访问权限。

返回

名称 路径 类型 说明
外部
 external boolean
隐藏
 hidden boolean
hideMembership
 hideMembership boolean
id
 id string
姓名
 name string
cabMembership
 cabMembership array of object
id
 cabMembership.id string
姓名
 cabMembership.name string
权利
 cabMembership.rights string

获取组成员身份

操作 ID:
GetGroupMembership

获取组成员身份

参数

名称 密钥 必需 类型 说明
群组标识符
 groupID True string

（以 UG 开头）

返回

名称 路径 类型 说明
array of object
displayName
 displayName string
id
 id string

解锁文档

操作 ID:
UnockDocument

取消停靠文档

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

文档 ID

重命名文件夹

操作 ID:
RenameFolder

重命名文件夹

参数

名称 密钥 必需 类型 说明
文件夹 ID
 id True string

12 位文件夹 ID。
新名称
 name True string

重命名文档

操作 ID:
RenameDocument

重命名文档

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。
新名称
 name True string

锁定文档

操作 ID:
LockDocument

锁定文档

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

文档 iD
注释
 comment string

注释

锁定文档版本

操作 ID:
LockDocumentVersion

锁定文档版本

参数

名称 密钥 必需 类型 说明
文档 ID
 id True string

12 位文档 ID。
文档版本
 version True integer

文档版本
版本说明
 description string

版本说明

触发器

搜索内阁

搜索指定的内阁

搜索内阁

操作 ID:
SearchCab

搜索指定的内阁

参数

名称 密钥 必需 类型 说明
内阁 ID
 cabId True string

（从NG开始）
搜索条件
 q True string

使用与 NetDocuments Web 界面中相同的格式和运算符。
订单依据
 $orderby string

订单依据
最大结果数
 $top string

介于 1 和 500 之间的整数。 默认值为 100。
要返回的属性
 $select string

属性值的逗号分隔列表。 有关更多详细信息，请参阅 REST API 文档。