共用方式為

Egnyte

Egnyte 是一項確保您的文件安全、同步且易於共享的服務。 連接到 Egnyte 來管理您的文件。 您可以在 Egnyte 中執行各種操作，例如上傳、更新、取得和刪除檔案。

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

服務 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）
連絡人​​
名稱 Egnyte 支持
URL https://helpdesk.egnyte.com
Email support@egnyte.com
連接器中繼資料
Publisher Egnyte
網站 https://egnyte.com/
隱私策略 https://www.egnyte.com/privacy-policy
類別 通敵;生產力

Egnyte

Egnyte 是一個內容協作平台，可確保您的文件安全、同步且易於共享。 連接到 Egnyte 來管理您的文件。 您可以在 Egnyte 中執行各種操作，例如上傳、移動、下載和刪除文件。

Pre-requisites

要使用連接器，您需要成為 Egnyte 用戶。

支援的動作

連接器支援下列動作：

支援的觸發器

連接器支援下列觸發程式：

  • When a file is locked：此作業會在檔案鎖定時觸發流程
  • When a file is unlocked：此作業會在檔案解除鎖定時觸發流程
  • When a file is updated：此作業會在特定資料夾中更新檔案時觸發流程
  • When a file is created (webhook)：當檔案在特定資料夾中建立時，此作業會觸發流程
  • When a share link is created：此作業會在建立共用連結時觸發流程
  • When a share link is deleted：此作業會在刪除共用連結時觸發流程
  • When the file or folder permission changes：此作業會在檔案或資料夾權限變更時觸發流程
  • When the file or folder metadata changes：此作業會在檔案或資料夾中繼資料變更時觸發流程
  • When a project folder is created：此作業會在建立專案資料夾或將現有資料夾標示為專案資料夾時觸發流程
  • When a folder is unmarked as a project：當資料夾未標示為專案時，此作業會觸發流程
  • When a project is updated：此作業會在專案更新時觸發流程
  • When a workflow is created：此作業會在建立工作流程時觸發流程
  • When a workflow is completed：此作業會在工作流程完成時觸發流程
  • When an approval type workflow is approved：此作業會在核准型別工作流程核准時觸發流程
  • When an approval type workflow is rejected：此作業會在核准型別工作流程遭到拒絕時觸發流程
  • When a group is created：此作業會在建立群組時觸發流程
  • When a group is updated：此作業會在群組更新時觸發流程
  • When a group is deleted：此作業會在刪除群組時觸發流程
  • When a file is created (polling)：此作業會在資料夾中建立新檔案時觸發流程。
  • When a folder is created：此作業會在資料夾中建立子資料夾時觸發流程。
  • When a file is deleted：此作業會在資料夾中刪除檔案時觸發流程。
  • When a folder is deleted：此作業會在資料夾中刪除子資料夾時觸發流程。
  • When a file is renamed：當資料夾中的檔案重新命名時，此作業會觸發流程。
  • When a folder is renamed：當資料夾中的子資料夾重新命名時，此作業會觸發流程。
  • When a file is moved：當檔案在資料夾中移動時，此作業會觸發流程。
  • When a folder is moved：當子資料夾在資料夾中移動時，此作業會觸發流程。
  • When a file is copied：當檔案複製到資料夾中時，此作業會觸發流程。
  • When a folder is copied：當子資料夾複製到資料夾中時，此作業會觸發流程。

節流限制

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

動作

[人工智慧]向 Egnyte Copilot 提問

向平台副駕駛提問，根據您的 Egnyte 網域內的全球內容提供 AI 驅動的回應。 https://developers.egnyte.com/api-docs/read/ai-api#Copilot
[人工智慧]產生文件的摘要

為給定文件產生摘要，根據文件內容提供 AI 驅動的回應。 https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document
[人工智慧]詢問有關文件的問題

提出與給定文件相關的問題，根據文件內容提供 AI 驅動的回應。 https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question
依 ID 刪除使用者

刪除 Egnyte 上的使用者。 深入了解：https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User
依 ID 刪除專案

根據專案的 ID 移除專案。 https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project
依 ID 刪除檔案

使用 ID 刪除檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
依 ID 取得檔案內容

使用 ID 從 Egnyte 擷取檔案內容。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
依 ID 取得檔案資訊

使用檔案 ID 擷取檔案資訊。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
依 ID 取得資料夾資訊

使用 ID 擷取資料夾資訊。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
依 ID 更新使用者

更新單一使用者。 深入了解：https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User
依 ID 更新專案

更新專案的指定屬性，由其識別碼識別。 https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project
依 ID 的深層連結

依 ID 建立檔案或資料夾的深層連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
依 ID 移動檔案

使用檔案 ID 在 Egnyte 中移動檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
依 ID 移動資料夾

使用 ID 移動資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
依 ID 複製資料夾

使用 ID 複製資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
依根資料夾識別碼取得專案

根據專案的根資料夾識別碼擷取專案。 https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder
依檔案ID設定中繼資料

使用檔案識別碼將中繼資料寫入檔案。 https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
依檔案識別碼取得中繼資料

使用檔案識別碼從檔案取得中繼資料。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
依識別碼取得專案

使用 ID 擷取專案。 https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID
依識別碼清除專案

此端點會在專案中起始清除，並選擇性地刪除或停用指定的使用者。 https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project
依資料夾識別碼取得中繼資料

使用資料夾識別碼從資料夾取得中繼資料。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace
依資料夾識別碼設定中繼資料

使用資料夾識別碼將中繼資料寫入資料夾。 https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace
依路徑刪除檔案

使用路徑刪除檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
依路徑刪除資料夾

使用路徑刪除資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
依路徑取得檔案內容

使用路徑從 Egnyte 擷取檔案內容。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File
依路徑取得檔案資訊

使用路徑擷取檔案資訊。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
依路徑取得資料夾資訊

使用路徑檢索資料夾資訊。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation
依路徑的深層連結

依路徑建立檔案或資料夾的深層連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders
依路徑移動檔案

使用 path 在 Egnyte 中移動文件。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
依路徑移動資料夾

使用路徑移動 Egnyte 中的資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder
依路徑複製檔案

使用路徑複製檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
依路徑複製資料夾

使用路徑複製資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
依路徑鎖定檔案

使用路徑鎖定檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
修改資料夾選項

修改資料夾選項，例如描述、連結共用設定、公開連結權限、移動/刪除限制和電子郵件通知偏好設定。 https://developers.egnyte.com/api-docs/read/folder-options-api
共用檔案

在 Egnyte 中共享文件。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
共用資料夾

在 Egnyte 中共享一個文件夾。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
列出所有鏈接

列出除已刪除連結之外的所有連結。 請注意，如果執行此方法的使用者不是管理員，則只會列出使用者建立的連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links
列出所有鏈接 V2

列出所有連結。 請注意，如果執行此方法的使用者不是管理員，則只會列出使用者建立的連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2
刪除中繼資料索引鍵

從現有命名空間刪除中繼資料索引鍵。 https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key
刪除命名空間

刪除指定的命名空間。 https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace
刪除群組

依 ID 刪除群組。 https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group
刪除連結

刪除連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link
取得使用者詳細資料

依 ID 擷取使用者的相關資訊。 深入了解：https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User
取得命名空間

列出在指定命名空間中建立的所有自訂中繼資料索引鍵。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace
取得所有使用者的清單

擷取使用者的相關資訊。 深入了解：https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List
取得所有命名空間

取得網域中所有自訂中繼資料命名空間的清單。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces
取得所有專案

列出網域中的所有專案資料夾。 https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects
取得所有群組的清單

擷取群組清單。 https://developers.egnyte.com/api-docs/read/group-management#List-Groups
取得有效的權限

取得使用者的有效權限。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User
取得群組詳細資料

使用 ID 擷取群組資訊。 https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group
取得資料夾權限

取得資料夾的權限。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions
完整群組更新

覆寫群組的所有屬性。 https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group
將資料夾標示為專案

將現有資料夾標示為專案。 https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project
建立中繼資料金鑰

將中繼資料索引鍵新增至現有命名空間。 https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key
建立使用者

在 Egnyte 建立一個新使用者。 深入了解：https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User
建立命名空間

在 Egnyte 中建立命名空間。 https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace
建立檔案

將檔案上傳至 Egnyte。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File
建立群組

在 Egnyte 中創建一個群組。 https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group
建立資料夾

在 Egnyte 中建立資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder
建立連結

建立連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link
從範本建立專案

從專案資料夾範本建立新專案。 https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template
按 ID 刪除資料夾

使用 ID 刪除資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder
按 ID 複製檔案

使用 ID 複製檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder
按 ID 解鎖文件

使用 ID 解鎖文件。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
按 ID 鎖定檔案

使用 ID 鎖定檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File
按路徑解鎖文件

使用路徑解鎖文件。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File
搜尋 V1

根據檔案名稱、元資料和文字內容尋找儲存在 Egnyte 中的內容。 https://developers.egnyte.com/api-docs/read/search-api#Search-v1
搜尋 V2

尋找具有進階搜尋功能的內容。 https://developers.egnyte.com/api-docs/read/search-api#Search-v2
搜尋中繼資料

尋找具有特定中繼資料欄位或值的項目。 https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata
更新命名空間屬性

更新命名空間屬性。 https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes
更新命名空間索引鍵

更新網域自訂中繼資料的金鑰。 https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys
設定資料夾權限

設定資料夾的權限。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions
部分群組更新

更新群組的特定屬性。 https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group
顯示連結詳細資料

檢視連結的詳細資料。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details

[人工智慧]向 Egnyte Copilot 提問

作業識別碼：
copilotAsk

向平台副駕駛提問，根據您的 Egnyte 網域內的全球內容提供 AI 驅動的回應。 https://developers.egnyte.com/api-docs/read/ai-api#Copilot

參數

名稱 機碼 必要 類型 Description
Question
 question True string

您想問的具體問題
資料夾 ID
 id string

所選資料夾的 ID
檔案項目 ID
 entryId string

所選檔案的項目ID
包含引文
 includeCitations boolean

回應是否應包含引文 （預設為 false）
Role
 role string
訊息內容
 content string

傳回

身體
AICopilotResponse

[人工智慧]產生文件的摘要

作業識別碼：
summarizeDocument

為給定文件產生摘要，根據文件內容提供 AI 驅動的回應。 https://developers.egnyte.com/api-docs/read/ai-api#Summarize-a-Document

參數

名稱 機碼 必要 類型 Description
檔案項目 ID
 entryId True string

檔案特定版本的 ID
Role
 role string
訊息內容
 content string

傳回

身體
AISummaryResponse

[人工智慧]詢問有關文件的問題

作業識別碼：
askDocumentQuestion

提出與給定文件相關的問題，根據文件內容提供 AI 驅動的回應。 https://developers.egnyte.com/api-docs/read/ai-api#Ask-a-Question

參數

名稱 機碼 必要 類型 Description
檔案項目 ID
 entryId True string

檔案特定版本的 ID
Question
 question True string

您想問的具體問題
包含引文
 includeCitations boolean

回應是否應包含引文 （預設為 false）
Role
 role string
訊息內容
 content string

傳回

身體
AIQuestionResponse

依 ID 刪除使用者

作業識別碼：
deleteUser

刪除 Egnyte 上的使用者。 深入了解：https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Delete-Single-User

參數

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

要刪除的使用者 ID

依 ID 刪除專案

作業識別碼：
deleteProjectById

根據專案的 ID 移除專案。 https://developers.egnyte.com/api-docs/read/project-folder-api#Remove-Project

參數

名稱 機碼 必要 類型 Description
專案識別碼
 projectId True string

要刪除之專案的ID

依 ID 刪除檔案

作業識別碼：
deleteFileById

使用 ID 刪除檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

參數

名稱 機碼 必要 類型 Description
檔案標識碼
 id True string

要從 Egnyte 刪除的檔案的唯一識別碼。

傳回

名稱 路徑 類型 Description
父資料夾路徑
 parent_folder_path string

已刪除檔案的父資料夾路徑。

依 ID 取得檔案內容

作業識別碼：
getFileContentById

使用 ID 從 Egnyte 擷取檔案內容。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

參數

名稱 機碼 必要 類型 Description
檔案標識碼
 fileId True string

Egnyte 中檔案的唯一識別碼。

依 ID 取得檔案資訊

作業識別碼：
fileInfoById

使用檔案 ID 擷取檔案資訊。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

參數

名稱 機碼 必要 類型 Description
檔案標識碼
 id True string

Egnyte 中檔案的唯一識別碼。

傳回

身體
FileInfoResponse

依 ID 取得資料夾資訊

作業識別碼：
folderInfoById

使用 ID 擷取資料夾資訊。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

參數

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

Egnyte 中資料夾的唯一識別碼。

傳回

身體
FolderInfoResponse

依 ID 更新使用者

作業識別碼：
updateUser

更新單一使用者。 深入了解：https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Update-Single-User

參數

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

使用者的唯一識別碼
使用者電子郵件
 email string

用戶的電子郵件位址。
名字
 givenName string

使用者的名字。
姓
 familyName string

使用者的姓氏。
Active
 active boolean

使用者是作用中還是非作用中。
傳送邀請
 sendInvite boolean

如果設定為 true，則會傳送邀請電子郵件。 參數不能是此動作唯一修改的參數。
語言
 language string

只有在已為網域啟用語言套件時，才會接受 “language” 參數。
驗證類型
 authType string

使用者的驗證類型。
使用者類型
 userType string

使用者的類型。
Role
 role string

指派給使用者的角色。 僅適用於高級用戶。
IDP 使用者 ID
 idpUserId string

只有在使用者經過SSO驗證且未使用預設使用者對應時才需要
使用者主體名稱
 userPrincipalName string

請勿指定使用者是否未經過 AD 驗證。

傳回

名稱 路徑 類型 Description
使用者識別碼
 id integer

使用者的唯一識別碼
使用者電子郵件
 email string

用戶的電子郵件位址。
姓
 familyName string

使用者的姓氏。
名字
 givenName string

使用者的名字。
Active
 active boolean

使用者是作用中還是非作用中。
傳送邀請
 sendInvite boolean

如果設定為 true，則會傳送邀請電子郵件。
語言
 language string

只有在啟用語言套件時才會接受它。
驗證類型
 authType string

使用者的驗證類型。
使用者類型
 userType string

使用者的類型。
Role
 role string

指派給使用者的角色。 僅適用於高級用戶。
IDP 使用者 ID
 idpUserId string

只有在使用者經過 SSO 驗證時才需要
使用者主體名稱
 userPrincipalName string

請勿指定使用者是否未經過 AD 驗證。

依 ID 更新專案

作業識別碼：
updateProjectById

更新專案的指定屬性，由其識別碼識別。 https://developers.egnyte.com/api-docs/read/project-folder-api#Update-Project

參數

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

資料夾的新名稱。
描述
 description string

資料夾的新描述。
projectId
 projectId True string

項目的標識碼。
自訂專案標識符
 customProjectId string

專案的自訂識別碼。
客戶名稱
 customerName string

與專案相關聯的客戶。
streetAddress1
 streetAddress1 string

街道地址的第一行。
streetAddress2
 streetAddress2 string

街道地址的第二行。
city
 city string

City：
狀態
 state string

州或省。
postalCode
 postalCode string

郵遞區號或郵政編碼。
country
 country string

使用 ISO 3166 GENC 設定檔中的 3 個字元的國家/地區代碼，例如：USA、GBR、POL。
狀態
 status True string

專案的現況。
startDate
 startDate string

ISO 8601 格式的專案開始日期。
完成日期
 completionDate string

ISO 8601 格式的專案預計完成日期。

依 ID 的深層連結

作業識別碼：
deepLinksById

依 ID 建立檔案或資料夾的深層連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

參數

名稱 機碼 必要 類型 Description
Id
 id True string

檔案或資料夾的標識碼
類型
 type True string

連結類型

傳回

名稱 路徑 類型 Description
網址
 url string

深層連結

依 ID 移動檔案

作業識別碼：
moveFileById

使用檔案 ID 在 Egnyte 中移動檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

參數

名稱 機碼 必要 類型 Description
檔案標識碼
 id True string

Egnyte 中檔案的唯一識別碼。
目的地檔案路徑
 destination_path True string

Egnyte 中的目的地檔案路徑。 包括目標檔案名稱。

傳回

名稱 路徑 類型 Description
檔案路徑
 path string

移動檔案的完整路徑。
檔案 ID
 group_id string

要參考整個檔案的 ID。

依 ID 移動資料夾

作業識別碼：
moveFolderById

使用 ID 移動資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

參數

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

Egnyte 中資料夾的唯一識別碼。
目的地資料夾路徑
 destination_path True string

Egnyte 中的目標資料夾路徑。

傳回

名稱 路徑 類型 Description
資料夾路徑
 path string

移動資料夾的完整路徑。
資料夾 ID
 folder_id string

移動資料夾的唯一識別碼。

依 ID 複製資料夾

作業識別碼：
copyFolderById

使用 ID 複製資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

參數

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

要在 Egnyte 中複製的資料夾的唯一識別碼。
目的地資料夾路徑
 destination_path True string

Egnyte 中的目標資料夾路徑。

傳回

名稱 路徑 類型 Description
資料夾路徑
 path string

複製資料夾的完整路徑。
資料夾 ID
 folder_id string

複製資料夾的唯一識別碼。

依根資料夾識別碼取得專案

作業識別碼：
getProjectByRootFolderId

根據專案的根資料夾識別碼擷取專案。 https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-Root-Folder

參數

名稱 機碼 必要 類型 Description
根資料夾的識別碼
 rootFolderId True string

根資料夾的識別碼

傳回

身體
ProjectItem

依檔案ID設定中繼資料

作業識別碼：
setMetadataByFileId

使用檔案識別碼將中繼資料寫入檔案。 https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

參數

名稱 機碼 必要 類型 Description
檔案標識碼
 fileId True string

Egnyte 中檔案的唯一識別碼。
命名空間名稱
 namespaceName True string

命名空間的名稱。
中繼資料索引鍵名稱
 metadataName True string

您要指派值的索引鍵名稱。
中繼資料值
 metadataValue string

要設定的中繼資料值。

依檔案識別碼取得中繼資料

作業識別碼：
getMetadataByFileId

使用檔案識別碼從檔案取得中繼資料。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

參數

名稱 機碼 必要 類型 Description
檔案 ID
 fileId True string

Egnyte 中檔案的唯一識別碼。
命名空間名稱
 namespace True string

命名空間的名稱。

依識別碼取得專案

作業識別碼：
getProjectById

使用 ID 擷取專案。 https://developers.egnyte.com/api-docs/read/project-folder-api#Find-Project-by-ID

參數

名稱 機碼 必要 類型 Description
專案編號
 projectId True string

專案編號

傳回

身體
ProjectItem

依識別碼清除專案

作業識別碼：
cleanupProject

此端點會在專案中起始清除，並選擇性地刪除或停用指定的使用者。 https://developers.egnyte.com/api-docs/read/project-folder-api#Cleanup-Project

參數

名稱 機碼 必要 類型 Description
專案識別碼
 projectId True string

專案識別碼
刪除連結
 deleteLinks True boolean

如果設定為 true，則會刪除專案中所有現有的作用中連結。
usersToDelete
 usersToDelete array of integer

要刪除的使用者 ID 清單。
usersToDisable（使用者停用）
 usersToDisable array of integer

要停用的使用者 ID 清單。

傳回

名稱 路徑 類型 Description
訊息
 message string

依資料夾識別碼取得中繼資料

作業識別碼：
getMetadataByFolderId

使用資料夾識別碼從資料夾取得中繼資料。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Values-for-a-Namespace

參數

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

Egnyte 中資料夾的唯一識別碼。
命名空間名稱
 namespace True string

命名空間的名稱。

依資料夾識別碼設定中繼資料

作業識別碼：
setMetadataByFolderId

使用資料夾識別碼將中繼資料寫入資料夾。 https://developers.egnyte.com/api-docs/read/metadata-api#Set-Values-for-a-Namespace

參數

名稱 機碼 必要 類型 Description
資料夾識別碼
 folderId True string

Egnyte 中資料夾的唯一識別碼。
命名空間名稱
 namespaceName True string

命名空間的名稱。
中繼資料索引鍵名稱
 metadataName True string

您要指派值的索引鍵名稱。
中繼資料值
 metadataValue True string

要設定的中繼資料值。

依路徑刪除檔案

作業識別碼：
deleteFileByPath

使用路徑刪除檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

參數

名稱 機碼 必要 類型 Description
檔案路徑
 path True string

Egnyte 中的檔案路徑，包括目標檔案名稱。

傳回

名稱 路徑 類型 Description
父資料夾路徑
 parent_folder_path string

已刪除檔案的父資料夾路徑

依路徑刪除資料夾

作業識別碼：
deleteFolderByPath

使用路徑刪除資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 path True string

Egnyte 中的資料夾路徑，包括要刪除的目標資料夾名稱。

傳回

名稱 路徑 類型 Description
父資料夾路徑
 parent_folder_path string

已刪除資料夾的父資料夾路徑。

依路徑取得檔案內容

作業識別碼：
getFileContentByPath

使用路徑從 Egnyte 擷取檔案內容。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Download-File

參數

名稱 機碼 必要 類型 Description
檔案路徑
 filePath True string

Egnyte 中檔案的唯一路徑。

依路徑取得檔案資訊

作業識別碼：
fileInfoByPath

使用路徑擷取檔案資訊。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

參數

名稱 機碼 必要 類型 Description
檔案路徑
 path True string

Egnyte 中檔案的唯一路徑。

傳回

身體
FileInfoResponse

依路徑取得資料夾資訊

作業識別碼：
folderInfoByPath

使用路徑檢索資料夾資訊。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 path True string

Egnyte 中資料夾的唯一路徑。

傳回

身體
FolderInfoResponse

依路徑的深層連結

作業識別碼：
deepLinksByPath

依路徑建立檔案或資料夾的深層連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Deep-Links-to-Files-and-Folders

參數

名稱 機碼 必要 類型 Description
路徑
 path True string

檔案或資料夾的路徑

傳回

名稱 路徑 類型 Description
網址
 url string

深層連結

依路徑移動檔案

作業識別碼：
moveFileByPath

使用 path 在 Egnyte 中移動文件。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

參數

名稱 機碼 必要 類型 Description
來源路徑
 path True string

來源檔案的路徑。
目的地檔案路徑
 destination_path True string

Egnyte 中的目標檔案路徑，包括目標檔案名稱。

傳回

名稱 路徑 類型 Description
檔案路徑
 path string

移動檔案的完整路徑。
檔案 ID
 group_id string

要參考整個檔案的 ID。

依路徑移動資料夾

作業識別碼：
moveFolderByPath

使用路徑移動 Egnyte 中的資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Move-File-or-Folder

參數

名稱 機碼 必要 類型 Description
來源路徑
 path True string

來源資料夾的路徑。
目的地資料夾路徑
 destination_path True string

Egnyte 中的目標資料夾路徑。

傳回

名稱 路徑 類型 Description
資料夾路徑
 path string

移動資料夾的完整路徑。
資料夾 ID
 folder_id string

移動資料夾的唯一識別碼。

依路徑複製檔案

作業識別碼：
copyFileByPath

使用路徑複製檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

參數

名稱 機碼 必要 類型 Description
來源檔案
 path True string

Egnyte 中的來源檔案路徑，包括目標檔案名稱。
目標檔案
 destination_path True string

Egnyte 中的目標檔案路徑，包括目標檔案名稱。

傳回

名稱 路徑 類型 Description
檔案路徑
 path string

複製檔案的完整路徑。
檔案 ID
 group_id string

要參考整個檔案的 ID。

依路徑複製資料夾

作業識別碼：
copyFolderByPath

使用路徑複製資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

參數

名稱 機碼 必要 類型 Description
來源資料夾路徑
 path True string

Egnyte 中的來源資料夾路徑。
目的地資料夾路徑
 destination_path True string

Egnyte 中的目標資料夾路徑。

傳回

名稱 路徑 類型 Description
資料夾路徑
 path string

複製資料夾的完整路徑。
資料夾 ID
 folder_id string

複製資料夾的唯一識別碼。

依路徑鎖定檔案

作業識別碼：
lockFileByPath

使用路徑鎖定檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

參數

名稱 機碼 必要 類型 Description
目標檔案路徑
 path True string

Egnyte 中的目標檔案路徑，包括目標檔案名稱。

傳回

名稱 路徑 類型 Description
暫停
 timeout integer

檔案應鎖定的時間 （以秒為單位）。
鎖定令牌
 lock_token string

必須用來解除鎖定檔案的權杖。

修改資料夾選項

作業識別碼：
modifyFolderOptions

修改資料夾選項，例如描述、連結共用設定、公開連結權限、移動/刪除限制和電子郵件通知偏好設定。 https://developers.egnyte.com/api-docs/read/folder-options-api

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 path True string

Egnyte 中資料夾的唯一路徑。
資料夾描述
 folder_description string

資料夾的描述。
允許連結
 allow_links boolean

選擇是否可以共用至此資料夾內的檔案或子資料夾的連結。
公開連結
 public_links string

指定允許的公用連結類型。 可能的值：files_folders、檔案、已停用。
限制移動/刪除
 restrict_move_delete boolean

將移動和刪除作業限制為僅限資料夾擁有者和管理員。
內容更新通知
 content_updates boolean

啟用內容更新的電子郵件通知。
存取內容通知
 content_accessed boolean

啟用已存取內容的電子郵件通知。

傳回

名稱 路徑 類型 Description
名稱
 name string

資料夾的名稱。
上次修改時間
 lastModified integer

資料夾中任何檔案 （但不在子資料夾內） 已修改的最新時間。
資料夾路徑
 path string

資料夾的完整路徑。
資料夾 ID
 folder_id string

資料夾的唯一識別碼。
資料夾描述
 folder_description string

資料夾的描述。
是資料夾
 is_folder boolean

資源是否為資料夾。 真或假
可能的公共鏈接
 public_links string

關於如何設置“允許來自此文件夾的公共鏈接”的文件夾選項設置。
可以刪除或移動
 restrict_move_delete boolean

可以刪除或移動嗎？ T 或 F

共用檔案

作業識別碼：
shareFile

在 Egnyte 中共享文件。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

參數

名稱 機碼 必要 類型 Description
檔案路徑
 path True string

Egnyte 中的檔案路徑，包括要共用的目標檔案名稱。

傳回

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

Links
連結ID
 links.id string

連結的 ID。
連結網址
 links.url string

連結的完整網址。
收件者
 links.recipients array of string

連結傳送至的有效電子郵件地址陣列。
檔案路徑
 path string

共用檔案的完整路徑。
類型
 type string

連結的類型，檔案、資料夾或上傳。
可及性
 accessibility string

連結可存取者、任何人、密碼、網域或收件者之一。
存取時通知創作者
 notify boolean

存取連結時，連結建立者是否會收到電子郵件通知。
指的是版本
 link_to_current boolean

這是當前版本嗎？ T 或 F
到期日
 expiry_date string

連結到期的日期和時間。
建立日期
 creation_date string

建立連結的日期和時間。
作者
 created_by string

建立連結之使用者的使用者名稱。

共用資料夾

作業識別碼：
shareFolder

在 Egnyte 中共享一個文件夾。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 path True string

Egnyte 中的資料夾路徑，要共用。

傳回

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

Links
連結ID
 links.id string

連結的 ID。
連結網址
 links.url string

連結的完整網址。
收件者
 links.recipients array of string

連結傳送至的有效電子郵件地址陣列。
資料夾路徑
 path string

共用資料夾的完整路徑。
類型
 type string

連結的類型，檔案、資料夾或上傳。
可及性
 accessibility string

連結可存取者、任何人、密碼、網域或收件者之一。
存取時通知創作者
 notify boolean

存取連結時，連結建立者是否會收到電子郵件通知。
指的是版本
 link_to_current boolean

這是當前版本嗎？ T 或 F
到期日
 expiry_date string

連結到期的日期和時間。
建立日期
 creation_date string

建立連結的日期和時間。
由...創建
 created_by string

建立連結之使用者的使用者名稱。

列出所有鏈接

作業識別碼：
listLinks

列出除已刪除連結之外的所有連結。 請注意，如果執行此方法的使用者不是管理員，則只會列出使用者建立的連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links

參數

名稱 機碼 必要 類型 Description
路徑
 path string

列出由完整路徑指定的檔案或資料夾的連結。
用戶名稱
 username string

列出此使用者建立的連結。
創建於之前
 createdBefore string

列出在指定日期之前建立的連結 （ISO-8601 或 YYYY-MM-DD）。
創建時間
 createdAfter string

列出在指定日期之後建立的連結 （ISO-8601 或 YYYY-MM-DD）。
類型
 type string

僅篩選為「檔案」或「資料夾」項目。
可及性
 accessibility string

選取協助工具類型
Offset
 offset string

所要求初始記錄的從 0 開始的索引。
計數 （預設會傳回 500 個專案）
 count string

限制每頁的條目數量。

傳回

名稱 路徑 類型 Description
標識
 ids array of string

包含此使用者可以看到的網域所有連結 ID 的陣列。
Offset
 offset number

所要求初始記錄的從 0 開始的索引。
Count
 count number

傳回的專案計數。 如果未指定此欄位，則計數值將為 0。
總計數
 total_count number

網域中使用者可見的連結數目。

列出所有鏈接 V2

作業識別碼：
listLinksV2

列出所有連結。 請注意，如果執行此方法的使用者不是管理員，則只會列出使用者建立的連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#List-Links-v2

參數

名稱 機碼 必要 類型 Description
路徑
 path string

列出由完整路徑指定的檔案或資料夾的連結。
用戶名稱
 username string

列出此使用者建立的連結。
創建於之前
 createdBefore string

列出在指定日期之前建立的連結 （ISO-8601 或 YYYY-MM-DD）。
創建時間
 createdAfter string

列出在指定日期之後建立的連結 （ISO-8601 或 YYYY-MM-DD）。
類型
 type string

僅篩選為「檔案」或「資料夾」項目。
可及性
 accessibility string

選取協助工具類型
Offset
 offset string

所要求初始記錄的從 0 開始的索引。
計數 （預設會傳回 500 個專案）
 count string

限制每頁的條目數量。

傳回

名稱 路徑 類型 Description
Links
 links array of object

一個陣列，其中包含此使用者可以在任何指定範圍內看到的網域所有連結的完整 json 資訊
路徑
 links.path string

目標資源的絕對路徑，可以是檔案或資料夾。
類型
 links.type string

連結類型，檔案、資料夾或上傳
可及性
 links.accessibility string

連結可存取者、任何人、密碼、網域或收件者之一。
保護
 links.protection string

如果檔案（或資料夾）連結的「PREVIEW」，則是檔案（資料夾）的僅預覽連結，否則為「NONE」
收件者
 links.recipients array of string

連結傳送至的有效電子郵件地址陣列。
通知
 links.notify boolean

布林值，用於在存取連結時是否會透過電子郵件通知連結建立者。
網址
 links.url string

連結的完整網址
Id
 links.id string

連結的 ID
鏈接到當前
 links.link_to_current boolean

布林值，以確定連結是否一律會參考目前版本的檔案。 僅適用於檔案連結。
建立日期
 links.creation_date string

建立連結的日期和時間
由...創建
 links.created_by string

建立連結之使用者的使用者名稱
資源識別碼
 links.resource_id string

相關聯資源的 ID （如果是檔案連結） 為群組 ID，如果是資料夾或上傳連結，則為資料夾 ID
過期點擊次數
 links.expiry_clicks number

到期前連結上留下的點擊次數。 只有在連結要透過點擊過期時，才會顯示此欄位
上次訪問時間
 links.last_accessed string

上次存取連結的日期和時間。 只有在連結至少被存取一次時，才會顯示此欄位
到期日
 links.expiry_date string

連結到期的日期和時間。 只有在連結要到期的日期時，才會顯示此欄位
Count
 count number

傳回網域中使用者可見的連結數目

刪除中繼資料索引鍵

作業識別碼：
deleteMetadataKey

從現有命名空間刪除中繼資料索引鍵。 https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Metadata-Key

參數

名稱 機碼 必要 類型 Description
命名空間名稱
 namespace True string

Egnyte 中命名空間的唯一識別碼。
名稱
 key True string

您要刪除的金鑰名稱。
強制刪除
 force boolean

即使使用中繼資料索引鍵，也會刪除。

刪除命名空間

作業識別碼：
deleteNamespace

刪除指定的命名空間。 https://developers.egnyte.com/api-docs/read/metadata-api#Delete-Namespace

參數

名稱 機碼 必要 類型 Description
命名空間名稱
 namespace True string

Egnyte 中命名空間的唯一識別碼。
強制刪除
 force boolean

即使使用命名空間，也要刪除

刪除群組

作業識別碼：
deleteGroup

依 ID 刪除群組。 https://developers.egnyte.com/api-docs/read/group-management#Delete-a-Group

參數

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

群組 ID。

刪除連結

作業識別碼：
deleteLink

刪除連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Delete-a-Link

參數

名稱 機碼 必要 類型 Description
連結識別碼
 linkId True string

LinkId

取得使用者詳細資料

作業識別碼：
getUser

依 ID 擷取使用者的相關資訊。 深入了解：https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-Single-User

參數

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

使用者的ID

傳回

用戶資訊

身體
UserInfoResponse

取得命名空間

作業識別碼：
getNamespace

列出在指定命名空間中建立的所有自訂中繼資料索引鍵。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-Namespace

參數

名稱 機碼 必要 類型 Description
命名空間名稱
 namespace True string

Egnyte 中命名空間的唯一識別碼。

傳回

身體
NamespaceItem

取得所有使用者的清單

作業識別碼：
getUserList

擷取使用者的相關資訊。 深入了解：https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Get-User-List

參數

名稱 機碼 必要 類型 Description
開始索引
 startIndex integer

第一個搜尋結果的從 1 開始的索引。
Count
 count integer

指定每頁所需的搜尋結果數目上限。
Filter
 filter string

可讓您要求使用者子集。 請參閱「關於」區段中的檔案。

傳回

取得使用者清單回應

身體
UserListResponse

取得所有命名空間

作業識別碼：
getAllNamespaces

取得網域中所有自訂中繼資料命名空間的清單。 https://developers.egnyte.com/api-docs/read/metadata-api#Get-All-Namespaces

傳回

response
array of NamespaceItem

取得所有專案

作業識別碼：
getAllProjects

列出網域中的所有專案資料夾。 https://developers.egnyte.com/api-docs/read/project-folder-api#Get-All-Projects

傳回

response
array of ProjectItem

取得所有群組的清單

作業識別碼：
listGroups

擷取群組清單。 https://developers.egnyte.com/api-docs/read/group-management#List-Groups

參數

名稱 機碼 必要 類型 Description
開始索引
 startIndex integer

所要求起始記錄的以 1 為基礎的索引 （整數 ≥ 1）。
Count
 count integer

每頁的條目數（最少 1，最多 100）
Filter
 filter string

可讓您要求群組的子集。 這些術語不區分大小寫

傳回

名稱 路徑 類型 Description
總結果
 totalResults integer

符合查詢的結果總數。
每頁項目數
 itemsPerPage integer

傳回的結果數目。
開始索引
 startIndex integer

目前結果集中第一個結果的從 1 開始的索引。
resources
 resources array of object
群組識別碼
 resources.id string

全域唯一群組識別碼。
群組名稱
 resources.displayName string

群組的名稱。

取得有效的權限

作業識別碼：
getEffectivePermissions

取得使用者的有效權限。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Effective-Permission-for-a-User

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 path True string

資料夾的完整路徑。
用戶名稱
 username True string

用戶名稱

傳回

名稱 路徑 類型 Description
權限
 permission string

權限值

取得群組詳細資料

作業識別碼：
groupInfoById

使用 ID 擷取群組資訊。 https://developers.egnyte.com/api-docs/read/group-management#Show-Single-Group

參數

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

群組的識別碼。

傳回

名稱 路徑 類型 Description
群組識別碼
 id string

全域唯一群組識別碼。
群組名稱
 displayName string

群組的名稱。
會員
 members array of object

群組成員
群組識別碼
 members.username string

群組成員的使用者名稱
使用者識別碼
 members.value number

群組成員的全域唯一識別碼。
使用者顯示名稱
 members.display string

群組成員的顯示名稱。

取得資料夾權限

作業識別碼：
getFolderPermissions

取得資料夾的權限。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Get-Folder-Permissions

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 path True string

資料夾的完整路徑。

傳回

名稱 路徑 類型 Description
使用者權限
 userPerms object

使用者與權限值的對應。
群組權限
 groupPerms object

群組名稱與權限值的對應
繼承權限
 inheritsPermissions boolean

是否應繼承父資料夾的權限。
保留家長權限
 keepParentPermissions boolean

使用 inheritsPermissions 停用權限繼承時，此選項會決定是否應該將先前從父資料夾繼承的權限複製到此資料夾。

完整群組更新

作業識別碼：
fullGroupUpdate

覆寫群組的所有屬性。 https://developers.egnyte.com/api-docs/read/group-management#Full-Update-to-a-Group

參數

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

已建立群組的識別碼。
顯示名稱
 displayName True string

群組的顯示名稱。
使用者識別碼
 value integer

群組成員的全域唯一識別碼。

傳回

名稱 路徑 類型 Description
群組識別碼
 id string

已建立群組的識別碼。
顯示名稱
 displayName string

群組的顯示名稱。
會員
 members array of object

群組成員
用戶名稱
 members.username string

成員的使用者名稱。
使用者識別碼
 members.value number

成員的使用者 ID。
使用者顯示名稱
 members.display string

成員的顯示名稱。

將資料夾標示為專案

作業識別碼：
markFolderAsProject

將現有資料夾標示為專案。 https://developers.egnyte.com/api-docs/read/project-folder-api#Mark-Folder-as-Project

參數

名稱 機碼 必要 類型 Description
根資料夾識別碼
 rootFolderId True string

根專案資料夾的 FolderId
名稱
 name True string

專案名稱
Description
 description string

資料夾說明
地位
 status True string

專案狀態
開始日期 （例如：2023-12-31T23：59：59）
 startDate date-time

專案的開始日期。
完成日期 （例如 2023-12-31T23：59：59）
 completionDate date-time

專案的完成日期。

傳回

名稱 路徑 類型 Description
Id
 id string

項目識別碼

建立中繼資料金鑰

作業識別碼：
createMetadataKey

將中繼資料索引鍵新增至現有命名空間。 https://developers.egnyte.com/api-docs/read/metadata-api#Create-Metadata-Key

參數

名稱 機碼 必要 類型 Description
命名空間名稱
 namespace True string

Egnyte 中命名空間的唯一識別碼。
鍵名稱
 key True string

您要建立的金鑰名稱。
類型（對於“枚舉”：數據參數是必填的）
 type True string

指定索引鍵的資料類型。
顯示名稱
 displayName string

在UI中識別欄位的名稱。
Priority
 priority number

指定按鍵的優先順序 （優先順序較高的按鍵將首先顯示）。
說明文字
 helpText string

中繼資料欄位的工具提示說明。
資料
 data array of string

對於列舉類型的索引鍵，指定列舉值。

建立使用者

作業識別碼：
createUser

在 Egnyte 建立一個新使用者。 深入了解：https://developers.egnyte.com/api-docs/read/user-management-api-documentation#Create-Single-User

參數

名稱 機碼 必要 類型 Description
用戶名稱
 userName True string

該用戶的 Egnyte 用戶名稱。 必須以字母或數字開頭。
Email
 email True string

使用者的電子郵件地址（例如 admin@acme.com）。
名字
 givenName True string

使用者的名字。
姓
 familyName True string

使用者的姓氏。
Active
 active True boolean

使用者是作用中還是非作用中。
使用者類型
 userType True string

使用者的類型。
驗證類型
 authType True string

使用者的驗證類型。
外部 ID
 externalId string

由 API 使用者提供的不可變唯一識別碼。
傳送邀請
 sendInvite boolean

若在建立使用者時設定為 true，則會發送邀請郵件（若使用者是處於活躍狀態）。
是服務帳戶
 isServiceAccount boolean

若在建立使用者時設定為 true，該使用者將被建立為服務帳號。
語言
 language string

只有在已為網域啟用語言套件時，才會接受 “language” 參數。
Role
 role string

指派給使用者的角色。 僅適用於高級用戶。
IDP 使用者 ID
 idpUserId string

只有當使用者已進行 SSO 認證且未使用預設使用者映射時才需要。 不要指定使用者是否未通過 SSO 認證。
使用者主體名稱
 userPrincipalName string

請勿指定使用者是否未經過 AD 驗證。 用於在多域設定中使用 Active Directory 認證時，將子認證政策綁定給使用者。

傳回

名稱 路徑 類型 Description
使用者識別碼
 id integer

新建立使用者的唯一識別碼
用戶名稱
 userName string

該用戶的 Egnyte 用戶名稱。
外部 ID
 externalId string

由 API 使用者提供的不可變唯一識別碼。
Email
 email string

用戶的電子郵件位址。
電子郵件變更待處理
 emailChangePending boolean

電子郵件變更是否待處理。
名字
 name.givenName string

使用者的名字。
姓
 name.familyName string

使用者的姓氏。
格式化名稱
 name.formatted string

使用者的格式化全名。
Active
 active boolean

使用者是否活躍。
鎖定
 locked boolean

使用者帳號是否被鎖定。
驗證類型
 authType string

使用者的驗證類型。
使用者類型
 userType string

使用者的類型。
IDP 使用者 ID
 idpUserId string

使用者在 SSO 身份提供者的 SAML 回應中被識別的方式。
使用者主體名稱
 userPrincipalName string

用於在使用 Active Directory 認證時，將子驗證政策綁定給使用者。
Role
 role string

指派給使用者的角色。 僅適用於高級用戶。
語言
 language string

使用者的語言偏好。
建立日期
 createdDate date-time

建立使用者的日期和時間。
上次修改日期
 lastModificationDate date-time

最後一次修改的日期和時間。
上次活動日期
 lastActiveDate date-time

最後一次活動的日期和時間。
到期日
 expiryDate date-time

使用者帳號到期的日期。

建立命名空間

作業識別碼：
createNamespace

在 Egnyte 中建立命名空間。 https://developers.egnyte.com/api-docs/read/metadata-api#Create-Namespace

參數

名稱 機碼 必要 類型 Description
命名空間名稱
 name True string

命名空間的名稱
顯示名稱
 displayName string

在UI中識別命名空間的名稱
Scope
 scope True string

誰可以查看和修改命名空間
索引鍵名稱
 name True string

金鑰的名稱
類型
 type True string

指定索引鍵的資料類型
顯示名稱
 displayName string

在UI中識別欄位的名稱
說明文字
 helpText string

中繼資料欄位的工具提示描述
Priority
 priority number

指定按鍵的優先順序 （優先順序較高的按鍵將首先顯示
資料 （適用於列舉類型）
 data array of string

對於列舉類型的索引鍵，指定列舉值

建立檔案

作業識別碼：
createFile

將檔案上傳至 Egnyte。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Upload-a-File

參數

名稱 機碼 必要 類型 Description
檔案名稱
 Name True string

要在 Egnyte 中建立的檔案名稱。
資料夾路徑
 Path True string

將檔案上傳至 Egnyte 的資料夾路徑。
檔案內容
 body True binary

要上傳到 Egnyte 的檔案內容。

傳回

名稱 路徑 類型 Description
版本識別碼
 id string

目前檔案版本的 ID。
檔案 ID
 group_id string

要參考整個檔案的 ID。
檔案路徑
 path string

上傳檔案的完整路徑。

建立群組

作業識別碼：
createGroup

在 Egnyte 中創建一個群組。 https://developers.egnyte.com/api-docs/read/group-management#Create-a-Group

參數

名稱 機碼 必要 類型 Description
顯示名稱
 displayName True string

群組的顯示名稱。
使用者識別碼
 value string

群組成員的全域唯一識別碼。

傳回

名稱 路徑 類型 Description
群組識別碼
 id string

已建立群組的識別碼。
顯示名稱
 displayName string

群組的顯示名稱。
會員
 members array of object

群組成員
用戶名稱
 members.username string

成員的使用者名稱。
使用者識別碼
 members.value number

成員的使用者 ID。
使用者顯示名稱
 members.display string

成員的顯示名稱。

建立資料夾

作業識別碼：
createFolder

在 Egnyte 中建立資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Create-a-Folder

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 path True string

新資料夾的完整路徑。

傳回

名稱 路徑 類型 Description
資料夾路徑
 path string

已建立資料夾的完整路徑
資料夾 ID
 folder_id string

已建立資料夾的唯一ID

建立連結

作業識別碼：
createLink

建立連結。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Create-a-Link

參數

名稱 機碼 必要 類型 Description
路徑
 path True string

目標檔案或資料夾的絕對路徑。
類型
 type True string

這決定了將建立的連結類型。
可及性
 accessibility string

決定誰可以存取連結。 除了上傳連結或 “useDefaultSettings” 為 true 時，則為必要。
使用預設設定
 useDefaultSettings True boolean

決定是否使用網域上的預設參數來建立連結
傳送電子郵件
 send_email boolean

如果設定 true，則 Egnyte 將透過電子郵件傳送連結。
收件者
 recipients array of string

列出連結收件者的電子郵件地址。 只有在「傳送電子郵件」為true時才需要。
訊息 （僅當「傳送電子郵件」為 true 時才適用。
 message string

個人消息將通過鏈接電子郵件發送。
複製我（僅適用於「發送電子郵件」為 true）
 copy_me boolean

如果設定 true，則會將連結訊息的副本傳送給連結建立者。
通知
 notify boolean

如果設定為true，則當存取連結時，連結建立者將透過電子郵件收到通知。
連結至目前 （僅適用於檔案連結。
 link_to_current boolean

如果設定 true，則連結將始終參考檔案的當前版本。
到期日（例如：2023-12-31）
 expiry_date string

連結的到期日。 如果指定，則無法設定「過期點擊」。
過期點擊次數
 expiry_clicks number

連結有效的點按次數。 如果指定，則無法設定「到期日」
新增檔案名稱 （僅適用於檔案連結，不適用於資料夾連結）
 add_file_name boolean

如果為true，則檔案名稱將附加到連結的末尾。
密碼（當「協助工具」參數設定為「密碼」時）
 password string

如果未指定，系統會自動產生密碼。
保護
 protection string

如果設定為「預覽」，它將建立一個僅限預覽的連結。
每個收件者的資料夾 （僅適用於上傳連結。
 folder_per_recipient boolean

如果為true，則每個收件者上傳的資料將放入個別的資料夾中。

傳回

名稱 路徑 類型 Description
Links
 links array of object

一個陣列，其中包含此使用者可以在任何指定範圍內看到的網域所有連結的完整 json 資訊
Id
 links.id string

連結的 ID
網址
 links.url string

連結的完整網址
收件者
 links.recipients array of string

連結傳送至的有效電子郵件地址陣列。
路徑
 path string

目標資源的絕對路徑，可以是檔案或資料夾。
類型
 type string

連結類型，檔案、資料夾或上傳
可及性
 accessibility string

連結可存取者、任何人、密碼、網域或收件者之一。
通知
 notify boolean

布林值，用於在存取連結時是否會透過電子郵件通知連結建立者。
鏈接到當前
 link_to_current boolean

布林值，以確定連結是否一律會參考目前版本的檔案。 僅適用於檔案連結。
到期日
 expiry_date string

連結到期的日期和時間。 只有在連結要到期的日期時，才會顯示此欄位
建立日期
 creation_date string

建立連結的日期和時間
由...創建
 created_by string

建立連結之使用者的使用者名稱

從範本建立專案

作業識別碼：
createProjectFromTemplate

從專案資料夾範本建立新專案。 https://developers.egnyte.com/api-docs/read/project-folder-api#Create-From-Template

參數

名稱 機碼 必要 類型 Description
父資料夾識別碼
 parentFolderId True string

將建立專案資料夾的父資料夾的資料夾 ID
範本資料夾識別碼
 templateFolderId True string

專案資料夾範本的資料夾識別碼
資料夾名稱
 folderName True string

將建立的新資料夾的名稱
名稱
 name True string

專案名稱
Description
 description string

資料夾說明
專案編號
 projectId string

專案的自訂ID
客戶名稱
 customerName string

與專案相關聯的客戶
地位
 status True string

專案狀態
開始日期 （例如：2023-12-31T23：59：59）
 startDate date-time

專案的開始日期。
完成日期 （例如 2023-12-31T23：59：59）
 completionDate date-time

專案的完成日期。
街道地址1
 streetAddress1 string

街道位址的第一行
街道地址 2
 streetAddress2 string

街道位址的第二行
城市
 city string

城市
州或省
 state string

州或省
國家
 country string

國家
郵遞區號或郵遞區號
 postalCode string

郵遞區號或郵遞區號

傳回

名稱 路徑 類型 Description
群組已建立
 groupsCreated array of object
專案編號
 groupsCreated.id string

專案識別碼
專案名稱
 groupsCreated.name string

專案名稱

按 ID 刪除資料夾

作業識別碼：
deleteFolderById

使用 ID 刪除資料夾。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Delete-a-File-or-Folder

參數

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

要從 Egnyte 刪除的資料夾的唯一識別碼。

傳回

名稱 路徑 類型 Description
父資料夾路徑
 parent_folder_path string

已刪除資料夾的父資料夾路徑。

按 ID 複製檔案

作業識別碼：
copyFileById

使用 ID 複製檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Copy-File-or-Folder

參數

名稱 機碼 必要 類型 Description
檔案標識碼
 id True string

要在 Egnyte 中複製的檔案的唯一識別碼。
目的地檔案路徑
 destination_path True string

Egnyte 中的目標檔案路徑，包括目標檔案名稱。

傳回

名稱 路徑 類型 Description
檔案路徑
 path string

複製檔案的完整路徑。
檔案 ID
 group_id string

要參考整個檔案的 ID。

按 ID 解鎖文件

作業識別碼：
unlockFileById

使用 ID 解鎖文件。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

參數

名稱 機碼 必要 類型 Description
檔案標識碼
 id True string

Egnyte 中檔案的唯一識別碼。
鎖定令牌
 lock_token True string

檔案的目前鎖定權杖。

按 ID 鎖定檔案

作業識別碼：
lockFileById

使用 ID 鎖定檔案。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Lock-a-File

參數

名稱 機碼 必要 類型 Description
檔案標識碼
 id True string

Egnyte 中檔案的唯一識別碼。

傳回

名稱 路徑 類型 Description
暫停
 timeout integer

檔案應鎖定的時間 （以秒為單位）。
鎖定令牌
 lock_token string

必須用來解除鎖定檔案的權杖。

按路徑解鎖文件

作業識別碼：
unlockFileByPath

使用路徑解鎖文件。 https://developers.egnyte.com/api-docs/read/file-system-management-api-documentation#Unlock-a-File

參數

名稱 機碼 必要 類型 Description
檔案路徑
 path True string

Egnyte 中檔案的唯一路徑。
鎖定令牌
 lock_token True string

檔案的目前鎖定權杖。

搜尋 V1

作業識別碼：
searchV1

根據檔案名稱、元資料和文字內容尋找儲存在 Egnyte 中的內容。 https://developers.egnyte.com/api-docs/read/search-api#Search-v1

參數

名稱 機碼 必要 類型 Description
搜尋查詢
 query True string

您要尋找的搜尋字串。
Offset
 offset integer

所要求初始記錄的從 0 開始的索引。
Count
 count integer

每頁的項目數。
資料夾
 folder string

將結果限制為指定資料夾中的項目和子代。
修改之前
 modifiedBefore string

將結果限制在此 ISO-8601 時間戳記之前修改的項目。
修改時間
 modifiedAfter string

將結果限制為在此 ISO-8601 時間戳記之後修改的項目。
之前上傳
 uploadedBefore string

將結果限制在此 ISO-8601 時間戳記之前上傳的項目。
上傳時間
 uploadedAfter string

將結果限制為在此 ISO-8601 時間戳記之後上傳的項目。
類型
 type string

應搜尋哪些項目類型。
請求的片段
 snippetRequested boolean

搜尋結果是否應包含程式碼片段。
排序依據:
 sortBy string

應該用於排序的欄位。
排序方向
 sortDirection string

排序的方向。
檔案查詢欄位
 fileQueryFields string

使用特定欄位搜尋檔案。
資料夾查詢欄位
 folderQueryFields string

使用特定欄位搜尋資料夾。
查詢運算子
 queryOperator string

搜索所有單詞或任何單詞。

傳回

名稱 路徑 類型 Description
results
 results array of object
檔案名稱
 results.name string
檔案路徑
 results.path string
MIME 類型
 results.type string
檔案大小
 results.size integer
程式碼片段
 results.snippet string
HTML 程式碼片段
 results.snippet_html string
項目 ID
 results.entry_id string
群組識別碼
 results.group_id string
上次修改時間
 results.last_modified string
上傳者
 results.uploaded_by string
上傳者：使用者名稱
 results.uploaded_by_username string
版本數
 results.num_versions integer
是資料夾
 results.is_folder boolean
總計數
 total_count integer
Offset
 offset integer
Count
 count integer

搜尋 V2

作業識別碼：
searchV2

尋找具有進階搜尋功能的內容。 https://developers.egnyte.com/api-docs/read/search-api#Search-v2

參數

名稱 機碼 必要 類型 Description
搜尋查詢
 query True string

您要尋找的搜尋字串。
Offset
 offset integer

所要求初始記錄的從 0 開始的索引。
Count
 count integer

每頁的項目數。
資料夾
 folder string

將結果限制為指定資料夾中的項目和子代。
修改之前
 modifiedBefore integer

將結果限制為在此 Unix 時間戳記之前修改的項目（以毫秒為單位）。
修改時間
 modifiedAfter integer

將結果限制為在此 Unix 時間戳記之後修改的項目（以毫秒為單位）。
之前上傳
 uploadedBefore integer

將結果限制在此 Unix 時間戳記之前上傳的項目（以毫秒為單位）。
上傳時間
 uploadedAfter integer

將結果限制為在此 Unix 時間戳記之後上傳的項目（以毫秒為單位）。
類型
 type string

應搜尋哪些項目類型。
請求的片段
 snippetRequested boolean

搜尋結果是否應包含程式碼片段。
排序依據:
 sortBy string

應該用於排序的欄位。
排序方向
 sortDirection string

排序的方向。
檔案查詢欄位
 fileQueryFields array of string

使用特定欄位搜尋檔案。
資料夾查詢欄位
 folderQueryFields array of string

使用特定欄位搜尋資料夾。
查詢運算子
 queryOperator string

搜索所有單詞或任何單詞。
更多類似內容 （文件 ID）
 mlt array of string

要用作類似文件搜尋參考的文件 ID 陣列。
更多類似內容（文字）
 mltt array of string

要用作類似文件搜尋參考的文字內容陣列。

傳回

名稱 路徑 類型 Description
results
 results array of object
檔案名稱
 results.name string
檔案路徑
 results.path string
MIME 類型
 results.type string
檔案大小
 results.size integer
程式碼片段
 results.snippet string
HTML 程式碼片段
 results.snippet_html string
項目 ID
 results.entry_id string
群組識別碼
 results.group_id string
上次修改時間
 results.last_modified string
上傳者
 results.uploaded_by string
上傳者：使用者名稱
 results.uploaded_by_username string
版本數
 results.num_versions integer
是資料夾
 results.is_folder boolean
自訂屬性
 results.custom_properties array of object
Scope
 results.custom_properties.scope string
Namespace
 results.custom_properties.namespace string
Key
 results.custom_properties.key string
價值觀
 results.custom_properties.value string
相關性分數
 results.score number
總計數
 total_count integer
Count
 count integer
有更多結果
 hasMore boolean

搜尋中繼資料

作業識別碼：
searchMetadata

尋找具有特定中繼資料欄位或值的項目。 https://developers.egnyte.com/api-docs/read/metadata-api#Search-Metadata

參數

名稱 機碼 必要 類型 Description
搜尋類型
 type string

應搜尋哪些項目類型。
命名空間名稱
 namespace True string

命名空間的名稱。
中繼資料金鑰
 keyName True string

中繼資料索引鍵的名稱。
命名空間名稱
 namespace True string

命名空間的名稱。
中繼資料金鑰
 keyName True string

中繼資料索引鍵的名稱。
中繼資料值
 value True string

中繼資料索引鍵的值。

更新命名空間屬性

作業識別碼：
updateNamespaceAttributes

更新命名空間屬性。 https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Attributes

參數

名稱 機碼 必要 類型 Description
命名空間名稱
 namespace True string

Egnyte 中命名空間的唯一識別碼。
顯示名稱
 displayName string

在UI中識別命名空間的名稱
優先事項
 priorities object

指定索引鍵的優先順序 （順序）。 按鍵將按照其優先順序降序顯示（優先順序較高的按鍵將首先顯示）

傳回

身體
NamespaceItem

更新命名空間索引鍵

作業識別碼：
updateNamespaceKeys

更新網域自訂中繼資料的金鑰。 https://developers.egnyte.com/api-docs/read/metadata-api#Update-Namespace-Keys

參數

名稱 機碼 必要 類型 Description
命名空間名稱
 namespace True string

Egnyte 中命名空間的唯一識別碼。
Key
 key True string

命名空間中的唯一索引鍵
顯示名稱
 displayName string

指定索引鍵顯示的名稱
型別
 type string

指定索引鍵的資料類型
priority
 priority number

指定索引鍵的優先順序 （順序）。 按鍵將按照其優先順序降序顯示（優先順序較高的按鍵將首先顯示）
資料
 data string

對於列舉類型的索引鍵，指定列舉值
幫助文本
 helpText string

使用者新增/編輯屬性時顯示的指示文字，以提供有關屬性用途的內容

傳回

名稱 路徑 類型 Description
名稱
 name string

命名空間名稱
Key
 key string

鍵名稱
顯示名稱
 displayName string

在UI中識別欄位的名稱
幫助文本
 helpText string

中繼資料欄位的工具提示描述
priority
 priority number

指定按鍵的優先順序 （優先順序較高的按鍵將首先顯示

設定資料夾權限

作業識別碼：
setFolderPermissions

設定資料夾的權限。 https://developers.egnyte.com/api-docs/read/egnyte-permissions-api#Set-Folder-Permissions

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 path True string

資料夾的完整路徑。
使用者權限
 userPerms object

使用者與權限值的對應。
群組權限
 groupPerms object

群組名稱與權限值的對應
繼承權限
 inheritsPermissions boolean

是否應繼承父資料夾的權限。
保留父權限 （僅當 inheritsPermissions 為 false） 時
 keepParentPermissions boolean

父資料夾的權限是否應套用至此資料夾。

部分群組更新

作業識別碼：
partialGroupUpdate

更新群組的特定屬性。 https://developers.egnyte.com/api-docs/read/group-management#Partial-Update-to-a-Group

參數

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

已建立群組的識別碼。
顯示名稱
 displayName string

群組的顯示名稱。
使用者識別碼
 value integer

群組成員的全域唯一識別碼。
作業
 operation string

您要在群組上執行的動作。

傳回

名稱 路徑 類型 Description
群組識別碼
 id string

已建立群組的識別碼。
顯示名稱
 displayName string

群組的顯示名稱。
會員
 members array of object

群組成員
用戶名稱
 members.username string

成員的使用者名稱。
使用者識別碼
 members.value number

成員的使用者 ID。
使用者顯示名稱
 members.display string

成員的顯示名稱。

顯示連結詳細資料

作業識別碼：
showLinkDetails

檢視連結的詳細資料。 https://developers.egnyte.com/api-docs/read/egnyte-link-api-documentation#Show-Link-Details

參數

名稱 機碼 必要 類型 Description
連結識別碼
 linkId True string

LinkId

傳回

名稱 路徑 類型 Description
Links
 links array of object

一個陣列，其中包含此使用者可以在任何指定範圍內看到的網域所有連結的完整 json 資訊
Id
 links.id string

連結的 ID
網址
 links.url string

連結的完整網址
收件者
 links.recipients array of string

連結傳送至的有效電子郵件地址陣列。
路徑
 path string

目標資源的絕對路徑，可以是檔案或資料夾。
類型
 type string

連結類型，檔案、資料夾或上傳
可及性
 accessibility string

連結可存取者、任何人、密碼、網域或收件者之一。
通知
 notify boolean

布林值，用於在存取連結時是否會透過電子郵件通知連結建立者。
鏈接到當前
 link_to_current boolean

布林值，以確定連結是否一律會參考目前版本的檔案。 僅適用於檔案連結。
到期日
 expiry_date string

連結到期的日期和時間。 只有在連結要到期的日期時，才會顯示此欄位
建立日期
 creation_date string

建立連結的日期和時間
由...創建
 created_by string

建立連結之使用者的使用者名稱
上次訪問時間
 last_accessed string

上次存取連結的日期和時間。 只有在連結至少被存取一次時，才會顯示此欄位

觸發程序

刪除共用連結時

此作業會在刪除共用連結時觸發流程
刪除檔案時

此作業會在資料夾中刪除檔案時觸發流程。
刪除群組時

此作業會在刪除群組時觸發流程
刪除資料夾時

當資料夾中的子資料夾被刪除時，此作業會觸發流程。
專案更新時

此作業會在專案更新時觸發流程
工作流程完成時

此作業會在工作流程完成時觸發流程
建立共用連結時

此作業會在建立共用連結時觸發流程
建立專案資料夾時

此作業會在建立專案資料夾或將現有資料夾標示為專案資料夾時觸發流程
建立工作流程時

此作業會在建立工作流程時觸發流程
建立檔案時 （Webhook）

當檔案在特定資料夾中建立時，此作業會觸發流程
建立檔案時 （輪詢）

此作業會在資料夾中建立新檔案時觸發流程。
建立群組時

此作業會在建立群組時觸發流程
建立資料夾時

此作業會在資料夾中建立子資料夾時觸發流程。
更新檔案時

當特定資料夾中的檔案更新時，此作業會觸發流程
更新群組時

此作業會在群組更新時觸發流程
核准型別工作流程核准時

當核准類型工作流程獲得核准時，此作業會觸發流程
當核准類型工作流程遭到拒絕時

當核准型別工作流程遭到拒絕時，此作業會觸發流程
當檔案或資料夾中繼資料變更時

此作業會在檔案或資料夾中繼資料變更時觸發流程
當檔案或資料夾權限變更時

此作業會在檔案或資料夾權限變更時觸發流程
當檔案被鎖定時

此作業會在檔案鎖定時觸發流程
當檔案解除鎖定時

此作業會在檔案解除鎖定時觸發流程
當檔案重新命名時

當資料夾中的檔案重新命名時，此作業會觸發流程。
當資料夾未標示為專案時

當資料夾未標示為專案時，此作業會觸發流程
移動檔案時

當檔案在資料夾中移動時，此作業會觸發流程。
移動資料夾時

當子資料夾在資料夾中移動時，此作業會觸發流程。
複製檔案時

當檔案複製到資料夾中時，此作業會觸發流程。
複製資料夾時

當子資料夾複製到資料夾中時，此作業會觸發流程。
重新命名資料夾時

當資料夾中的子資料夾重新命名時，此作業會觸發流程。

刪除共用連結時

作業識別碼：
shareLinkDeleted

此作業會在刪除共用連結時觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

身體
LinkWebhookResponse

刪除檔案時

作業識別碼：
pollDeletedFiles

此作業會在資料夾中刪除檔案時觸發流程。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
事件識別碼
 id integer

事件的識別碼。
時間戳
 timestamp string

ISO-8601 格式化的時間戳記，表示記錄此事件的時間。
使用者識別碼
 actor integer

執行動作之使用者的數值 ID。
行動
 action string

與此事件相關聯的動作。
版本路徑
 data.target_path string

特定檔案版本的完整路徑。
檔案 ID
 data.target_group_id string

要參考整個檔案的 ID。
是資料夾
 data.is_folder boolean

資源是否為資料夾。 （對或錯）
動作來源
 action_source string

事件的來源。 例如WebUI、行動裝置等。

刪除群組時

作業識別碼：
groupDeleted

此作業會在刪除群組時觸發流程

傳回

名稱 路徑 類型 Description
使用者識別碼
 user.id integer

使用者的唯一識別碼。
全名
 user.fullName string

使用者的完整名稱。
用戶名稱
 user.userName string

使用者的使用者名稱。
使用者電子郵件
 user.email string

用戶的電子郵件位址。
群組名稱
 groupName string

群組的名稱。
群組識別碼
 groupId string

群組的唯一識別碼。

刪除資料夾時

作業識別碼：
pollDeletedFolders

當資料夾中的子資料夾被刪除時，此作業會觸發流程。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
事件識別碼
 id integer

事件的識別碼。
時間戳
 timestamp string

ISO-8601 格式化的時間戳記，表示記錄此事件的時間。
使用者識別碼
 actor integer

執行動作之使用者的數值 ID。
行動
 action string

與此事件相關聯的動作。
資料夾路徑
 data.target_path string

已刪除資料夾的完整路徑。
是資料夾
 data.is_folder boolean

資源是否為資料夾。 （對或錯）
動作來源
 action_source string

事件的來源。 例如WebUI、行動裝置等。

專案更新時

作業識別碼：
folderProjectUpdated

此作業會在專案更新時觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
projectId
 projectId string
專案根資料夾Id
 projectRootFolderId string
專案名稱
 name string
項目地點
 location string
項目狀態
 status string

專案狀態 （擱置中、進行中、保留、已完成、已取消）

工作流程完成時

作業識別碼：
workflowCompleted

此作業會在工作流程完成時觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
工作流程識別碼
 workflow.id string
工作流程名稱
 workflow.name string
工作流程顯示標識碼
 workflow.displayId number
工作流程類型
 workflow.type string
工作流程範本ID
 workflow.templateId string
工作流程動作狀態
 workflow.actionStatus string
第一個實體類型
 firstEntity.type string
第一個實體路徑
 firstEntity.filePath string
第一個實體項目 ID
 firstEntity.entryID string
第一個實體群組識別碼
 firstEntity.groupID string
完成狀態碼
 completionStatusCode string
總步數
 totalNumberOfSteps number
竣工日期
 completionDate number

建立共用連結時

作業識別碼：
shareLinkCreated

此作業會在建立共用連結時觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

身體
LinkWebhookResponse

建立專案資料夾時

作業識別碼：
folderProjectAdded

此作業會在建立專案資料夾或將現有資料夾標示為專案資料夾時觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

身體
FolderProjectCommon

建立工作流程時

作業識別碼：
workflowCreated

此作業會在建立工作流程時觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
工作流程識別碼
 workflow.id string
工作流程名稱
 workflow.name string
工作流程顯示標識碼
 workflow.displayId number
工作流程類型
 workflow.type string
工作流程範本ID
 workflow.templateId string
工作流程動作狀態
 workflow.actionStatus string
第一個實體類型
 firstEntity.type string
第一個實體路徑
 firstEntity.filePath string
第一個實體項目 ID
 firstEntity.entryID string
第一個實體群組識別碼
 firstEntity.groupID string
JSON 定義
 definitionJson string

建立檔案時 （Webhook）

作業識別碼：
fileCreated

當檔案在特定資料夾中建立時，此作業會觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標檔案或資料夾的路徑。

傳回

名稱 路徑 類型 Description
檔案項目 ID
 targetEntryId string
檔案 ID
 targetGroupId string
檔案路徑
 targetPath string
上傳連結網址
 uploadLinkUrl string

僅當檔案是透過上傳連結上傳時才可用

建立檔案時 （輪詢）

作業識別碼：
pollCreatedFiles

此作業會在資料夾中建立新檔案時觸發流程。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
事件識別碼
 id integer

事件的識別碼。
時間戳
 timestamp string

ISO-8601 格式化的時間戳記，表示記錄此事件的時間。
使用者識別碼
 actor integer

執行動作之使用者的數值 ID。
行動
 action string

與此事件相關聯的動作。
檔案路徑
 data.target_path string

檔案的完整路徑。
版本識別碼
 data.target_id string

檔案特定版本的 ID。
檔案 ID
 data.target_group_id string

要參考整個檔案的 ID。
是資料夾
 data.is_folder boolean

資源是否為資料夾 （True 或 False）。
動作來源
 action_source string

事件的來源。 例如WebUI、行動裝置等。
物件詳細資料
 object_detail string

物件詳細資料。

建立群組時

作業識別碼：
groupCreated

此作業會在建立群組時觸發流程

傳回

名稱 路徑 類型 Description
使用者識別碼
 user.id integer

使用者的唯一識別碼。
全名
 user.fullName string

使用者的完整名稱。
用戶名稱
 user.userName string

使用者的使用者名稱。
使用者電子郵件
 user.email string

用戶的電子郵件位址。
使用者識別碼
 owner.id integer

使用者的唯一識別碼。
全名
 owner.fullName string

使用者的完整名稱。
用戶名稱
 owner.userName string

使用者的使用者名稱。
使用者電子郵件
 owner.email string

用戶的電子郵件位址。
群組名稱
 groupName string

群組的名稱。
群組識別碼
 groupId string

群組的唯一識別碼。
Members
 members array of GroupUser

該組的成員。

建立資料夾時

作業識別碼：
pollCreatedFolders

此作業會在資料夾中建立子資料夾時觸發流程。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
事件識別碼
 id integer

事件的識別碼。
時間戳
 timestamp string

ISO-8601 格式化的時間戳記，表示記錄此事件的時間。
使用者識別碼
 actor integer

執行動作之使用者的數值 ID。
行動
 action string

與此事件相關聯的動作。
資料夾路徑
 data.target_path string

資料夾的完整路徑。
是資料夾
 data.is_folder boolean

資源是否為資料夾。 （對或錯）
動作來源
 action_source string

事件的來源。 例如WebUI、行動裝置等。
物件詳細資料
 object_detail string

物件詳細資料。

更新檔案時

作業識別碼：
fileUpdated

當特定資料夾中的檔案更新時，此作業會觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標檔案或資料夾的路徑。

傳回

名稱 路徑 類型 Description
檔案項目 ID
 targetEntryId string
檔案 ID
 targetGroupId string
檔案路徑
 targetPath string

更新群組時

作業識別碼：
groupUpdated

此作業會在群組更新時觸發流程

傳回

名稱 路徑 類型 Description
使用者識別碼
 user.id integer

使用者的唯一識別碼。
全名
 user.fullName string

使用者的完整名稱。
用戶名稱
 user.userName string

使用者的使用者名稱。
使用者電子郵件
 user.email string

用戶的電子郵件位址。
使用者識別碼
 owner.id integer

使用者的唯一識別碼。
全名
 owner.fullName string

使用者的完整名稱。
用戶名稱
 owner.userName string

使用者的使用者名稱。
使用者電子郵件
 owner.email string

用戶的電子郵件位址。
群組名稱
 groupName string

群組的名稱。
群組識別碼
 groupId string

群組的唯一識別碼。
行動
 action string

觸發群組更新的特定動作。
Members
 members array of GroupUser

該組的成員。

核准型別工作流程核准時

作業識別碼：
workflowApprovalTaskApproved

當核准類型工作流程獲得核准時，此作業會觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

身體
WorkflowStepResponse

當核准類型工作流程遭到拒絕時

作業識別碼：
workflowApprovalTaskRejected

當核准型別工作流程遭到拒絕時，此作業會觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

身體
WorkflowStepResponse

當檔案或資料夾中繼資料變更時

作業識別碼：
fileOrFolderMetadataChange

此作業會在檔案或資料夾中繼資料變更時觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
目標路徑
 targetPath string
目標群組ID
 targetGroupId string
Namespace
 namespace string
Key
 key string
行動
 action string

當檔案或資料夾權限變更時

作業識別碼：
fileOrFolderPermissionChange

此作業會在檔案或資料夾權限變更時觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
受讓人
 assignee string
受指派人 ID
 assigneeId number
轉讓者
 assigner string
指派人識別碼
 assignerId number
資料夾路徑
 folderPath string
新禮遇
 newPrivilege string
舊特權
 oldPrivilege string
群組名稱
 groupName string

當檔案被鎖定時

作業識別碼：
fileLocked

此作業會在檔案鎖定時觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標檔案或資料夾的路徑。

傳回

身體
FileLockWebhookResponse

當檔案解除鎖定時

作業識別碼：
fileUnlocked

此作業會在檔案解除鎖定時觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標檔案或資料夾的路徑。

傳回

身體
FileLockWebhookResponse

當檔案重新命名時

作業識別碼：
pollRenamedFiles

當資料夾中的檔案重新命名時，此作業會觸發流程。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
事件識別碼
 id integer

個別事件的識別碼。
時間戳
 timestamp string

ISO-8601 格式化的時間戳記，表示記錄此事件的時間。
使用者識別碼
 actor integer

執行動作之使用者的數值 ID。
行動
 action string

與此事件相關聯的動作。
檔案路徑
 data.target_path string

重新命名檔案的完整路徑
版本識別碼
 data.target_id string

檔案特定版本的 ID。
檔案 ID
 data.target_group_id string

要參考整個檔案的 ID。
來源檔案路徑
 data.source_path string

檔案的完整原始路徑。
是資料夾
 data.is_folder boolean

資源是否為資料夾。 （對或錯）
動作來源
 action_source string

事件的來源。 例如WebUI、行動裝置等。
物件詳細資料
 object_detail string

物件詳細資料

當資料夾未標示為專案時

作業識別碼：
folderProjectUnmarked

當資料夾未標示為專案時，此作業會觸發流程

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

身體
FolderProjectCommon

移動檔案時

作業識別碼：
pollMovedFiles

當檔案在資料夾中移動時，此作業會觸發流程。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
事件識別碼
 id integer

個別事件的識別碼。
時間戳
 timestamp string

ISO-8601 格式化的時間戳記，表示記錄此事件的時間。
使用者識別碼
 actor integer

執行動作之使用者的數值 ID。
行動
 action string

與此事件相關聯的動作。
檔案路徑
 data.target_path string

檔案的完整路徑。
版本識別碼
 data.target_id string

檔案特定版本的 ID。
檔案 ID
 data.target_group_id string

要參考整個檔案的 ID。
來源檔案路徑
 data.source_path string

檔案的完整原始路徑。
是資料夾
 data.is_folder boolean

資源是否為資料夾。 （對或錯）
動作來源
 action_source string

事件的來源。 例如WebUI、行動裝置等。
物件詳細資料
 object_detail string

物件詳細資料。

移動資料夾時

作業識別碼：
pollMovedFolders

當子資料夾在資料夾中移動時，此作業會觸發流程。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
事件識別碼
 id integer

個別事件的識別碼。
時間戳
 timestamp string

ISO-8601 格式化的時間戳記，表示記錄此事件的時間。
使用者識別碼
 actor integer

執行動作之使用者的數值 ID。
行動
 action string

與此事件相關聯的動作。
資料夾路徑
 data.target_path string

資料夾的完整目的地路徑。
來源資料夾路徑
 data.source_path string

資料夾的完整原始路徑。
是資料夾
 data.is_folder boolean

資源是否為資料夾。 （對或錯）
動作來源
 action_source string

事件的來源。 例如WebUI、行動裝置等。
物件詳細資料
 object_detail string

物件詳細資料

複製檔案時

作業識別碼：
pollCopiedFiles

當檔案複製到資料夾中時，此作業會觸發流程。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
事件識別碼
 id integer

個別事件的識別碼。
時間戳
 timestamp string

ISO-8601 格式化的時間戳記，表示記錄此事件的時間。
使用者識別碼
 actor integer

執行動作之使用者的數值 ID。
行動
 action string

與此事件相關聯的動作。
檔案路徑
 data.target_path string

檔案的完整路徑。
版本識別碼
 data.target_id string

檔案特定版本的 ID。
檔案 ID
 data.target_group_id string

要參考整個檔案的 ID。
來源檔案路徑
 data.source_path string

檔案的完整原始路徑。
來源檔案版本 ID
 data.source_id string

來源檔案特定版本 ID。
來源檔案ID
 data.source_group_id string

要參考整個檔案的來源檔案 ID。
是資料夾
 data.is_folder boolean

資源是否為資料夾。 （對或錯）
動作來源
 action_source string

事件的來源。 例如WebUI、行動裝置等。
物件詳細資料
 object_detail string

物件詳細資料。

複製資料夾時

作業識別碼：
pollCopiedFolders

當子資料夾複製到資料夾中時，此作業會觸發流程。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
事件識別碼
 id integer

個別事件的識別碼。
時間戳
 timestamp string

ISO-8601 格式化的時間戳記，表示記錄此事件的時間。
使用者識別碼
 actor integer

執行動作之使用者的數值 ID。
行動
 action string

與此事件相關聯的動作。
資料夾路徑
 data.target_path string

資料夾的完整目的地路徑
來源資料夾路徑
 data.source_path string

資料夾的完整原始路徑
是資料夾
 data.is_folder boolean

資源是否為資料夾 （True 或 False）
動作來源
 action_source string

事件的來源。 例如WebUI、行動裝置等。
物件詳細資料
 object_detail string

物件詳細資料

重新命名資料夾時

作業識別碼：
pollRenamedFolders

當資料夾中的子資料夾重新命名時，此作業會觸發流程。

參數

名稱 機碼 必要 類型 Description
資料夾路徑
 FolderPath True string

目標資料夾的路徑。

傳回

名稱 路徑 類型 Description
事件識別碼
 id integer

個別事件的識別碼。
時間戳
 timestamp string

ISO-8601 格式化的時間戳記，表示記錄此事件的時間。
使用者識別碼
 actor integer

執行動作之使用者的數值 ID。
行動
 action string

與此事件相關聯的動作。
資料夾路徑
 data.target_path string

資料夾的完整目的地路徑。
來源資料夾路徑
 data.source_path string

資料夾的完整原始路徑。
是資料夾
 data.is_folder boolean

資源是否為資料夾。 （對或錯）
動作來源
 action_source string

事件的來源。 例如WebUI、行動裝置等。
物件詳細資料
 object_detail string

物件詳細資料

定義

群組使用者

名稱 路徑 類型 Description
使用者識別碼
 id integer

使用者的唯一識別碼。
全名
 fullName string

使用者的完整名稱。
用戶名稱
 userName string

使用者的使用者名稱。
使用者電子郵件
 email string

用戶的電子郵件位址。

LinkWebhook回應

名稱 路徑 類型 Description
來源路徑
 sourcePath string
連結ID
 linkId string
連結類型
 linkType string

資料夾或檔案
連結 URL
 linkURL string

FileInfo回應

名稱 路徑 類型 Description
總和檢查碼
 checksum string

用來判斷檔案變更之目前版本的總和檢查碼值。
大小
 size integer

以位元組為單位的檔案大小。
檔案路徑
 path string

檔案的完整路徑。
名稱
 name string

檔案名稱。
已鎖定
 locked boolean

檔案上的鎖定狀態。
是資料夾
 is_folder boolean

資源是否為資料夾。 真或假
版本識別碼
 entry_id string

檔案目前版本的識別碼。
檔案 ID
 group_id string

要參考整個檔案的 ID。
父資料夾識別碼
 parent_id string

所要求父資料夾的識別碼。
上次修改時間
 last_modified string

檔案目前版本的上次修改時間。
上傳者
 uploaded_by string

上傳目前版本之使用者的使用者名稱。
上傳的時間戳記
 uploaded integer

檔案目前版本的上傳時間。
版本數
 num_versions integer

與特定檔案路徑相關聯的版本總數。
versions
 versions array of object

Versions
是資料夾 （版本）
 versions.is_folder boolean

資源是否為資料夾。 真或假
版本識別碼
 versions.entry_id string

檔案特定版本的 ID。
總和檢查碼 （版本）
 versions.checksum string

用來判斷檔案變更之檔案版本的總和檢查碼值。
上次修改時間 （版本）
 versions.last_modified string

檔案特定版本的上次修改時間。
上傳者（版本）
 versions.uploaded_by string

上傳版本之使用者的使用者名稱。
上傳的時間戳記（版本）
 versions.uploaded integer

檔案特定版本的上傳時間。
尺寸（版本）
 versions.size integer

特定版本的檔案大小（以位元組為單位）。

UserInfo回應

用戶資訊

名稱 路徑 類型 Description
使用者識別碼
 id integer

使用者 ID
用戶名稱
 userName string

使用者的使用者名稱
外部 ID
 externalId string

外部 ID
Email
 email string

使用者電子郵件
姓
 name.familyName string

使用者姓氏 （姓氏）
名字
 name.givenName string

使用者名字（名字）
Active
 active boolean

使用者帳戶是否作用中
建立日期
 createdDate string

使用者的建立日期
上次修改日期
 lastModificationDate string

使用者上次修改日期
上次活動日期
 lastActiveDate string

使用者處於作用中的最後日期
鎖定
 locked boolean

使用者已鎖定
語言
 language string

只有在已為網域啟用語言套件時，才會接受 “language” 參數。
驗證類型
 authType string

使用者的驗證類型。
使用者類型
 userType string

使用者的類型。
Role
 role string

指派給使用者的角色。 僅適用於高級用戶。
IDP 使用者 ID
 idpUserId string

身分識別提供者使用者 ID
是服務帳戶
 isServiceAccount boolean

該帳戶是否用作服務帳戶
到期時刪除
 deleteOnExpiry string

賬號到期後會被刪除嗎
電子郵件變更待處理
 emailChangePending boolean

使用者電子郵件變更是否擱置中
到期日
 expiryDate string

帳戶到期
使用者主體名稱
 userPrincipalName string
groups
 groups array of object
顯示名稱
 groups.displayName string

群組名稱
群組識別碼
 groups.value string

群組的識別碼

UserList回應

取得使用者清單回應

名稱 路徑 類型 Description
總結果
 totalResults integer

符合查詢的結果總數。
每頁項目數
 itemsPerPage integer

傳回的結果數目。
開始索引
 startIndex integer

目前結果集中第一個結果的從 1 開始的索引。
resources
 resources array of object
使用者識別碼
 resources.id integer

使用者的 ID
用戶名稱
 resources.userName string

使用者的使用者名稱
外部 ID
 resources.externalId string

外部 ID
Email
 resources.email string

使用者電子郵件
格式化名稱
 resources.name.formatted string

使用者格式化名稱
姓
 resources.name.familyName string

使用者姓氏 （姓氏）
名字
 resources.name.givenName string

使用者名字（名字）
Active
 resources.active boolean

使用者帳戶是否作用中
鎖定
 resources.locked boolean

使用者帳戶是否已鎖定
建立日期
 resources.createdDate string

使用者的建立日期
上次修改日期
 resources.lastModificationDate string

使用者上次修改日期
上次活動日期
 resources.lastActiveDate string

使用者處於作用中的最後日期
語言
 resources.language string

只有在已為網域啟用語言套件時，才會接受 “language” 參數。
驗證類型
 resources.authType string

使用者的驗證類型。
使用者類型
 resources.userType string

使用者的類型。
Role
 resources.role string

指派給使用者的角色。 僅適用於高級用戶。
IDP 使用者 ID
 resources.idpUserId string

身分識別提供者使用者 ID
是服務帳戶
 resources.isServiceAccount boolean

該帳戶是否用作服務帳戶
到期時刪除
 resources.deleteOnExpiry string

賬號到期後會被刪除嗎
電子郵件變更待處理
 resources.emailChangePending boolean

使用者電子郵件變更是否擱置中
到期日
 resources.expiryDate string

帳戶到期
使用者主體名稱
 resources.userPrincipalName string

FolderInfoResponse

名稱 路徑 類型 Description
名稱
 name string

資料夾的名稱。
上次修改時間
 lastModified integer

資料夾中任何檔案 （但不在子資料夾內） 已修改的最新時間。
上傳的時間戳記
 uploaded integer

上傳或建立資料夾的時間。
資料夾路徑
 path string

資料夾的完整路徑。
資料夾 ID
 folder_id string

資料夾的唯一識別碼。
父資料夾識別碼
 parent_id string

父資料夾的 ID。
子項目計數
 total_count integer

實際可退貨的項目總數。
是資料夾
 is_folder boolean

資源是否為資料夾。 真或假
可能的公共鏈接
 public_links string

關於如何設置“允許來自此文件夾的公共鏈接”的文件夾選項設置。
可共享
 allow_links boolean

可以分享嗎？ T 或 F
可以刪除或移動
 restrict_move_delete boolean

可以刪除或移動嗎？ T 或 F
資料夾
 folders array of object

資料夾
名稱 （子資料夾）
 folders.name string

資料夾的名稱。
上次修改時間 （子資料夾）
 folders.lastModified integer

資料夾中任何檔案 （但不在子資料夾內） 已修改的最新時間。
上傳的時間戳記（子資料夾）
 folders.uploaded integer

上傳或建立資料夾的時間。
路徑 （子資料夾）
 folders.path string

所要求的資料夾完整路徑。
ID （子資料夾）
 folders.folder_id string

所要求資料夾的識別碼。
是資料夾 （子資料夾）
 folders.is_folder boolean

資源是否為資料夾。 真或假
父資料夾 ID （子資料夾）
 folders.parent_id string

父資料夾的 ID。
files
 files array of object

檔案儲存體
總和檢查碼 （檔案）
 files.checksum string

用來判斷檔案變更之目前版本的總和檢查碼值。
大小（檔案）
 files.size integer

以位元組為單位的檔案大小。
路徑（檔案）
 files.path string

檔案的完整路徑。
名稱（檔案）
 files.name string

檔案名稱。
已鎖定 （檔案）
 files.locked boolean

檔案上的鎖定狀態。
是資料夾（檔案）
 files.is_folder boolean

資源是否為資料夾。 真或假
版本 ID （檔案）
 files.entry_id string

檔案特定版本的 ID。
ID（檔案）
 files.group_id string

要參考整個檔案的 ID。
父資料夾 ID （檔案）
 files.parent_id string

父資料夾的識別碼。
上次修改時間 （檔案）
 files.last_modified string

檔案目前版本的上次修改時間。
上傳者（檔案）
 files.uploaded_by string

上傳版本之使用者的使用者名稱。
上傳的時間戳記（檔案）
 files.uploaded integer

檔案目前版本的上傳時間。
版本計數 （檔案）
 files.num_versions integer

與特定檔案路徑相關聯的版本總數。

命名空間項目

名稱 路徑 類型 Description
命名空間名稱
 name string
命名空間範圍
 scope string
鑰匙
 keys object
顯示名稱
 displayName string

在UI中識別命名空間的名稱
priority
 priority number

指定索引鍵的優先順序 （順序）。 按鍵將按照其優先順序降序顯示（優先順序較高的按鍵將首先顯示）
可繼承
 inheritable boolean
schemaSystemGenerated
 schemaSystemGenerated boolean
metadataScopeType
 metadataScopeType string
可編輯
 editable boolean

專案專案

名稱 路徑 類型 Description
Id
 id string

項目識別碼
根資料夾識別碼
 rootFolderId string

根資料夾識別碼
名稱
 name string

專案名稱
專案編號
 projectId string

專案的ID
客戶名稱
 customerName string

與專案相關聯的客戶
Description
 description string

資料夾說明
位置
 location ProjectLocationItem
地位
 status string

專案狀態
作者
 createdBy number

作者
最後更新者
 lastUpdatedBy number

最後更新者
創建時間
 creationTime string

創建時間
上次修改時間
 lastModifiedTime string

上次修改時間
開始日期
 startDate string

專案的開始日期。
竣工日期
 completionDate string

專案的完成日期。

專案位置項目

名稱 路徑 類型 Description
街道地址1
 streetAddress1 string

街道位址的第一行
街道地址 2
 streetAddress2 string

街道位址的第二行
城市
 city string

城市
州或省
 state string

州或省
國家
 country string

國家
郵遞區號或郵遞區號
 postalCode string

郵遞區號或郵遞區號

FileLockWebhook回應

名稱 路徑 類型 Description
檔案 ID
 targetGroupId string
檔案總和檢查碼
 targetFileChecksum string
檔案路徑
 targetPath string

FolderProjectCommon

名稱 路徑 類型 Description
projectId
 projectId string
專案根資料夾Id
 projectRootFolderId string

WorkflowStep回應

名稱 路徑 類型 Description
工作流程識別碼
 workflow.id string
工作流程名稱
 workflow.name string
工作流程顯示標識碼
 workflow.displayId number
工作流程類型
 workflow.type string
工作流程範本ID
 workflow.templateId string
工作流程動作狀態
 workflow.actionStatus string
第一個實體類型
 firstEntity.type string
第一個實體路徑
 firstEntity.filePath string
第一個實體項目 ID
 firstEntity.entryID string
第一個實體群組識別碼
 firstEntity.groupID string
步驟識別碼
 step.id string
步驟名稱
 step.name string
步驟類型
 step.type string
受指派人 ID
 assignee.id number
受指派人顯示名稱
 assignee.displayName string
受讓人使用者名稱
 assignee.username string
受指派人電子郵件
 assignee.email string
總步數
 totalNumberOfSteps number
竣工日期
 completionDate number
建立日期
 creationDate number

AIQuestion回應

名稱 路徑 類型 Description
response
 response AIResponse
引文
 citations array of AICitation

用於生成回應的引文和參考文獻

AISummary回應

名稱 路徑 類型 Description
response
 response AIResponse

AICopilot回應

名稱 路徑 類型 Description
response
 response AIResponse
引文
 citations array of AICitation

用於生成回應的引文和參考文獻
交談識別碼
 conversationId string

交談的唯一識別碼

AI程式

名稱 路徑 類型 Description
檔名
 filename string

來源檔案的名稱
項目 ID
 entryId string

來源檔案的項目識別碼
文字區塊
 chunks array of object

來源中的文字區塊陣列
區塊 ID
 chunks.chunkId string

文字區塊的識別碼
來源文本
 chunks.sourceText string

區塊的文字內容

AIResponse

名稱 路徑 類型 Description
回應文字
 text string

AI 生成的回應文本