共用方式為

NetDocuments

NetDocuments 是一項雲內容管理服務，適用於各種規模的企業，可以隨時隨地安全地創建、存儲、管理和共享其文檔工作。

此連接器適用於以下產品和區域：

服務 Class Regions
副駕駛工作室 標準 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
邏輯應用程式 標準 所有 Logic Apps 區域， 但下列區域除外：
     - Azure Government 區域
     - Azure 中國區域
     - 美國國防部 （DoD）
Power Apps 標準 除下列區域外的所有 Power Apps 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
Power Automate（自動化服務） 標準 除下列區域外的所有 Power Automate 區域 ：
     - 美國政府 （GCC）
     - 美國政府（海灣合作委員會高中）
     - 由 21Vianet 營運的中國雲
     - 美國國防部 （DoD）
連絡人​​
URL https://support.netdocuments.com/hc/en-us
連接器中繼資料
Publisher NetDocuments 軟件公司
網站 https://www.netdocuments.com/
隱私策略 https://www.netdocuments.com/privacy-policy/

正在建立連線

連接器支援下列驗證類型：
預設值 建立連線的參數。 所有區域 不可共享

預設

適用：所有地區

建立連線的參數。

這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
區域 字串 您的網絡文檔所在的區域。 對

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 100 60 秒

動作

出庫文件

簽出文件
刪除子查詢表項目

刪除子查詢表項目
刪除存放庫群組

刪除存放庫群組
刪除文件

刪除文件
刪除查閱表格項目

刪除查閱表格項目
刪除資料夾

刪除資料夾
創建 CollabSpace

建立新的 CollabSpace
取得使用者機櫃清單

取得使用者檔案櫃
取得使用者資訊

取得使用者的相關資訊
取得內閣群組

將所有群組新增至檔案櫃
取得子查詢資料表專案

取得子查詢資料表專案
取得存放庫使用者

取得存放庫使用者
取得存放庫群組

取得存放庫群組
取得存放庫記錄

取得存放庫記錄
取得存放庫資訊

取得存放庫資訊
取得容器內容

取得所選容器的內容
取得工作區資訊

取得工作區資訊
取得或建立工作區 （具有單一屬性）

取得或建立工作區 （具有單一屬性）
取得或建立工作區 （具有父屬性和子屬性）

取得或建立工作區 （具有父屬性和子屬性）
取得文件內容

擷取文件
取得文件版本

取得文件版本
取得文件設定檔

取得文件的相關資訊
取得未隱藏的內閣群組存取權限

取得未隱藏的內閣群組存取權限
取得查閱資料表項目或搜尋子資料表項目

取得查閱資料表項目或搜尋子資料表項目
取得機櫃自訂屬性

取得機櫃自訂屬性
取得機櫃設定

取得機櫃設定
取得機櫃資訊

取得機櫃資訊
取得目前的使用者資訊

取得目前使用者的相關資訊，不需要識別碼
取得群組成員資格

取得群組成員資格
取得群組資訊

取得群組資訊
取得資料夾項目

擷取資料夾的內容，包括文件和子資料夾
在檔案櫃中新增或移除群組

將群組新增至檔案櫃和預設存取權限
將使用者新增至存放庫或從存放庫移除使用者

將使用者新增至存放庫或從存放庫移除使用者
將文件歸檔或取消歸檔到資料夾

將資料夾中的項目歸檔，或從資料夾中取消歸檔項目。
建立使用者

在存放庫中建立使用者
建立存放庫群組

建立存放庫群組
建立安全連結

產生任何人都可以存取的文件連結
建立或更新子查詢表格項目

建立或更新子查詢表格項目
建立或更新查閱資料表項目

建立或更新查閱資料表項目
建立文件

建立新文件
建立文件的新版本

建立文件的新版本
建立機櫃外部群組

建立機櫃外部群組
建立資料夾

建立新資料夾
搜尋一或多個機櫃

搜尋一或多個機櫃
搜尋查閱表格項目

搜尋查閱表格項目
搜尋機櫃並修改 ACL

搜尋機櫃並修改 ACL
新增或移除群組成員

新增或移除群組成員
更新文件

更新文件的內容
檔歷程記錄

擷取對文件所採取的動作清單
簽入文件

入庫出庫文件
解除鎖定文件

Unock 文件
追蹤資料夾

將新內容新增至資料夾時接收警示
重新命名文件

重新命名文件
重新命名資料夾

重新命名資料夾
重新整理工作區

重新整理工作區
鎖定文件

鎖定文件
鎖定文件版本

鎖定文件版本
關注文檔

文件更新時接收警示

出庫文件

作業識別碼：
CheckOutDoc

簽出文件

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。
評論
 comment string

評論
下載文件
 download boolean

傳回文件內容。
下載版本
 version string

指定應下載哪個版本的內容。 預設為正式版。
新增至最近
 addToRecent boolean

新增至最近

刪除子查詢表項目

作業識別碼：
DeleteChildEntry

刪除子查詢表項目

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 repositoryID True string

（以CA-開頭）
子屬性ID
 childAttributeID True string

（刪除前導的“10”）
父索引鍵
 parentID True string

父索引鍵
子金鑰
 childID True string

子金鑰

傳回

名稱 路徑 類型 Description
count
 count integer

刪除存放庫群組

作業識別碼：
DeleteRepositoryGroup

刪除存放庫群組

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 repositoryID True string

（以CA-開頭）
群組識別碼
 groupID True string

（以 UG- 開頭）

刪除文件

作業識別碼：
DeleteDoc

刪除文件

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。
永久刪除
 permanent boolean

表示應該永久刪除文件，而不是移至 [刪除的郵件]。

刪除查閱表格項目

作業識別碼：
DeleteLookupEntry

刪除查閱表格項目

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 repositoryID True string

（以CA-開頭）
屬性 ID
 attributeID True string

（刪除前導的“10”）
Key
 parentID True string

Key

傳回

名稱 路徑 類型 Description
count
 count integer

刪除資料夾

作業識別碼：
DeleteFolder

刪除資料夾

參數

名稱 機碼 必要 類型 Description
資料夾 ID
 id True string

12 位數資料夾 ID。
永久刪除
 permanent boolean

表示應該永久刪除資料夾，而不是移至 [刪除的郵件]。 資料夾的內容 （包括後代子資料夾） 將不會永久刪除。
刪除資料夾內容
 deleteContents boolean

指出已刪除資料夾 （以及任何子資料夾） 中的文件也應該刪除，而不是簡單地取消歸檔。

創建 CollabSpace

作業識別碼：
CreateCollabSpace

建立新的 CollabSpace

參數

名稱 機碼 必要 類型 Description
工作區識別碼
 workspaceID True string

工作區識別碼
CollabSpace 名稱
 name True string

CollabSpace 名稱
Description
 description string

Description

傳回

名稱 路徑 類型 Description
Id
 Id string
環境網址
 EnvUrl string

取得使用者機櫃清單

作業識別碼：
GetUserCabinets

取得使用者檔案櫃

傳回

名稱 路徑 類型 Description
array of object
識別碼
 id string
isCollaborationSpaces已啟用
 isCollaborationSpacesEnabled string
名稱
 name string
repositoryId
 repositoryId string
repositoryName （儲存庫名稱）
 repositoryName string
wsAttrNum
 wsAttrNum integer
wsOrgAttrNum
 wsOrgAttrNum integer

取得使用者資訊

作業識別碼：
GetUserInfo

取得使用者的相關資訊

參數

名稱 機碼 必要 類型 Description
使用者識別碼
 id True string

NetDocuments 指派的使用者 ID。
機櫃 ID
 cabGuid string

（以NG-開頭）

傳回

名稱 路徑 類型 Description
顯示名稱
 displayName string
電子郵件
 email email
識別碼
 id string
組織
 organization string
isRepository成員
 isRepositoryMember boolean
primary內閣
 primaryCabinet string
排序查找依據
 sortLookupBy string
外部
 external boolean

取得內閣群組

作業識別碼：
GetCabinetGroups

將所有群組新增至檔案櫃

參數

名稱 機碼 必要 類型 Description
機櫃 ID
 cabinetID True string

（以NG-開頭）

傳回

名稱 路徑 類型 Description
array of object
Id
 Id string
名稱
 Name string
External
 External boolean
隱藏
 Hidden boolean

取得子查詢資料表專案

作業識別碼：
GetChildEntry

取得子查詢資料表專案

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 repositoryID True string

（以CA-開頭）
子屬性ID
 childAttributeID True string

（刪除前導的“10”）
父索引鍵
 parentID True string

父索引鍵
子金鑰
 childID True string

子金鑰

取得存放庫使用者

作業識別碼：
GetRepositoryUsers

取得存放庫使用者

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 repositoryID True string

（以 CA-開頭）

傳回

名稱 路徑 類型 Description
array of object
顯示名稱
 displayName string
電子郵件
 email string
外部
 external boolean
識別碼
 id string
最後登入
 lastLogin string
已註冊
 registered string

取得存放庫群組

作業識別碼：
GetRepositoryGroups

取得存放庫群組

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 repositoryID True string

（以CA-開頭）
Filter
 $filter string

（有關篩選條件，請參閱文件）
結果數目
 $top string

（預設為 5,000。最多 10,000 個）
Paging
 paging boolean

（以頁面為單位返回結果，默認值為 false）
分頁權杖
 $skiptoken string

（出於分頁目的，先前呼叫傳回為「下一個」）
回程資訊
 returnInfo string

all 都會傳回群組名稱。 預設值為空白，僅傳回 ID

傳回

名稱 路徑 類型 Description
array of string

取得存放庫記錄

作業識別碼：
GetRepositoryLog

取得存放庫記錄

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 repositoryID True string

（以 CA-開頭）
開始日期/時間
 start string

（預設為 30 天，格式為 yyyy-MM-dd 或 yyyy-MM-ddThh：mm：ssZ）
結束日期/時間
 end string

（格式與開始相同，預設為今天）
日誌類型
 Logtype True string

日誌類型

取得存放庫資訊

作業識別碼：
GetRepositoryInformation

取得存放庫資訊

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 repositoryID True string

（以 CA-開頭）

取得容器內容

作業識別碼：
GetContainerContents

取得所選容器的內容

參數

名稱 機碼 必要 類型 Description
容器識別碼
 containerID True string

容器識別碼
要返回的信息
 select True string

（查看文件以了解退貨格式）
要傳回的結果數目 （預設為 50）
 top integer

（每頁最多500張）
用於分頁結果的權杖
 skiptoken string

用於分頁結果的權杖
訂購方式
 orderby string

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

取得工作區資訊

作業識別碼：
GetWorkspaceInformation

取得工作區資訊

參數

名稱 機碼 必要 類型 Description
工作區識別碼
 workspaceID True string

工作區識別碼

取得或建立工作區 （具有單一屬性）

作業識別碼：
CreateWorkspaceSingle

取得或建立工作區 （具有單一屬性）

參數

名稱 機碼 必要 類型 Description
機櫃 ID
 cabinetID True string

（以NG-開頭）
唯一價值
 parentID True string

用來定義機櫃中工作區的唯一值。

傳回

名稱 路徑 類型 Description
識別碼
 standardAttributes.id string

取得或建立工作區 （具有父屬性和子屬性）

作業識別碼：
CreateWorkspaceParentChild

取得或建立工作區 （具有父屬性和子屬性）

參數

名稱 機碼 必要 類型 Description
機櫃 ID
 cabinetID True string

（以NG-開頭）
父值
 parentID True string

用來定義機櫃中工作區的父值。
子值
 childID True string

用來定義機櫃中工作區的子值。

傳回

名稱 路徑 類型 Description
識別碼
 standardAttributes.id string

取得文件內容

作業識別碼：
GetDocContent

擷取文件

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。
Base64 編碼？
 base64 boolean

Base64 編碼？

取得文件版本

作業識別碼：
GetDocumentVersions

取得文件版本

參數

名稱 機碼 必要 類型 Description
文件 ID
 documentID True string

12 位數文件 ID。

取得文件設定檔

作業識別碼：
GetDocInfo

取得文件的相關資訊

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。

取得未隱藏的內閣群組存取權限

作業識別碼：
GetCabinetDefaultAccess

取得未隱藏的內閣群組存取權限

參數

名稱 機碼 必要 類型 Description
機櫃 ID
 cabinetID True string

（以NG-開頭）

傳回

名稱 路徑 類型 Description
array of object
治
 administer boolean
cab預設
 cabDefault boolean
編輯
 edit boolean
名稱
 name string
無訪問
 noAccess boolean
主體
 principal string
共享
 share boolean
檢視表
 view boolean

取得查閱資料表項目或搜尋子資料表項目

作業識別碼：
GetLookupEntry

取得查閱資料表項目或搜尋子資料表項目

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 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

排序結果依為

取得機櫃自訂屬性

作業識別碼：
GetCabinetCustomAttributes

取得機櫃自訂屬性

參數

名稱 機碼 必要 類型 Description
機櫃 ID
 cabinetID True string

（以NG-開頭）

傳回

名稱 路徑 類型 Description
array of object
items
 object

取得機櫃設定

作業識別碼：
GetCabinetSettings

取得機櫃設定

參數

名稱 機碼 必要 類型 Description
機櫃 ID
 cabinetID True string

（以NG-開頭）

取得機櫃資訊

作業識別碼：
GetCabinetInformation

取得機櫃資訊

參數

名稱 機碼 必要 類型 Description
機櫃 ID
 cabinetID True string

（以NG-開頭）

取得目前的使用者資訊

作業識別碼：
GetCurrentUserInfo

取得目前使用者的相關資訊，不需要識別碼

參數

名稱 機碼 必要 類型 Description
機櫃 ID
 cabGuid string

（以NG-開頭）

傳回

名稱 路徑 類型 Description
顯示名稱
 displayName string
電子郵件
 email email
識別碼
 id string
組織
 organization string
isRepository成員
 isRepositoryMember boolean
primary內閣
 primaryCabinet string
排序查找依據
 sortLookupBy string
外部
 external boolean

取得群組成員資格

作業識別碼：
GetGroupMembership

取得群組成員資格

參數

名稱 機碼 必要 類型 Description
群組識別碼
 groupID True string

（以 UG- 開頭）

傳回

名稱 路徑 類型 Description
array of object
顯示名稱
 displayName string
識別碼
 id string

取得群組資訊

作業識別碼：
GetGroupInformation

取得群組資訊

參數

名稱 機碼 必要 類型 Description
群組識別碼
 groupID True string

群組 ID （以 UG- 開頭）。
集團內閣成員
 cabMembership boolean

（如果設定為 'true'，則此群組所屬的檔案櫃，以及每個檔案櫃的預設文件存取權限。

傳回

名稱 路徑 類型 Description
外部
 external boolean
隱藏
 hidden boolean
隱藏成員資格
 hideMembership boolean
識別碼
 id string
名稱
 name string
cab會員資格
 cabMembership array of object
識別碼
 cabMembership.id string
名稱
 cabMembership.name string
權利
 cabMembership.rights string

取得資料夾項目

作業識別碼：
GetFldContent

擷取資料夾的內容，包括文件和子資料夾

參數

名稱 機碼 必要 類型 Description
資料夾 ID
 id True string

12 位數資料夾 ID。
要傳回的屬性
 $select string

以逗號分隔的屬性值清單。 如需詳細資訊，請參閱 REST API 文件。

在檔案櫃中新增或移除群組

作業識別碼：
AddToOrRemoveGroupFromCabinet

將群組新增至檔案櫃和預設存取權限

參數

名稱 機碼 必要 類型 Description
機櫃 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） - 僅適用於新增。

將使用者新增至存放庫或從存放庫移除使用者

作業識別碼：
AddOrRemoveUserRepository

將使用者新增至存放庫或從存放庫移除使用者

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 repositoryID True string

（以 CA-開頭）
新增或移除使用者
 action True string

新增或移除使用者
使用者識別碼
 member True string

使用者識別碼
使用者是外部的
 external True boolean

使用者是外部的
刪除使用者 （如果已聯合）
 deleteIfFederated boolean

（只適用於移除時）

將文件歸檔或取消歸檔到資料夾

作業識別碼：
FileFolder

將資料夾中的項目歸檔，或從資料夾中取消歸檔項目。

參數

名稱 機碼 必要 類型 Description
資料夾 ID
 id True string

12 位數資料夾 ID。
文件 ID
 item True string

12 位數文件 ID。
歸檔或取消歸檔
 action True string

歸檔或取消歸檔

建立使用者

作業識別碼：
CreateUser

在存放庫中建立使用者

參數

名稱 機碼 必要 類型 Description
用戶名稱
 username True email

（與使用者的電子郵件地址相同）
名字
 displayFirstName True string

名字
中間名
 displayMiddleName string

中間名
姓氏
 displayLastName True string

姓氏
電子郵件地址
 email True email

電子郵件地址
使用者是外部的
 external True boolean

（只適用於新增）
傳送歡迎電子郵件
 sendWelcome True boolean

傳送歡迎電子郵件
存放庫標識碼
 repository True string

（以 CA-開頭）

傳回

名稱 路徑 類型 Description
顯示名稱
 displayName string
電子郵件
 email email
識別碼
 id string
外部
 external boolean

建立存放庫群組

作業識別碼：
CreateRepositoryGroup

建立存放庫群組

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 repositoryID True string

（以CA-開頭）
群組名稱
 name True string

群組名稱
External
 external True boolean

External
隱藏在清單中
 hidden True boolean

隱藏在清單中
隱藏成員資格
 hideMembership True boolean

隱藏成員資格

傳回

名稱 路徑 類型 Description
外部
 external boolean
隱藏
 hidden boolean
隱藏成員資格
 hideMembership boolean
識別碼
 id string
名稱
 name string

建立安全連結

作業識別碼：
CreateSecuredLink

產生任何人都可以存取的文件連結

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。
安全鏈結的密碼
 password string

根據機櫃配置，密碼可能是可選的或強制性的。
安全連結的到期日。
 expirationdate string

輸入格式：yyyy-MM-dd。
文件版本
 version string

要共用的文件版本。 如果為空，則將共享正式版。
下載文件
 download boolean

如果為true，則收件者可以下載文件。
通知我
 notifyme boolean

如果為true，請在存取安全鏈結時通知寄件者。
鎖定文件
 lock boolean

或者，鎖定文件的所選版本。 這需要編輯權限。

傳回

名稱 路徑 類型 Description
檢視表
 standardAttributes.view string
下載
 standardAttributes.download string

建立或更新子查詢表格項目

作業識別碼：
CreateChildEntry

建立或更新子查詢表格項目

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 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
強制權限
 force_permissions True boolean
View
 view True boolean
Edit
 edit True boolean
Share
 share True boolean
管理
 administer True boolean
沒有存取權
 noAccess True boolean
機櫃預設值
 cabDefault True boolean
校長
 principal True string

（使用者或群組 ID）

傳回

名稱 路徑 類型 Description
count
 count integer

建立或更新查閱資料表項目

作業識別碼：
CreateEntry

建立或更新查閱資料表項目

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 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
強制權限
 force_permissions True boolean
View
 view True boolean
Edit
 edit True boolean
Share
 share True boolean
管理
 administer True boolean
沒有存取權
 noAccess True boolean
機櫃預設值
 cabDefault True boolean
校長
 principal True string

（使用者或群組 ID）

傳回

名稱 路徑 類型 Description
count
 count integer

建立文件

作業識別碼：
CreateDocument

建立新文件

參數

名稱 機碼 必要 類型 Description
目的地
 destination True string

資料夾、篩選器或工作區的 12 位數 ID 或 EnvID。
文件內容
 file True file

將檔案名稱加上副檔名放在隨附的檔案名稱欄位中。
新增至最近
 addToRecent boolean

新增至最近
文件設定檔
 profile string

設定文件設定檔 （JSON 格式）

傳回

名稱 路徑 類型 Description
識別碼
 id string
副檔名
 extension string
名稱
 name string

建立文件的新版本

作業識別碼：
NewVersion

建立文件的新版本

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。
文件擴展
 extension string

請勿包括前導句點。
版本說明
 version_description string

版本說明
新版本名稱
 verName string

新版本名稱
製作正式版
 official boolean

如果未設定此參數，新版本將不是正式版本。
新增至最近使用的文件
 addToRecent boolean

新增至最近使用的文件
來源版本號碼
 srcVer string

如果從舊版複製內容，則要複製文件的哪個版本。
創建為顛覆
 allocatesubversion boolean

建立為 Subversion 而不是完整版本。
新版本文件內容
 body binary

新版本的內容，如果不是複製其他版本或正式版。

傳回

名稱 路徑 類型 Description
latest版本編號
 latestVersionNumber integer
新版本
 newVer integer
newVersionLabel
 newVersionLabel string
官方Ver
 officialVer integer
官方VerName
 officialVerName string
versions
 versions integer

建立機櫃外部群組

作業識別碼：
CreateCabinetExternalGroup

建立機櫃外部群組

參數

名稱 機碼 必要 類型 Description
機櫃 ID
 cabinetID True string

（以NG-開頭）
群組名稱
 name True string

群組名稱
群組選項
 options string

群組選項
機櫃預設存取權
 access string

機櫃預設存取權
CollabSpace ID
 collaborationSpaceId string

（要使其成為 CollabSpace 外部群組）
CollabSpace 訪問權限
 collaborationspaceaccess string

CollabSpace 訪問權限
最上層工作區屬性值
 topwsattributegroupkey string

（適用於一般檔案櫃外部群組，若要將群組與特定的頂層工作區屬性值建立關聯）

傳回

名稱 路徑 類型 Description
類型
 Type integer
Id
 Id string
名稱
 Name string
選項
 Options string
存取權
 Access string

建立資料夾

作業識別碼：
CreateFolder

建立新資料夾

參數

名稱 機碼 必要 類型 Description
資料夾名稱
 name True string

資料夾名稱。
父 ID
 parent string

新資料夾父容器的 12 位數 ID 或 EnvID。
機櫃 ID
 cabinet string

（以NG-開頭）如果在父系中指定資料夾或工作區 ID，則可以省略。

傳回

名稱 路徑 類型 Description
識別碼
 standardAttributes.id string
名稱
 standardAttributes.name string

搜尋一或多個機櫃

作業識別碼：
SearchCabinets

搜尋一或多個機櫃

參數

名稱 機碼 必要 類型 Description
櫥櫃
 cabinets True string

（逗號分隔）
Query
 q True string

（檢閱查詢格式的檔）
要返回的信息
 select True string

（查看文件以了解退貨格式）
訂購方式
 orderby string

（格式：field#|desc 或 field#|asc）
要傳回的結果數目 （預設為 50）
 top integer

（每頁最多500張）
要略過的結果數
 skip integer

要略過的結果數
用於分頁結果的權杖
 skiptoken string

用於分頁結果的權杖

搜尋查閱表格項目

作業識別碼：
SearchLookupEntries

搜尋查閱表格項目

參數

名稱 機碼 必要 類型 Description
存放庫標識碼
 repositoryID True string

（以CA-開頭）
屬性 ID
 attributeID True string

（刪除前導的“10”）
Filter
 $filter string

（請參閱文件以取得可用的篩選器）
要擷取的欄位
 $select string

（包括以逗號分隔的清單：「key」、「description」、「parent」、「hold」、「closed」、「defaulting」、「type」、「user」和/或「access」）
要略過的相符記錄數目
 $skip integer

（這在檢索多個結果區塊時使用。
要傳回的記錄數目上限
 $top integer

要傳回的記錄數目上限

傳回

名稱 路徑 類型 Description
行
 rows array of object
預設
 rows.defaulting string
描述
 rows.description string
持
 rows.hold boolean
Key
 rows.key string
關閉
 rows.closed string
訪問
 rows.access string

搜尋機櫃並修改 ACL

作業識別碼：
SearchCabinetModifyACLs

搜尋機櫃並修改 ACL

參數

名稱 機碼 必要 類型 Description
機櫃 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 = 不傳送，失敗 = 僅在失敗時傳送）

新增或移除群組成員

作業識別碼：
AddOrRemoveGroupMember

新增或移除群組成員

參數

名稱 機碼 必要 類型 Description
群組識別碼
 groupID True string

（以 UG- 開頭）
新增或移除使用者
 action True string

新增或移除使用者
使用者識別碼
 member True string

（必須已經是存放庫的成員。

更新文件

作業識別碼：
UpdateDocument

更新文件的內容

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。
文件擴展
 extension string

只有在變更文件副檔名時才需要。 請勿包括前導句點。
Base64 編碼？
 base64 boolean

Base64 編碼？
更新文件內容
 body True byte

文件的內容。

檔歷程記錄

作業識別碼：
GetDocHistory

擷取對文件所採取的動作清單

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。

簽入文件

作業識別碼：
CheckinDoc

入庫出庫文件

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。
文件擴展
 extension string

請勿包括前導句點。
文件內容
 file file

多部分形式的文件。
新增至最近
 addToRecent boolean

新增至使用者最近的文件清單。

解除鎖定文件

作業識別碼：
UnockDocument

Unock 文件

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

文件 ID

追蹤資料夾

作業識別碼：
FollowFolder

將新內容新增至資料夾時接收警示

參數

名稱 機碼 必要 類型 Description
資料夾 ID
 id True string

12 位數資料夾 ID。
收件者
 recipients True string

一或多個以分號分隔的有效電子郵件地址。 重複項被忽略。
發送
 send string

哪個類別的使用者應該收到警示。

重新命名文件

作業識別碼：
RenameDocument

重新命名文件

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。
新名稱
 name True string

重新命名資料夾

作業識別碼：
RenameFolder

重新命名資料夾

參數

名稱 機碼 必要 類型 Description
資料夾 ID
 id True string

12 位數資料夾 ID。
新名稱
 name True string

重新整理工作區

作業識別碼：
RefreshWorkspace

重新整理工作區

參數

名稱 機碼 必要 類型 Description
工作區識別碼
 workspaceID True string

工作區識別碼

鎖定文件

作業識別碼：
LockDocument

鎖定文件

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

文件 iD
評論
 comment string

評論

鎖定文件版本

作業識別碼：
LockDocumentVersion

鎖定文件版本

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。
文件版本
 version True integer

文件版本
版本說明
 description string

版本說明

關注文檔

作業識別碼：
FollowDocument

文件更新時接收警示

參數

名稱 機碼 必要 類型 Description
文件 ID
 id True string

12 位數文件 ID。
收件者
 recipients True string

一或多個以分號分隔的有效電子郵件地址。 重複項被忽略。
發送
 send string

哪個類別的使用者應該收到警示。

觸發程序

搜尋櫃

搜尋指定的機櫃

搜尋櫃

作業識別碼：
SearchCab

搜尋指定的機櫃

參數

名稱 機碼 必要 類型 Description
機櫃 ID
 cabId True string

（以NG-開頭）
搜尋條件
 q True string

使用與 NetDocuments Web 介面相同的格式和運算子。
訂購方式
 $orderby string

訂購方式
結果數目上限
 $top string

介於 1 到 500 之間的整數。 預設值為 100。
要傳回的屬性
 $select string

以逗號分隔的屬性值清單。 如需詳細資訊，請參閱 REST API 文件。