共用方式為

i管理工作

iManage Work 連接器使用戶能夠自動執行重複性任務和審批流程，同時在 iManage Work 環境中確保所有文件的安全。

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

服務 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）
連絡人​​
名稱 iManage 有限責任公司
URL https://docs.imanage.com
Email cloudsupport@imanage.com
連接器中繼資料
Publisher iManage Power Platform 連接器
網站 https://imanage.com
隱私策略 https://imanage.com/about/privacy-notice/
類別 內容和文件;生產力

i管理工作

iManage 是業界領先的知識工作者文件和電子郵件管理解決方案供應商。 iManage 平台組織和保護文件和電子郵件中的信息，因此專業人員可以搜索他們需要的內容，採取行動並更有效地協作。 iManage Work 連接器使用戶能夠自動執行重複性任務和審批流程，同時確保 iManage Work 環境中的所有文件安全。

先決條件

此連接器適用於所有連線到 cloudimanage.com 的 iManage Work 客戶。 首先，Power Automate 應用程式需要由 iManage 工作環境的管理員啟用。 啟用後，您將需要環境的特定URL，以及聯結器可以執行動作的登入帳戶和密碼。 如需詳細資訊，請參閱常見問題集。

如何取得認證

如果您是現有的 iManage Work 使用者，請提供您的 iManage Work 憑證以登入。 否則，請聯絡您的系統管理員以取得協助。

開始使用 iManage Work 連接器

請執行下列步驟以開始使用 iManage Work 連接器：

  • 建立即時雲端流程，然後選取 + 新增步驟。
  • 搜尋 iManage Work 以查看所有可用的 iManage Work 動作。
  • 選取所需的 iManage Work 動作。
  • 如果您尚未登入 iManage Work，系統會提示您登入。
    • 選取 登入。
    • 輸入您用來連線至 iManage Work 的 URL，例如 cloudimanage.com。
    • 輸入您的 iManage 工作使用者 ID。
    • 輸入所選帳戶的密碼，然後選擇 登入。 從此時起，所有使用 iManage Work 動作的流程都會使用這些使用者認證進行連線。 可以在 「我的連線」 下新增新連線並切換至該連線，以使用不同的 iManage 使用者帳戶。

已知問題與限制

有關已知問題和限制的列表，請訪問 https://docs.imanage.com/power-automate/index.html。

常見錯誤和補救措施

有關常見錯誤和補救措施的列表，請訪問 https://docs.imanage.com/power-automate/index.html。

FAQ

有關常見問題列表，請訪問 https://docs.imanage.com/power-automate/index.html。

節流限制

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

動作

上傳文件

將檔案作為新文件上傳至指定的資料夾。
下載文件

根據文件 ID 下載特定文件的版本。 如果 latest 為 true，則會下載本文件的最新版本。 下載是串流，不會儲存在本機。
刪除文件

刪除指定的文件。
刪除文件參照

從指定的資料夾中刪除文件參照。
刪除文件關係

刪除文件庫中指定文件之間的關聯性。
升級文件版本

將文件的現有版本升級為最新版本。 從指定的「異動日誌 ID」或「版本」建立新版本，然後升級為最新版本。 您必須指定「異動日誌 ID」或「版本」，但不能同時指定兩者。
取得使用者詳細資料

從指定的文件庫取得使用者的相關資訊。
取得受託人

取得對文件、資料夾或工作區具有特定權限的受託人清單。 受託人可以是使用者或群組。
取得子類別

取得符合指定準則的所有程式庫子類別。
取得工作區範本

取得文件庫中可用的範本清單。 工作區範本是預先定義的工作區，其結構會複製到新工作區。
取得工作區設定檔

取得工作區設定檔，以及選擇性地取得工作區允許的作業清單。
取得文件版本

取得目前使用者有權存取指定文件之所有版本的設定檔。
取得文件的核心擴充中繼資料屬性

取得文件的核心擴充中繼資料屬性。
取得文件設定檔

取得與特定文件識別碼相關聯的文件內容。
取得權限

取得文件、資料夾或工作區的使用者或群組存取權限屬性。 回應屬性可能會因使用者或群組權限而異。
取得程式庫

取得使用者有權存取的程式庫清單。
取得群組成員

取得屬於指定群組並符合指定條件的使用者詳細資料。
取得課程

取得文件庫中符合指定準則的可用文件類別清單。
在文件上設定核心擴充中繼資料屬性

設定文件上的核心擴充中繼資料屬性。
建立工作區

根據選取的範本建立新的工作區。 工作區範本是預先定義的工作區，其結構會複製到新工作區。 建立新工作區時，會自動強制執行工作區範本的限制。
建立文件關係

在資源庫中的指定文件之間建立關係。
影印文件

將文件複製到指定的資料夾。
搜尋使用者

搜尋符合指定搜尋準則的 iManage Work 使用者。
搜尋工作區

搜尋工作區。
搜尋核心擴充中繼資料分類節點值

搜尋符合指定搜尋準則的核心延伸中繼資料分類節點值。
搜尋資料夾

搜尋資料夾。
新增文件參考

在另一個資料夾中新增文件參照或文件捷徑。
新增文件歷程記錄項目

將項目新增為文件歷程記錄中的事件。
更新工作區

更新指定工作區的資訊。 若要刪除字串欄位的現有值，請將欄位的值設定為以單引號或雙引號括起來的空字串。
更新工作流程狀態

更新工作流程執行的狀態。 此動作只能在已建立的工作流程中使用，以 iManage 提供的觸發器啟動。
更新文件設定檔

對文件設定檔執行更新。 更新文件設定檔時不得使用文件，且無法更新已出庫文件的設定檔。 在作業之後傳回更新的文件設定檔。
更新權限

更新物件的權限。
更新目前或建立新的文件版本

更新文件的指定版本，或建立新版本。 此動作可以更新文件的設定檔和內容。 如果指定了「更新目前版本」選項，則文件會取代為新文件，並保留先前文件的設定檔。 如果指定「建立新版本」，則會建立繼承資料夾設定檔的新版本文件。 成功執行作業時，會傳回文件設定檔。
更新預設安全性

更新文件、資料夾或工作區的預設安全性。
移動文件

將文件移至指定的資料夾。
編輯名稱/值組

建立、更新或刪除文件、資料夾或工作區的名稱值配對屬性。 若要刪除名稱值組，請將索引鍵的值設定為以單引號或雙引號括起來的空字串。
複製權限

將存取權限和預設安全性從一個 iManage Work 物件複製到另一個 iManage Work 物件。 「複製型別」可讓您選擇如何處理來源和目的地許可權的組合。 「覆寫」會更新目標物件的使用者、群組和權限層級，以完全符合來源物件的使用者、群組和權限層級。 'Merge' 會保留目的地物件上的所有使用者和群組，並將它們與來源結合，但如果個人或群組的權限層級發生衝突：「Merge （Pessimistic）」會取得較低的權限，而 'Merge （Optimistic）」會取得衝突使用者或群組的較高權限。

上傳文件

作業識別碼：
UploadDocument

將檔案作為新文件上傳至指定的資料夾。

參數

名稱 機碼 必要 類型 Description
圖書館 ID
 libraryId True string

指定目標文件庫的 ID。
資料夾 ID
 folderId True string

指定目標資料夾的資料夾 ID。 例如，“ACTIVE_US！987”。
繼承資料夾設定檔
 inherit_profile_from_folder True boolean

指定設定檔資料是否繼承自父資料夾。
保持鎖定
 keep_locked boolean

指定上傳後是否保留文件鎖定。
評論
 comment string

指定有關更新的其他資訊。
作者
 author string

指定建立文件之使用者的 iManage 工作 ID。
Operator
 operator string

指定已出庫使用文件或目前正在編輯文件設定檔的使用者 ID。 例如，'JSMITH'。
Class
 class string

指定用於識別和區分文件的類別。 文件類別依類型、部門、地區等分類。
子類別
 subclass string

指定用於識別和區分文件的子類別。 文件子類別依類型、部門、地區等進行分類。
預設安全性
 default_security string

指定預設安全性存取層級。 可能的值為 'inherit'、'private'、'view'、'public'。
HIPAA 是
 is_hipaa boolean

指定是否要加密文件。
保留天數
 retain_days integer

指定文件在標示為封存之前必須處於非作用中的天數。
檔案內容
 file True file

指定檔案的內容。
檔案建立日期
 file_create_date date-time

指定建立檔案的日期和時間 （ISO 8601 格式）。 該檔案可能是在 iManage Work 系統之外建立的。 此日期可能與「create_date」不同。 create_date是 iManage Work 系統建立或匯入檔案的日期。
檔案編輯日期
 file_edit_date date-time

指定檔案最近變更的日期和時間 （ISO 8601 格式）。 該檔案在上傳到 iManage Work 系統之前可能已變更。
自訂1
 custom1 string

指定 custom1 的值。
自訂2
 custom2 string

指定 custom2 的值。 若要指定 custom2 的值，您也必須在相同的要求中指定 custom1 的值，這是由於其父子關係所致。
自訂3
 custom3 string

指定 custom3 的值。
自訂4
 custom4 string

指定 custom4 的值。
自訂5
 custom5 string

指定 custom5 的值。
自訂6
 custom6 string

指定 custom6 的值。
自訂7
 custom7 string

指定 custom7 的值。
自訂8
 custom8 string

指定 custom8 的值。
自訂9
 custom9 string

指定 custom9 的值。
自訂10
 custom10 string

指定 custom10 的值。
自訂11
 custom11 string

指定 custom11 的值。
自訂12
 custom12 string

指定 custom12 的值。
自訂13
 custom13 string

指定 custom13 的值。
自訂14
 custom14 string

指定 custom14 的值。
自訂15
 custom15 string

指定 custom15 的值。
自訂16
 custom16 string

指定 custom16 的值。
自訂17
 custom17 double

指定 custom17 的值。
自訂18
 custom18 double

指定 custom18 的值。
自訂19
 custom19 double

指定 custom19 的值。
客製化20
 custom20 double

指定 custom20 的值。
自訂21
 custom21 string

以 ISO 8601 日期時間格式指定 custom21 的值。
自訂22
 custom22 string

以 ISO 8601 日期時間格式指定 custom22 的值。
客製化23
 custom23 string

指定 ISO 8601 日期時間格式的 custom23 值。
定制24
 custom24 string

以 ISO 8601 日期時間格式指定 custom24 的值。
客製化25
 custom25 boolean

指定 custom25 的值。
客製化26
 custom26 boolean

指定 custom26 的值。
自訂27
 custom27 boolean

指定 custom27 的值。
客製化28
 custom28 boolean

指定 custom28 的值。
自訂29
 custom29 string

指定 custom29 的值。
客製化30
 custom30 string

指定 custom30 的值。 若要指定 custom30 的值，您也必須在相同的要求中指定 custom29 的值，這是由於其父子關係所致。

下載文件

作業識別碼：
DownloadDocument

根據文件 ID 下載特定文件的版本。 如果 latest 為 true，則會下載本文件的最新版本。 下載是串流，不會儲存在本機。

參數

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

指定文件的 ID。 例如，'ACTIVE_USE！453.1'。
獲取最新版本
 latest boolean

指定下載文件的最新版本。

傳回

指出檔案的內容。

檔案內容
binary

刪除文件

作業識別碼：
DeleteDocument

刪除指定的文件。

參數

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

指定文件的 ID。 例如，'ACTIVE_US！453.1'。
刪除所有版本
 deleteAllVersions True boolean

指定刪除文件的所有版本。

刪除文件參照

作業識別碼：
DeleteDocumentReference

從指定的資料夾中刪除文件參照。

參數

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

指定文件的 ID。 例如，'ACTIVE_US！453.1'。
資料夾 ID
 folderId True string

指定資料夾的 ID。 例如，'ACTIVE_US！773'。

傳回

response
object

刪除文件關係

作業識別碼：
DeleteDocumentRelation

刪除文件庫中指定文件之間的關聯性。

參數

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

指定主要文件的 ID。 例如，'ACTIVE_US！453.1'。
相關文件 ID
 relatedDocumentId True string

指定相關文件的 ID。 例如，'ACTIVE_US！453.1'。

傳回

response
object

升級文件版本

作業識別碼：
PromoteDocumentVersion

將文件的現有版本升級為最新版本。 從指定的「異動日誌 ID」或「版本」建立新版本，然後升級為最新版本。 您必須指定「異動日誌 ID」或「版本」，但不能同時指定兩者。

參數

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

指定文件的 ID。 例如，'ACTIVE_US！453.1'。
版本
 version integer

指定要用作新升級版本基礎的版本號碼。
期刊 ID
 journalId string

指定要用作新升級版本基礎的異動日誌 ID。
評論
 comment string

指定文件的其他資訊。
Alias
 alias string

指定此文件的別名。
作者
 author string

指定建立文件之使用者的 ID。 例如，'JSMITH'。
文件類別
 class string

指定文件類別。
文件預設安全性
 default_security string

指定預設安全性存取層級。
已宣告
 is_declared boolean

指定是否要將文件的新版本宣告為記錄。 宣告為記錄的文件無法編輯或刪除，除非由 iManage Work 系統管理者編輯或刪除。
HIPAA 是
 is_hipaa boolean

指定是否要加密文件的新版本。
文件名稱
 name string

指定文件的檔名。
Operator
 operator string

指定已出庫使用文件或目前正在編輯文件設定檔的使用者 ID。 例如，'JSMITH'。
保留天數
 retain_days integer

指定非作用中文件符合封存資格之前的天數。
子類別
 subclass string

指定文件的子類別。
自訂1
 custom1 string

指定 custom1 的值。
自訂2
 custom2 string

指定 custom2 的值。 若要指定 custom2 的值，您也必須在相同的要求中指定 custom1 的值，這是由於其父子關係所致。
自訂3
 custom3 string

指定 custom3 的值。
自訂4
 custom4 string

指定 custom4 的值。
自訂5
 custom5 string

指定 custom5 的值。
自訂6
 custom6 string

指定 custom6 的值。
自訂7
 custom7 string

指定 custom7 的值。
自訂8
 custom8 string

指定 custom8 的值。
自訂9
 custom9 string

指定 custom9 的值。
自訂10
 custom10 string

指定 custom10 的值。
自訂11
 custom11 string

指定 custom11 的值。
自訂12
 custom12 string

指定 custom12 的值。
自訂13
 custom13 string

指定 custom13 的值。
自訂14
 custom14 string

指定 custom14 的值。
自訂15
 custom15 string

指定 custom15 的值。
自訂16
 custom16 string

指定 custom16 的值。
自訂17
 custom17 double

指定 custom17 的值。
自訂18
 custom18 double

指定 custom18 的值。
自訂19
 custom19 double

指定 custom19 的值。
客製化20
 custom20 double

指定 custom20 的值。
自訂21
 custom21 string

以 ISO 8601 日期時間格式指定 custom21 屬性的值。
自訂22
 custom22 string

以 ISO 8601 日期時間格式指定 custom22 屬性的值。
客製化23
 custom23 string

以 ISO 8601 日期時間格式指定 custom23 屬性的值。
定制24
 custom24 string

以 ISO 8601 日期時間格式指定 custom24 屬性的值。
客製化25
 custom25 boolean

指定 custom25 的值。
客製化26
 custom26 boolean

指定 custom26 的值。
自訂27
 custom27 boolean

指定 custom27 的值。
客製化28
 custom28 boolean

指定 custom28 的值。
自訂29
 custom29 string

指定 custom29 的值。
客製化30
 custom30 string

指定 custom30 的值。 若要指定 custom30 的值，您也必須在相同的要求中指定 custom29 的值，這是由於其父子關係所致。

取得使用者詳細資料

作業識別碼：
GetUserDetails

從指定的文件庫取得使用者的相關資訊。

參數

名稱 機碼 必要 類型 Description
圖書館 ID
 libraryId True string

指定目標使用者的程式庫識別碼。
使用者識別碼
 userId True string

指定要取得詳細設定檔資訊的使用者識別碼。 例如，'JSMITH'。

傳回

名稱 路徑 類型 Description
資料
 data UserProfile

指出使用者的相關資訊。

取得受託人

作業識別碼：
GetTrustees

取得對文件、資料夾或工作區具有特定權限的受託人清單。 受託人可以是使用者或群組。

參數

名稱 機碼 必要 類型 Description
物件類型
 objectType True string

指定物件的類型。
物件識別碼
 objectId True string

指定文件、資料夾或工作區的識別碼。 文件 ID 的範例是「ACTIVE_US！453.1」。 資料夾或工作區識別碼的範例是 'ACTIVE_US！123'。

傳回

名稱 路徑 類型 Description
資料
 data array of object

指出對文件、資料夾或工作區具有特定權限的受託人清單。 受託人可以是使用者或群組。
全名
 data.full_name string

指出受託人的全名。
ID
 data.id string

指出受託人的識別碼。 這可以是群組 ID 或使用者 ID。 例如，'JSMITH' 或 'MARKETING'。
SSID
 data.ssid string

指出受託人的唯一系統產生 ID。
類型
 data.type string

指出傳回的實體類型。 可能的值為 'user' 或 'group'。

取得子類別

作業識別碼：
GetSubclasses

取得符合指定準則的所有程式庫子類別。

參數

名稱 機碼 必要 類型 Description
圖書館 ID
 libraryId True string

指定目標子類別的程式庫 ID。
類別識別碼
 classId True string

指定作為此子類別父項的類別識別碼。 例如，“請願書”。
子類別 ID
 alias string

指定要搜尋的子類別 ID。 可以是逗號分隔的清單。 支援萬用字元 （*）。 使用萬用字元時，支援部分相符。
預設安全性
 default_security string

指定預設安全性存取層級。
Description
 description string

指定要在描述欄位中比對的文字。 支援萬用字元 （*）。 使用萬用字元時，支援部分相符。
回音
 echo boolean

指定子類別是否可以回應至使用者的本機硬碟。 這是為了方便離線工作。
HIPAA
 hipaa boolean

指定是否要傳回符合 HIPAA 規範的子類別。
Query
 query string

指定要與「子類別 ID」或「說明」欄位相符的文字。 支援萬用字元 （*）。 支援部分相符。

傳回

名稱 路徑 類型 Description
最相符的子類別識別碼
 data.topMatchingId string

指出最相符子類別的 ID。
頂級匹配子類描述
 data.topMatchingDescription string

指出最相符子類別的說明。
results
 data.results array of object
預設安全性
 data.results.default_security string

指出預設安全性存取層級。 可能的值為 'public'、'view'、'private'。
Description
 data.results.description string

指出子類別的其他資訊。 長度上限為 255 個字元。
HIPAA 是
 data.results.hipaa boolean

指出文件是否已加密。
ID
 data.results.id string

指出用來建立或修改文件設定檔資訊的子類別 ID。 例如，“監護權”。
父 ID
 data.results.parent.id string

指出子類別的父類別識別碼。
必填欄位
 data.results.required_fields array of string

指出在建立或更新此子類別的文件時要輸入的必要自訂內容。
Retain
 data.results.retain integer

指出將此子類別的非作用中文件標示為已過期之前的天數。
被陰影
 data.results.shadow boolean

指出此子類別的文件在簽入之後，是否在使用者的本機電腦上隱藏 （保留） 。

取得工作區範本

作業識別碼：
GetWorkspaceTemplates

取得文件庫中可用的範本清單。 工作區範本是預先定義的工作區，其結構會複製到新工作區。

參數

名稱 機碼 必要 類型 Description
圖書館 ID
 libraryId True string

指定目標工作區的物件庫 ID。
自訂1
 custom1 string

指定要與工作區範本相關聯的 custom1 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂2
 custom2 string

指定要與工作區範本相關聯的 custom2 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂3
 custom3 string

指定要與工作區範本相關聯的 custom3 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂4
 custom4 string

指定要與工作區範本相關聯的 custom4 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂5
 custom5 string

指定要與工作區範本相關聯的 custom5 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂6
 custom6 string

指定要與工作區範本相關聯的 custom6 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂7
 custom7 string

指定要與工作區範本相關聯的 custom7 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂8
 custom8 string

指定要與工作區範本相關聯的 custom8 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂9
 custom9 string

指定要與工作區範本相關聯的 custom9 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂10
 custom10 string

指定要與工作區範本相關聯的 custom10 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂11
 custom11 string

指定要與工作區範本相關聯的 custom11 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂12
 custom12 string

指定要與工作區範本相關聯的 custom12 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂17
 custom17 double

指定 custom17 的值。
自訂18
 custom18 double

指定 custom18 的值。
自訂19
 custom19 double

指定 custom19 的值。
客製化20
 custom20 double

指定 custom20 的值。
自訂21
 custom21 string

指定要在與工作區範本相關聯的 custom21 中搜尋的值 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
自訂22
 custom22 string

指定要在與工作區範本相關聯的 custom22 中搜尋的值 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
客製化23
 custom23 string

指定要在與工作區範本相關聯的 custom23 中搜尋的值 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
定制24
 custom24 string

指定要在與工作區範本相關聯的 custom24 中搜尋的值 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
Custom21（下限）
 custom21_from string

指定要搜尋的 custom21 （ISO 8601 日期時間格式） 的下限。 此內容不是由 iManage Work 保留，也不是經過驗證的值。 它旨在根據貴公司的要求進行客製化。
Custom21（上限）
 custom21_to string

指定要搜尋的 custom21 （ISO 8601 日期時間格式） 的上限。 此內容不是由 iManage Work 保留，也不是經過驗證的值。 它旨在根據貴公司的要求進行客製化。
Custom21 （相對）
 custom21_relative string

指定要相對於目前日期搜尋的日期範圍。 此參數的格式為 [begin]：[end][時間單位 （d、m 或 y）]。 例如， -15：1d 指定日期範圍，從目前日期前 15 天到目前日期後一天 （未來一天）。
Custom22（下限）
 custom22_from string

指定要搜尋的 custom22 （ISO 8601 日期時間格式） 的下限。 此內容不是由 iManage Work 保留，也不是經過驗證的值。 它旨在根據貴公司的要求進行客製化。
Custom22（上限）
 custom22_to string

指定要搜尋的 custom22 （以 ISO 8601 日期時間格式） 的上限。 此內容不是由 iManage Work 保留，也不是經過驗證的值。 它旨在根據貴公司的要求進行客製化。
Custom22 （相對）
 custom22_relative string

指定要相對於目前日期搜尋的日期範圍。 此參數的格式為 [begin]：[end][時間單位 （d、m 或 y）]。 例如， -15：1d 指定日期範圍，從目前日期前 15 天到目前日期後一天 （未來一天）。
Custom23（下限）
 custom23_from string

指定要搜尋的 custom23 （ISO 8601 日期時間格式） 的下限。 此內容不是由 iManage Work 保留，也不是經過驗證的值。 它旨在根據貴公司的要求進行客製化。
Custom23（上限）
 custom23_to string

指定要搜尋的 custom23 （ISO 8601 日期時間格式） 的上限。 此內容不是由 iManage Work 保留，也不是經過驗證的值。 它旨在根據貴公司的要求進行客製化。
Custom23 （相對）
 custom23_relative string

指定要相對於目前日期搜尋的日期範圍。 此參數的格式為 [begin]：[end][時間單位 （d、m 或 y）]。 例如， -15：1d 指定日期範圍，從目前日期前 15 天到目前日期後一天 （未來一天）。
Custom24（下限）
 custom24_from string

指定要搜尋的 custom24 （ISO 8601 日期時間格式） 的下限。 此內容不是由 iManage Work 保留，也不是經過驗證的值。 它旨在根據貴公司的要求進行客製化。
Custom24（上限）
 custom24_to string

指定要搜尋的 custom24 （ISO 8601 日期時間格式） 的上限。 此內容不是由 iManage Work 保留，也不是經過驗證的值。 它旨在根據貴公司的要求進行客製化。
Custom24 （相對）
 custom24_relative string

指定要相對於目前日期搜尋的日期範圍。 此參數的格式為 [begin]：[end][時間單位 （d、m 或 y）]。 例如， -15：1d 指定日期範圍，從目前日期前 15 天到目前日期後一天 （未來一天）。
客製化25
 custom25 boolean

指定要搜尋的 custom25 值。
客製化26
 custom26 boolean

指定要搜尋的 custom26 值。
自訂27
 custom27 boolean

指定要搜尋的 custom27 值。
客製化28
 custom28 boolean

指定要搜尋的 custom28 值。
自訂29
 custom29 string

指定要與 custom29 相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
客製化30
 custom30 string

指定要與 custom30 相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。

取得工作區設定檔

作業識別碼：
GetWorkspaceProfile

取得工作區設定檔，以及選擇性地取得工作區允許的作業清單。

參數

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

指定工作區的識別碼。 例如，'ACTIVE_US！427'。

取得文件版本

作業識別碼：
GetDocumentVersions

取得目前使用者有權存取指定文件之所有版本的設定檔。

參數

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

指定文件的 ID。 例如，'ACTIVE_US！453.1'。

傳回

名稱 路徑 類型 Description
文件設定檔
 data array of MinimalDocumentProfileInArray

取得文件的核心擴充中繼資料屬性

作業識別碼：
GetCoreEMPropertiesForDocument

取得文件的核心擴充中繼資料屬性。

參數

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

指定文件的 ID。 例如，'ACTIVE_US！453.1'。
最新
 latest boolean

指定取得文件的最新版本。

取得文件設定檔

作業識別碼：
GetDocumentProfile

取得與特定文件識別碼相關聯的文件內容。

參數

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

指定文件的 ID。 例如，'ACTIVE_US！453.1'。
獲取最新版本
 latest boolean

指定取得文件的最新版本。

取得權限

作業識別碼：
GetPermissions

取得文件、資料夾或工作區的使用者或群組存取權限屬性。 回應屬性可能會因使用者或群組權限而異。

參數

名稱 機碼 必要 類型 Description
物件類型
 objectType True string

指定物件的類型。
物件識別碼
 objectId True string

指定文件、資料夾或工作區的識別碼。 文件 ID 的範例是「ACTIVE_US！453.1」。 資料夾或工作區識別碼的範例是 'ACTIVE_US！123'。

傳回

名稱 路徑 類型 Description
預設安全性
 data.default_security string

指出物件的預設安全性。 可能的值為 'inherit'、'public'、'view' 或 'private'。
繼承的預設安全性
 data.inherited_default_security string

指出當預設安全性設定為「繼承」時，資料夾繼承的預設安全性。 可能的值為 'public'、'view' 或 'private'。
存取權限
 data.acl AccessPermissions

指出一或多個使用者和/或群組的存取權限集合。
所有使用者 ID
 data.all_user_ids string

指出所有使用者 ID 的清單，串連為字串，並以分號區隔。
所有群組 ID
 data.all_group_ids string

指出所有群組 ID 的清單，串連為字串，並以分號分隔。

取得程式庫

作業識別碼：
GetLibraries

取得使用者有權存取的程式庫清單。

傳回

名稱 路徑 類型 Description
資料
 data array of object

指出使用者有權存取的檔案庫清單。
ID
 data.id string

指出文件庫的名稱。
名稱
 data.display_name string

指出文件庫的顯示名稱。
類型
 data.type string

指出文件庫的類型。 可能的值為 'worksite' 或 'linksite'。
隱藏
 data.is_hidden boolean

指出檔案庫是否已隱藏。

取得群組成員

作業識別碼：
GetGroupMembers

取得屬於指定群組並符合指定條件的使用者詳細資料。

參數

名稱 機碼 必要 類型 Description
圖書館 ID
 libraryId True string

指定目標群組的物件庫 ID。
群組識別碼
 groupId True string

指定群組的識別碼。 例如，「行銷」。
登入狀態
 logon_status string

根據每個使用者目前的「allow_logon」屬性值，為使用者指定篩選器。
限制
 limit integer

指定要傳回的成員數目上限，而不論群組中的成員總數為何。
首選圖書館
 preferred_library string

指定只傳回其偏好程式庫符合所提供值的使用者。
地點
 location string

指定要根據使用者地理位置尋找使用者的位置。 此搜尋不區分大小寫。 不支援萬用字元 （*）。

傳回

名稱 路徑 類型 Description
資料
 data array of UserProfileInArray

指出屬於指定群組且符合指定準則的使用者清單。

取得課程

作業識別碼：
GetClasses

取得文件庫中符合指定準則的可用文件類別清單。

參數

名稱 機碼 必要 類型 Description
圖書館 ID
 libraryId True string

指定目標類別的程式庫識別碼。
類別識別碼
 alias string

指定要搜尋的一或多個類別的識別碼。 可以是逗號分隔的清單。 此搜尋不區分大小寫。 支援萬用字元 （*） 和部分相符。
預設安全性
 default_security string

指定預設安全性存取層級。
Description
 description string

指定要在描述欄位中比對的文字。 此搜尋不區分大小寫。 支援萬用字元 （*）。 不支援部分相符。
回音
 echo boolean

指定此類別的文件是否可以回應文件。
HIPAA
 hipaa boolean

指定此類別的文件是否使用符合 HIPAA 規範的加密。
可轉位
 indexable boolean

指定此類別的文件是否由系統的全文檢索索引子編製索引。
Query
 query string

指定要與 ID 或描述欄位相符的文字。 此搜尋不區分大小寫。 支援萬用字元 （*） 和部分相符。
必要子類別
 subclass_required boolean

指定類別是否具有必要的子類別。

傳回

名稱 路徑 類型 Description
最相符的類別識別碼
 data.topMatchingId string

指出最相符類別的識別碼。 例如，“請願書”。
頂級匹配類別描述
 data.topMatchingDescription string

指出最相符類別的描述。
results
 data.results array of object

指出程式庫中符合指定準則的可用類別清單。
Description
 data.results.description string

指出有關類別的其他資訊。
HIPAA 是
 data.results.hipaa boolean

指出文件是否已加密。
ID
 data.results.id string

指出類別的識別碼。 例如，“請願書”。
可索引
 data.results.indexable boolean

指出系統是否為文件編製索引。
預設安全性
 data.results.default_security string

指出預設安全性存取層級。 可能的值為 'public'、'view'、'private'。
Retain
 data.results.retain integer

指出將此類別的非作用中文件標示為已過期之前的天數。
必填欄位
 data.results.required_fields array of string

指出在建立或更新此類別的文件時要輸入的必要自訂內容。
被陰影
 data.results.shadow boolean

指出此類別的文件在簽入後是否在使用者的本機電腦上隱藏 （保留）。
子類別是否為必要
 data.results.subclass_required boolean

指出此類別是否需要子類別。

在文件上設定核心擴充中繼資料屬性

作業識別碼：
SetCoreEMPropertiesForDocument

設定文件上的核心擴充中繼資料屬性。

參數

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

指定文件的 ID。 例如，'ACTIVE_US！453.1'。
名稱
 key True string

指定核心擴充中繼資料屬性的名稱。
價值觀
 value True string

指定要針對核心擴充中繼資料屬性設定的一或多個值，並以分號分隔。 若要取消設定值，請將索引鍵的值設定為用單引號或雙引號括住的空字串。

建立工作區

作業識別碼：
CreateWorkspace

根據選取的範本建立新的工作區。 工作區範本是預先定義的工作區，其結構會複製到新工作區。 建立新工作區時，會自動強制執行工作區範本的限制。

參數

名稱 機碼 必要 類型 Description
圖書館 ID
 libraryId True string

指定目標工作區的物件庫 ID。
Template
 templateId True string

指定要用來建立工作區及其子項的工作區範本。
名稱
 name True string

指定工作區的名稱。
建立子項
 createChildren True string

指定建立所有資料夾 （選用和必要） 或僅建立必要的資料夾。
工作區擁有者
 owner string

指定工作區的擁有者。 您必須是 iManage Work 系統管理員，才能設定工作區的擁有者。
預設安全性
 default_security string

指定預設存取層級。 如果未指定，則會使用所選範本的預設存取層次。
Description
 description string

指定工作區的其他資訊。
自訂1
 custom1 string

指定要與新建立的工作區相關聯的 custom1 值。 此值會覆寫所選範本工作區的 custom1 值 （如果存在）。 如果子資料夾已設定 custom1 值，則不會覆寫這些子資料夾的 custom1 值。
自訂2
 custom2 string

指定要與新建立的工作區相關聯的 custom2 值。 若要指定 custom2 的值，您也必須在相同的要求中指定 custom1 的值，這是由於其父子關係所致。 此值會覆寫所選範本工作區的 custom2 值 （如果存在）。 如果子資料夾已設定 custom2 值，則不會覆寫這些子資料夾的 custom2 值。
自訂3
 custom3 string

指定 custom3 的值。
自訂4
 custom4 string

指定 custom4 的值。
自訂5
 custom5 string

指定 custom5 的值。
自訂6
 custom6 string

指定 custom6 的值。
自訂7
 custom7 string

指定 custom7 的值。
自訂8
 custom8 string

指定 custom8 的值。
自訂9
 custom9 string

指定 custom9 的值。
自訂10
 custom10 string

指定 custom10 的值。
自訂11
 custom11 string

指定 custom11 的值。
自訂12
 custom12 string

指定 custom12 的值。
自訂13
 custom13 string

指定 custom13 的值。
自訂14
 custom14 string

指定 custom14 的值。
自訂15
 custom15 string

指定 custom15 的值。
自訂16
 custom16 string

指定 custom16 的值。
自訂17
 custom17 double

指定 custom17 的值。
自訂18
 custom18 double

指定 custom18 的值。
自訂19
 custom19 double

指定 custom19 的值。
客製化20
 custom20 double

指定 custom20 的值。
自訂21
 custom21 string

以 ISO 8601 日期時間格式指定 custom21 的值。
自訂22
 custom22 string

以 ISO 8601 日期時間格式指定 custom22 的值。
客製化23
 custom23 string

以 ISO 8601 日期時間格式指定 custom23 的值。
定制24
 custom24 string

以 ISO 8601 日期時間格式指定 custom24 的值。
客製化25
 custom25 boolean

指定 custom25 的值。
客製化26
 custom26 boolean

指定 custom26 的值。
自訂27
 custom27 boolean

指定 custom27 的值。
客製化28
 custom28 boolean

指定 custom28 的值。
自訂29
 custom29 string

指定 custom29 的值。
客製化30
 custom30 string

指定 custom30 的值。 若要指定 custom30 的值，您也必須在相同的要求中指定 custom29 的值，這是由於其父子關係所致。
是否正常外部
 is_external_as_normal boolean

指定工作區可以視為公用工作區。 如果設定為 'true' 且 'default_security' 不是 'private'，則將 'is_external' 設定為 'true'。
專案客製化1
 project_custom1 string

指定工作區的其他資訊。 此欄位與與內容項目（例如文件、工作區或資料夾）相關聯的中繼資料自訂欄位不同。 這是描述性文字，不需要格式化，也不會經過驗證。
專案自訂2
 project_custom2 string

指定工作區的其他資訊。 此欄位與與內容項目（例如文件、工作區或資料夾）相關聯的中繼資料自訂欄位不同。 這是描述性文字，不需要格式化，也不會經過驗證。
專案自訂3
 project_custom3 string

指定工作區的其他資訊。 此欄位與與內容項目（例如文件、工作區或資料夾）相關聯的中繼資料自訂欄位不同。 這是描述性文字，不需要格式化，也不會經過驗證。
工作區子類別
 subclass string

根據工作區所包含文件的子類別來指定工作區的子類別。

建立文件關係

作業識別碼：
CreateDocumentRelation

在資源庫中的指定文件之間建立關係。

參數

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

指定要關聯的主要文件的 ID。 例如，'ACTIVE_US！453.1'。
相關文件 ID
 relatedDocumentId True string

指定要關聯的文件 ID。 例如，'ACTIVE_US！453.1'。

傳回

response
object

影印文件

作業識別碼：
CopyDocument

將文件複製到指定的資料夾。

參數

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

指定文件的 ID。 例如，'ACTIVE_US！453.1'。
目的地資料夾識別碼
 folderId True string

指定要將文件複製到的目標資料夾 ID。 例如，“ACTIVE_US！987”。

傳回

名稱 路徑 類型 Description
文件存取
 data.access string

指出文件或容器的存取層級權限集。 存取層級由作者或具有專案完整存取權的使用者設定。 可能的值為 'no_access'、'read'、'read_write'、'full_access'。
Alias
 data.alias string

指出此文件的別名。
作者
 data.author string

指出建立文件之使用者的 ID。 例如，'JSMITH'。
作者描述
 data.author_description string

指出文件作者的其他資訊。
副本
 data.cc string

指出抄送電子郵件的收件者。 僅適用於電子郵件。
文件類別
 data.class string

指出文件的類別。
文件類別描述
 data.class_description string

指出文件類別的其他資訊。
內容類型
 data.content_type string

指出文件內容類型。
文件建立日期
 data.create_date string

指示將文件匯入 iManage Work 系統的日期和時間 （ISO 8601 格式）。 此日期可能與「file_create_date」不同。
資料庫
 data.database string

指出儲存文件的資料庫。
文件預設安全性
 data.default_security string

指出預設安全性存取層級。 可能的值為 'inherit'、'private'、'view'、'public'。
文件編號
 data.document_number integer

指出文件的文件編號。
文件網址
 data.document_url string

指出文件的可共用連結。
文件編輯日期
 data.edit_date string

指出文件最近變更的日期和時間 （ISO 8601 格式）。
設定檔編輯日期
 data.edit_profile_date string

指出文件設定檔最近變更的日期和時間 （ISO 8601 格式）。
文件擴展
 data.extension string

指出文件的副檔名 （也稱為應用程式副檔名）。
檔案建立日期
 data.file_create_date string

指出建立檔案的日期和時間 （以 ISO 8601 格式）。 該檔案可能是在 iManage Work 系統之外建立的。 此日期可能與「create_date」不同。
檔案編輯日期
 data.file_edit_date string

指出檔案最近變更的日期和時間 （ISO 8601 格式）。 該檔案在上傳到 iManage Work 系統之前可能已更改。
寄件者
 data.from string

指出電子郵件的寄件者。 僅適用於電子郵件。
完整檔案名稱
 data.full_file_name string

指出文件的完整檔名。 包括副檔名。
有依戀
 data.has_attachment boolean

指出電子郵件是否有附件。 僅適用於電子郵件。
基本文件屬性
 data.basic_properties string

指出包含基本文件屬性的可內嵌 '' 元素。
文件 ID
 data.id string

指出文件的 ID。 例如，'ACTIVE_US！453.1'。
可索引
 data.indexable boolean

指出系統是否為文件編製索引。
已出庫
 data.is_checked_out boolean

指出文件是否已出庫使用。
已宣告
 data.is_declared boolean

指出文件是否宣告為記錄。 宣告為記錄的文件無法編輯或刪除，除非由 iManage Work 系統管理者編輯或刪除。
是外部的
 data.is_external boolean

指出文件是否與外部使用者共用。
是否正常外部
 data.is_external_as_normal boolean

指出文件是否如常在外部。
HIPAA 是
 data.is_hipaa boolean

指出文件是否已加密。
正在使用中
 data.is_in_use boolean

指出文件是否正在使用中。
文件連結
 data.iwl string

指出文件的 iManage 工作連結 （iWL）。 iWL 用於由具有「read_write」或「full_access」的使用者以受保護的檢視模式開啟文件。
最後一個使用者
 data.last_user string

指出最近編輯文件的使用者 ID。 例如，'JSMITH'。
上位使用者描述
 data.last_user_description string

指出最近編輯文件的最後一個使用者的其他資訊。
文件名稱
 data.name string

指出文件的檔案名稱。
Operator
 data.operator string

指出已出庫使用文件或目前正在編輯其設定檔的使用者 ID。 例如，'JSMITH'。
操作員說明
 data.operator_description string

指出運運算元的其他資訊。
收貨日期
 data.received_date string

指出收到電子郵件的日期和時間（ISO 8601 格式）。 僅適用於電子郵件。
保留天數
 data.retain_days integer

指出文件符合封存資格之前的天數。 僅適用於非使用中的文件。
傳送日期
 data.sent_date string

指出傳送電子郵件的日期和時間 （ISO 8601 格式）。 僅適用於電子郵件。
文件大小
 data.size integer

指出文件的大小（以位元組為單位）。
子類別
 data.subclass string

指出文件的子類別。
子類別描述
 data.subclass_description string

指出文件子類別的其他資訊。
發往
 data.to string

指出電子郵件的收件者。 僅適用於電子郵件。
類型
 data.type string

指出文件類型。 例如，WORD for Microsoft Word。 如需目前的類型清單，請聯絡您的 iManage Work 系統管理員。
類型說明
 data.type_description string

指出文件類型的其他資訊。
文件版本
 data.version integer

指出文件的版本號碼。
工作區識別碼
 data.workspace_id string

指出文件工作區的 ID。 例如，'ACTIVE_US！427'。
工作區名稱
 data.workspace_name string

指出文件工作區的名稱。
Ws類型
 data.wstype string

指出物件的 iManage 工作類型。 可能的值為 'document'、'folder'、'workspace'、'email'、'document_shortcut'、'folder_shortcut'、'workspace_shortcut'、'user'。
自訂13
 data.custom13 string

表示 custom13 的值。
自訂14
 data.custom14 string

表示 custom14 的值。
自訂15
 data.custom15 string

表示 custom15 的值。
自訂16
 data.custom16 string

表示 custom16 的值。
自訂21
 data.custom21 string

以 ISO 8601 日期時間格式指出 custom21 屬性的值。
自訂22
 data.custom22 string

以 ISO 8601 日期時間格式指出 custom22 屬性的值。

搜尋使用者

作業識別碼：
SearchUsers

搜尋符合指定搜尋準則的 iManage Work 使用者。

參數

名稱 機碼 必要 類型 Description
電子郵件識別碼
 email string

指定要搜尋的電子郵件 ID。 例如，'JSMITH@XYZ.COM'。

傳回

名稱 路徑 類型 Description
允許登入
 data.topMatchingUser.allow_logon boolean

指出是否允許使用者登入。
自訂1
 data.topMatchingUser.custom1 string

指出有關使用者的其他資訊。
自訂2
 data.topMatchingUser.custom2 string

指出有關使用者的其他資訊。
自訂3
 data.topMatchingUser.custom3 string

指出有關使用者的其他資訊。
目錄 ID
 data.topMatchingUser.directory_id string

指出外部目錄 （例如 ADFS） 的識別碼，用於使用者設定檔同步處理。
專有名稱
 data.topMatchingUser.distinguished_name string

指出物件的名稱，代表將項目追蹤回 LDAP 樹狀結構根目錄的名稱完整路徑。
編輯日期
 data.topMatchingUser.edit_date string

指出使用者設定檔最近變更的日期和時間 （ISO 8601 格式）。
Email
 data.topMatchingUser.email string

指出使用者的電子郵件 ID。
Exchange 自動探索 URL
 data.topMatchingUser.exch_autodiscover string

指出使用者的 Exchange 伺服器詳細資料。
Extension
 data.topMatchingUser.extension string

指出使用者的電話號碼分機。
登入嘗試失敗
 data.topMatchingUser.failed_logins integer

指出使用者目前嘗試登入失敗的次數。
傳真
 data.topMatchingUser.fax string

表示使用者的傳真號碼。
強制更改密碼
 data.topMatchingUser.force_password_change boolean

表示使用者必須在下次登入時變更其密碼。 僅適用於虛擬用戶，由「user_nos」值「2」表示。
全名
 data.topMatchingUser.full_name string

指出使用者的完整名稱。
General
 data.topMatchingUser.general string

指出使用者的一般資訊。
ID
 data.topMatchingUser.id string

指出使用者的 ID。 例如，'JSMITH'。
是外部的
 data.topMatchingUser.is_external boolean

表示外部使用者。 外部使用者的存取權限有限，通常用於臨時團隊成員、顧問或組織外部的人員。
上次同步時間
 data.topMatchingUser.last_sync_ts string

指出使用者設定檔與外部目錄 （例如 LDAP 或 Microsoft Active Directory （ADFS） ） 的上次同步處理時間 （以 ISO 8601 日期時間格式）。
地點
 data.topMatchingUser.location string

指出使用者的地理位置。
密碼永不過期
 data.topMatchingUser.password_never_expire boolean

指出使用者的密碼是否永遠不會過期。
電話號碼
 data.topMatchingUser.phone string

指出使用者的電話號碼。
首選圖書館
 data.topMatchingUser.preferred_library string

指出偏好的程式庫。 偏好的程式庫是使用者的預設程式庫。 每個使用者都必須有一個偏好的程式庫。
密碼變更時間
 data.topMatchingUser.pwd_changed_ts string

指出上次變更使用者密碼的時間 （以 ISO 8601 日期時間格式）。 這僅適用於虛擬使用者（其使用者NOS為2）。
SSID
 data.topMatchingUser.ssid string

指出使用者的唯一系統產生 ID。
網域
 data.topMatchingUser.user_domain string

指出使用者目錄服務的完整網域名稱。
擴充 ID
 data.topMatchingUser.user_id_ex string

指出從外部目錄 （例如 Microsoft Active Directory （ADFS） ） 接收的使用者 ID 的原始值。
NOS
 data.topMatchingUser.user_nos integer

指出使用者從中同步處理的作業系統類型。 可能的值為 2 （虛擬使用者） 和 6 （企業使用者）。 如需相關資訊，請聯絡您的 iManage Work 系統管理員。
Number
 data.topMatchingUser.user_num integer

指出使用者的數值系統識別碼。
results
 data.results array of UserProfileInArray

搜尋工作區

作業識別碼：
SearchWorkspaces

搜尋工作區。

參數

名稱 機碼 必要 類型 Description
圖書館 ID
 libraryId True string

指定目標工作區的物件庫 ID。
Title
 name string

指定要在工作區的 name 屬性中搜尋的字串。 此搜尋不區分大小寫。
所有者
 owner string

指定要與工作區相關聯的擁有者相符的字串。 此搜尋不區分大小寫。
Keyword
 anywhere string

指定要在工作區設定檔中任何位置搜尋的文字。 此搜尋不區分大小寫。
Description
 description string

指定要在工作區的描述內容中搜尋的文字。 此搜尋不區分大小寫。
子類別
 subclass string

指定要與工作區相關聯的子類別值相符的值。 此搜尋不區分大小寫。
自訂1
 custom1 string

指定要與工作區相關聯的 custom1 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂2
 custom2 string

指定要與工作區相關聯的 custom2 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂3
 custom3 string

指定要與工作區相關聯的 custom3 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂4
 custom4 string

指定要與工作區相關聯的 custom4 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂5
 custom5 string

指定要與工作區相關聯的 custom5 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂6
 custom6 string

指定要與工作區相關聯的 custom6 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂7
 custom7 string

指定要與工作區相關聯的 custom7 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂8
 custom8 string

指定要與工作區相關聯的 custom8 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂9
 custom9 string

指定要與工作區相關聯的 custom9 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂10
 custom10 string

指定要與工作區相關聯的 custom10 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂11
 custom11 string

指定要與工作區相關聯的 custom11 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂12
 custom12 string

指定要與工作區相關聯的 custom12 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂13
 custom13 string

指定要與工作區相關聯的 custom13 值相符的值。 此搜尋不區分大小寫。 支援萬用字元 （*） 和部分相符。
自訂14
 custom14 string

指定要與工作區相關聯的 custom14 值相符的值。 此搜尋不區分大小寫。 支援萬用字元 （*） 和部分相符。
自訂15
 custom15 string

指定要與工作區相關聯的 custom15 值相符的值。 此搜尋不區分大小寫。 支援萬用字元 （*） 和部分相符。
自訂16
 custom16 string

指定要與工作區相關聯的 custom16 值相符的值。 此搜尋不區分大小寫。 支援萬用字元 （*） 和部分相符。
自訂17
 custom17 string

指定要與工作區相關聯的 custom17 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂18
 custom18 string

指定要與工作區相關聯的 custom18 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
自訂19
 custom19 string

指定要與工作區相關聯的 custom19 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
客製化20
 custom20 string

指定要與工作區相關聯的 custom20 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
Custom21（下限）
 custom21_from string

指定要在與工作區相關聯的 custom21 屬性中搜尋的下限 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
Custom21（上限）
 custom21_to string

指定要在與工作區相關聯的 custom21 屬性中搜尋的上限 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
Custom22（下限）
 custom22_from string

指定要在與工作區相關聯的 custom22 屬性中搜尋的下限 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
Custom22（上限）
 custom22_to string

指定要在與工作區相關聯的 custom22 屬性中搜尋的上限 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
Custom23（下限）
 custom23_from string

指定要在與工作區相關聯的 custom23 內容中搜尋的下限 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
Custom23（上限）
 custom23_to string

指定要在與工作區相關聯的 custom23 屬性中搜尋的上限 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
Custom24（下限）
 custom24_from string

指定要在與工作區相關聯的 custom24 屬性中搜尋的下限 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
Custom24（上限）
 custom24_to string

指定要在與工作區相關聯的 custom24 屬性中搜尋的上限 （以 ISO 8601 日期時間格式）。 此搜尋不區分大小寫。 對於工作區，此內容的使用是針對您的 iManage Work 安裝自訂的。
客製化25
 custom25 boolean

指定要與工作區相關聯的 custom25 值相符的值。
客製化26
 custom26 boolean

指定要與工作區相關聯的 custom26 值相符的值。
自訂27
 custom27 boolean

指定要與工作區相關聯的 custom27 值相符的值。
客製化28
 custom28 boolean

指定要與工作區相關聯的 custom28 值相符的值。
自訂29
 custom29 string

指定要與工作區相關聯的 custom29 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。
客製化30
 custom30 string

指定要與工作區相關聯的 custom30 值相符的值。 此搜尋不區分大小寫。 不支援萬用字元 （*） 和部分相符。 若要指定 custom30 的值，您也必須在相同的要求中指定 custom29 的值，這是由於其父子關係所致。

搜尋核心擴充中繼資料分類節點值

作業識別碼：
SearchCoreEMTaxonomyNodeValues

搜尋符合指定搜尋準則的核心延伸中繼資料分類節點值。

參數

名稱 機碼 必要 類型 Description
圖書館 ID
 libraryId True string

指定要執行搜尋的檔案庫 ID。
分類屬性
 taxonomyProperty True string

指定要搜尋節點值的分類屬性。
ID
 id string

指定分類節點值的顯示識別碼。 此搜尋不區分大小寫。 不支援部分相符。
Query
 query string

指定使用萬用字元 （*） 搜尋來比對分類節點值的查詢，提供顯示 ID 或描述的部分相符項。
節點狀態
 enabled_state string

指定只傳回已啟用或停用或兩者兼而有之的分類節點值。
包含路徑
 include_path boolean

指定傳回相符節點值的完整路徑。 路徑是排序清單，從分類中的頂層節點開始，然後是所有節點，一直到相符節點的直接父節點。
上階節點 SSID
 children_of_ssid string

指定要限制搜尋的上階分類節點的唯一系統產生 ID。
僅限直接子女
 immediate_children_only boolean

指定將搜尋結果限制為「祖先節點 SSID」所指定分類節點的直接後代。 搜尋可以限制為分類的根層級，方法是指定用單引號或雙引號括住的「祖先節點 SSID」空字串。

傳回

名稱 路徑 類型 Description
SSID
 data.topMatchingResult.created_by.ssid string

指出建立最相符節點值之使用者的唯一系統產生 ID。
建立日期
 data.topMatchingResult.create_date string

指出建立最相符節點值的日期和時間 （以 ISO 8601 格式）。
Description
 data.topMatchingResult.description string

指出最相符節點值的描述。
SSID
 data.topMatchingResult.edited_by.ssid string

指出上次編輯最相符節點值之使用者的唯一系統產生 ID。
編輯日期
 data.topMatchingResult.edit_date string

指出上次編輯最相符節點值的日期和時間 （以 ISO 8601 格式）。
已啟用
 data.topMatchingResult.enabled boolean

指出是否已啟用最相符的節點值。
ID
 data.topMatchingResult.id string

指出最相符節點值的顯示識別碼。
SSID
 data.topMatchingResult.parent.ssid string

指出最相符節點值之直接母節點的唯一系統產生 ID。
SSID
 data.topMatchingResult.ssid string

指出最相符節點值的唯一系統產生 ID。
路徑
 data.topMatchingResult.path array of object

指出最相符節點值的完整路徑。 路徑是排序清單，從分類中的頂層節點開始，然後是所有節點，一直到相符節點的直接父節點。
每個 ID
 data.topMatchingResult.path.id string

指出頂端相符節點路徑中節點值的顯示識別碼。
每個SSID
 data.topMatchingResult.path.ssid string

指出最相符節點路徑中節點值的唯一系統產生 ID。
核心擴充中繼資料分類搜尋結果
 data.results array of TaxonomyNodeValue

指出一或多個符合搜尋的核心延伸中繼資料分類節點值。
所有分類節點 SSID
 data.all_taxonomy_ssids string

指出所有分類節點 SSID 的清單，串連為字串並以分號分隔。

搜尋資料夾

作業識別碼：
SearchFolders

搜尋資料夾。

參數

名稱 機碼 必要 類型 Description
圖書館 ID
 libraryId True string

指定目標資料夾的物件庫 ID。
容器識別碼
 container_id string

指定要從中傳回資料夾的工作區或資料夾的 ID。 例如，“ACTIVE_US！987”。 如果提供此參數，則只會從指定的工作區或資料夾傳回資料夾。
資料夾描述
 description string

指定要在資料夾的描述屬性中找到的值。 此搜尋不區分大小寫。 支援部分相符。
資料夾電子郵件地址
 email string

指定要與資料夾電子郵件地址相符的電子郵件地址。 例如，'email1234@ajubalaw.com'。
資料夾名稱
 name string

指定要在資料夾的 name 屬性中找到的值。 此搜尋不區分大小寫。 支援部分相符。
資料夾擁有者
 owner string

指定要與與資料夾相關聯的擁有者相符的字串。 此搜尋不區分大小寫。 支援部分相符。
工作區名稱
 workspace_name string

指定資料夾所屬父工作區的名稱。 此搜尋不區分大小寫。 支援部分相符。

新增文件參考

作業識別碼：
AddDocumentReference

在另一個資料夾中新增文件參照或文件捷徑。

參數

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

指定文件的 ID。 例如，'ACTIVE_US！453.1'。
資料夾 ID
 folderId True string

指定資料夾的 ID。 例如，'ACTIVE_US！773'。

傳回

名稱 路徑 類型 Description
文件參考 ID
 data.id string

表示文件參考和document_shortcut。
Ws類型
 data.wstype string

指出物件的 iManage 工作類型。 可能的值為 'document'、'document_shortcut'、'email'。

新增文件歷程記錄項目

作業識別碼：
AddDocumentHistoryEntry

將項目新增為文件歷程記錄中的事件。

參數

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

指定文件的 ID。 例如，'ACTIVE_US！453.1'。
Activity
 activity_code True integer

指定對文件執行的活動類型。
評論
 comments string

指定活動的任何其他資訊。
持續時間
 duration integer

指定使用者處理文件所花費的秒數。

傳回

名稱 路徑 類型 Description
資料
 data object

更新工作區

作業識別碼：
UpdateWorkspace

更新指定工作區的資訊。 若要刪除字串欄位的現有值，請將欄位的值設定為以單引號或雙引號括起來的空字串。

參數

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

指定要更新的工作區 ID。 例如，'ACTIVE_US！427'。
名稱
 name string

指定工作區的名稱。
工作區擁有者
 owner string

指定工作區的擁有者。
自訂1
 custom1 string

指定 custom1 的值。
自訂2
 custom2 string

指定 custom2 的值。 若要指定 custom2 的值，您也必須在相同的要求中指定 custom1 的值，這是由於其父子關係所致。
自訂3
 custom3 string

指定 custom3 的值。
自訂4
 custom4 string

指定 custom4 的值。
自訂5
 custom5 string

指定 custom5 的值。
自訂6
 custom6 string

指定 custom6 的值。
自訂7
 custom7 string

指定 custom7 的值。
自訂8
 custom8 string

指定 custom8 的值。
自訂9
 custom9 string

指定 custom9 的值。
自訂10
 custom10 string

指定 custom10 的值。
自訂11
 custom11 string

指定 custom11 的值。
自訂12
 custom12 string

指定 custom12 的值。
自訂13
 custom13 string

指定 custom13 的值。
自訂14
 custom14 string

指定 custom14 的值。
自訂15
 custom15 string

指定 custom15 的值。
自訂16
 custom16 string

指定 custom16 的值。
自訂17
 custom17 double

指定 custom17 的值。
自訂18
 custom18 double

指定 custom18 的值。
自訂19
 custom19 double

指定 custom19 的值。
客製化20
 custom20 double

指定 custom20 的值。
自訂21
 custom21 string

以 ISO 8601 日期時間格式指定 custom21 的值。
自訂22
 custom22 string

指定 custom22 的值，採用 ISO 8601 日期時間格式。
客製化23
 custom23 string

以 ISO 8601 日期時間格式指定 custom23 的值。
定制24
 custom24 string

指定 custom24 的值，採用 ISO 8601 日期時間格式。
客製化25
 custom25 boolean

指定 custom25 的值。
客製化26
 custom26 boolean

指定 custom26 的值。
自訂27
 custom27 boolean

指定 custom27 的值。
客製化28
 custom28 boolean

指定 custom28 的值。
自訂29
 custom29 string

指定 custom29 的值。
客製化30
 custom30 string

指定 custom30 的值。 若要指定 custom30 的值，您也必須在相同的要求中指定 custom29 的值，這是由於其父子關係所致。
預設安全性
 default_security string

指定預設安全性存取層級。
Description
 description string

指定工作區的其他資訊。
是否正常外部
 is_external_as_normal boolean

指定工作區是否可以視為公用工作區。 如果設定為 'true' 且 'default_security' 不是 'private'，則 'is_external' 會設定為 'true'。
專案客製化1
 project_custom1 string

指定工作區的其他資訊。 此欄位與與內容項目 （例如文件、工作區或資料夾） 相關聯的中繼資料自訂欄位不同。 這是描述性文字，不需要格式化，也不會經過驗證。
專案自訂2
 project_custom2 string

指定工作區的其他資訊。 此欄位與與內容項目 （例如文件、工作區或資料夾） 相關聯的中繼資料自訂欄位不同。 這是描述性文字，不需要格式化，也不會經過驗證。
專案自訂3
 project_custom3 string

指定工作區的其他資訊。 此欄位與與內容項目 （例如文件、工作區或資料夾） 相關聯的中繼資料自訂欄位不同。 這是描述性文字，不需要格式化，也不會經過驗證。
工作區子類別
 subclass string

根據工作區所包含文件的子類別來指定工作區的子類別。

更新工作流程狀態

作業識別碼：
UpdateWorkflowState

更新工作流程執行的狀態。 此動作只能在已建立的工作流程中使用，以 iManage 提供的觸發器啟動。

參數

名稱 機碼 必要 類型 Description
圖書館 ID
 libraryId True string

指定定義工作流程之程式庫的 ID。
State
 state True string

指定工作流程執行的目前狀態。
地位
 status string

指定工作流程執行的目前狀態。 長度上限是 128 個字元。
狀態訊息
 statusMessage string

指定工作流程執行目前狀態的自訂訊息。 長度上限是 256 個字元。

傳回

response
object

更新文件設定檔

作業識別碼：
UpdateDocumentProfile

對文件設定檔執行更新。 更新文件設定檔時不得使用文件，且無法更新已出庫文件的設定檔。 在作業之後傳回更新的文件設定檔。

參數

名稱 機碼 必要 類型 Description
Alias
 alias string

指定此文件的別名。
作者
 author string

指定建立文件之使用者的 ID。 例如，'JSMITH'。
評論
 comment string

指定文件的其他資訊。
文件預設安全性
 default_security string

指定預設安全性存取層級。
文件 ID
 documentId True string

指定文件的 ID。 例如，'ACTIVE_US！453.1'。
已宣告
 is_declared boolean

指定是否要將文件宣告為記錄。 宣告為記錄的文件無法編輯或刪除，除非由 iManage Work 系統管理者編輯或刪除。
HIPAA 是
 is_hipaa boolean

指定是否要加密文件。
審核意見
 audit_comment string

指定文件設定檔更新的其他資訊。
文件類別
 class string

指定文件類別。
文件名稱
 name string

指定文件的檔名。
Operator
 operator string

指定已出庫使用文件或目前正在編輯文件設定檔的使用者 ID。 例如，'JSMITH'。
保留天數
 retain_days integer

指定非作用中文件符合封存資格之前的天數。
子類別
 subclass string

指定文件的子類別。
自訂1
 custom1 string

指定 custom1 的值。
自訂2
 custom2 string

指定 custom2 的值。 若要指定 custom2 的值，您也必須在相同的要求中指定 custom1 的值，這是由於其父子關係所致。
自訂3
 custom3 string

指定 custom3 的值。
自訂4
 custom4 string

指定 custom4 的值。
自訂5
 custom5 string

指定 custom5 的值。
自訂6
 custom6 string

指定 custom6 的值。
自訂7
 custom7 string

指定 custom7 的值。
自訂8
 custom8 string

指定 custom8 的值。
自訂9
 custom9 string

指定 custom9 的值。
自訂10
 custom10 string

指定 custom10 的值。
自訂11
 custom11 string

指定 custom11 的值。
自訂12
 custom12 string

指定 custom12 的值。
自訂13
 custom13 string

指定 custom13 的值。
自訂14
 custom14 string

指定 custom14 的值。
自訂15
 custom15 string

指定 custom15 的值。
自訂16
 custom16 string

指定 custom16 的值。
自訂17
 custom17 double

指定 custom17 的值。
自訂18
 custom18 double

指定 custom18 的值。
自訂19
 custom19 double

指定 custom19 的值。
客製化20
 custom20 double

指定 custom20 的值。
自訂21
 custom21 string

以 ISO 8601 日期時間格式指定 custom21 屬性的值。
自訂22
 custom22 string

以 ISO 8601 日期時間格式指定 custom22 屬性的值。
客製化23
 custom23 string

以 ISO 8601 日期時間格式指定 custom23 屬性的值。
定制24
 custom24 string

以 ISO 8601 日期時間格式指定 custom24 屬性的值。
客製化25
 custom25 boolean

指定 custom25 的值。
客製化26
 custom26 boolean

指定 custom26 的值。
自訂27
 custom27 boolean

指定 custom27 的值。
客製化28
 custom28 boolean

指定 custom28 的值。
自訂29
 custom29 string

指定 custom29 的值。
客製化30
 custom30 string

指定 custom30 的值。 若要指定 custom30 的值，您也必須在相同的要求中指定 custom29 的值，這是由於其父子關係所致。

更新權限

作業識別碼：
UpdatePermissions

更新物件的權限。

參數

名稱 機碼 必要 類型 Description
物件類型
 objectType True string

指定物件的類型。
物件識別碼
 objectId True string

指定文件、資料夾或工作區的識別碼。 文件 ID 的範例是「ACTIVE_US！453.1」。 資料夾或工作區識別碼的範例是 'ACTIVE_US！123'。
存取層級
 access_level True string

指定存取層級。
使用者
 users string

指定一或多個使用者來設定存取層級，並以分號分隔。
Groups
 groups string

指定一或多個群組來設定存取層級，並以分號分隔。

傳回

身體
UpdatePermissionsResponse

更新目前或建立新的文件版本

作業識別碼：
UpdateOrCreateNewDocVersion

更新文件的指定版本，或建立新版本。 此動作可以更新文件的設定檔和內容。 如果指定了「更新目前版本」選項，則文件會取代為新文件，並保留先前文件的設定檔。 如果指定「建立新版本」，則會建立繼承資料夾設定檔的新版本文件。 成功執行作業時，會傳回文件設定檔。

參數

名稱 機碼 必要 類型 Description
更新或建立新版本
 updateOrCreate True string

指定更新文件的目前版本或建立新版本。
現有文件 ID
 documentId True string

指定現有文件的 ID。 例如，'ACTIVE_US！556.1'。
保持鎖定
 keep_locked boolean

指定上傳後是否保留文件鎖定。
評論
 comment string

指定有關更新的其他資訊。
文件名稱
 name string

指定文件的名稱。
作者
 author string

指定建立文件之使用者的 iManage 工作 ID。
Operator
 operator string

指定已出庫使用文件或目前正在編輯文件設定檔的使用者 ID。 例如，'JSMITH'。
Class
 class string

指定用於識別和區分文件的類別。 文件類別依類型、部門、地區等分類。
子類別
 subclass string

指定用於識別和區分文件的子類別。 文件子類別依類型、部門、地區等進行分類。
預設安全性
 default_security string

指定預設安全性存取層級。 可能的值為 'inherit'、'private'、'view'、'public'。
HIPAA 是
 is_hipaa boolean

指定是否要加密文件。
保留天數
 retain_days integer

指定文件在標示為封存之前必須處於非作用中的天數。
檔案內容
 file True file

指定檔案的內容。
檔案建立日期
 file_create_date date-time

指定建立檔案的日期和時間 （ISO 8601 格式）。 該檔案可能是在 iManage Work 系統之外建立的。 此日期可能與「create_date」不同。 create_date是 iManage Work 系統建立或匯入檔案的日期。
檔案編輯日期
 file_edit_date date-time

指定檔案最近變更的日期和時間 （ISO 8601 格式）。 該檔案在上傳到 iManage Work 系統之前可能已變更。
自訂1
 custom1 string

指定 custom1 的值。
自訂2
 custom2 string

指定 custom2 的值。 若要指定 custom2 的值，您也必須在相同的要求中指定 custom1 的值，這是由於其父子關係所致。
自訂3
 custom3 string

指定 custom3 的值。
自訂4
 custom4 string

指定 custom4 的值。
自訂5
 custom5 string

指定 custom5 的值。
自訂6
 custom6 string

指定 custom6 的值。
自訂7
 custom7 string

指定 custom7 的值。
自訂8
 custom8 string

指定 custom8 的值。
自訂9
 custom9 string

指定 custom9 的值。
自訂10
 custom10 string

指定 custom10 的值。
自訂11
 custom11 string

指定 custom11 的值。
自訂12
 custom12 string

指定 custom12 的值。
自訂13
 custom13 string

指定 custom13 的值。
自訂14
 custom14 string

指定 custom14 的值。
自訂15
 custom15 string

指定 custom15 的值。
自訂16
 custom16 string

指定 custom16 的值。
自訂17
 custom17 double

指定 custom17 的值。
自訂18
 custom18 double

指定 custom18 的值。
自訂19
 custom19 double

指定 custom19 的值。
客製化20
 custom20 double

指定 custom20 的值。
自訂21
 custom21 string

以 ISO 8601 日期時間格式指定 custom21 的值。
自訂22
 custom22 string

以 ISO 8601 日期時間格式指定 custom22 的值。
客製化23
 custom23 string

指定 ISO 8601 日期時間格式的 custom23 值。
定制24
 custom24 string

以 ISO 8601 日期時間格式指定 custom24 的值。
客製化25
 custom25 boolean

指定 custom25 的值。
客製化26
 custom26 boolean

指定 custom26 的值。
自訂27
 custom27 boolean

指定 custom27 的值。
客製化28
 custom28 boolean

指定 custom28 的值。
自訂29
 custom29 string

指定 custom29 的值。
客製化30
 custom30 string

指定 custom30 的值。 若要指定 custom30 的值，您也必須在相同的要求中指定 custom29 的值，這是由於其父子關係所致。

更新預設安全性

作業識別碼：
UpdateDefaultSecurity

更新文件、資料夾或工作區的預設安全性。

參數

名稱 機碼 必要 類型 Description
物件類型
 objectType True string

指定物件的類型。
物件識別碼
 objectId True string

指定文件、資料夾或工作區的識別碼。 文件 ID 的範例是「ACTIVE_US！453.1」。 資料夾或工作區識別碼的範例是 'ACTIVE_US！123'。
預設安全性
 default_security True string

指定物件的預設安全性。

傳回

名稱 路徑 類型 Description
預設安全性
 data.default_security string

指出物件的預設安全性。 可能的值為 'inherit'、'public'、'view' 或 'private'。
存取權限
 data.acl AccessPermissions

指出一或多個使用者和/或群組的存取權限集合。

移動文件

作業識別碼：
MoveDocument

將文件移至指定的資料夾。

參數

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

指定父資料夾的資料夾 ID。 例如，“ACTIVE_US！987”。
文件 ID
 documentId True string

指定文件的 ID。 例如，'ACTIVE_US！453.1'。
目的地資料夾識別碼
 destination_folder_id True string

指定要將文件移動到的目標資料夾 ID。 例如，“ACTIVE_US！987”。
套用目的地設定檔
 update_profile boolean

指定是否要使用目的地資料夾設定檔更新文件設定檔。
套用目的地安全性
 update_security boolean

指定是否要使用目的地資料夾安全性更新Document Security。 只有在「更新設定檔」設定為 true 時，此參數才適用。
時間軸註解
 comments string

指定作業的其他資訊。 這些註解會顯示在文件的時間軸中。

編輯名稱/值組

作業識別碼：
EditNVP

建立、更新或刪除文件、資料夾或工作區的名稱值配對屬性。 若要刪除名稱值組，請將索引鍵的值設定為以單引號或雙引號括起來的空字串。

參數

名稱 機碼 必要 類型 Description
物件類型
 objectType True string

指定物件的類型。 可能的值為 'document'、'folder'、'workspace'。
物件識別碼
 objectId True string

指定文件、資料夾或工作區的識別碼。 文件 ID 的範例是「ACTIVE_US！453.1」。 資料夾或工作區識別碼的範例是 'ACTIVE_US！123'。
名稱值對
 nameValuePairs object

指定此文件的自由格式名稱和值組。

複製權限

作業識別碼：
CopyPermissions

將存取權限和預設安全性從一個 iManage Work 物件複製到另一個 iManage Work 物件。 「複製型別」可讓您選擇如何處理來源和目的地許可權的組合。 「覆寫」會更新目標物件的使用者、群組和權限層級，以完全符合來源物件的使用者、群組和權限層級。 'Merge' 會保留目的地物件上的所有使用者和群組，並將它們與來源結合，但如果個人或群組的權限層級發生衝突：「Merge （Pessimistic）」會取得較低的權限，而 'Merge （Optimistic）」會取得衝突使用者或群組的較高權限。

參數

名稱 機碼 必要 類型 Description
來源物件類型
 sourceObjectType True string

指定來源物件的類型。
來源物件識別碼
 sourceObjectId True string

指定從中複製權限的物件 ID。 文件 ID 的範例是「ACTIVE_US！453.1」。 資料夾或工作區識別碼的範例是 'ACTIVE_US！123'。
目標物件類型
 targetObjectType True string

指定目標物件的類型。
目標物件識別碼
 targetObjectId True string

指定將權限複製到的物件的 ID。 文件 ID 的範例是「ACTIVE_US！453.1」。 資料夾或工作區識別碼的範例是 'ACTIVE_US！123'。
影印類型
 copyType True string

指定將來源物件權限與目標物件權限合併，或以來源權限覆寫目標物件權限。 如需詳細資訊，請參閱動作說明。
複製預設安全性
 copyDefaultSecurity True boolean

指定將來源物件的預設安全性複製到目標物件。 如果來源物件的預設安全性是「繼承」，則會將繼承的預設安全性從來源複製到目標物件。

傳回

身體
UpdatePermissionsResponse

觸發程序

對於多個選取的文件

此觸發器可讓您在 iManage Work 中為一或多個選取的文件啟動工作流程。 提供將在 iManage Work 應用程式中向使用者顯示的顯示名稱。 如果「等待完成」設定為「是」，您必須在工作流程中使用「更新工作流程狀態」動作，否則應用程式最終會逾時，而不會向使用者指出完成狀態。
針對多個選取的工作區

此觸發器允許您在 iManage Work 中為一個或多個選定的工作區啟動工作流程。 提供將在 iManage Work 應用程式中向使用者顯示的顯示名稱。 如果「等待完成」設定為「是」，您必須在工作流程中使用「更新工作流程狀態」動作，否則應用程式最終會逾時，而不會向使用者指出完成狀態。
針對選取的工作區

此觸發器可讓您在 iManage 工作庫中為所選工作區啟動工作流程。 提供將在 iManage Work 應用程式中向使用者顯示的顯示名稱。 如果「等待完成」設定為「是」，您必須在工作流程中使用「更新工作流程狀態」動作，否則應用程式最終會逾時，而不會向使用者指出完成狀態。
針對選取的文件

此觸發器可讓您在 iManage Work 資料庫中啟動所選文件的工作流程。 提供將在 iManage Work 應用程式中向使用者顯示的顯示名稱。 如果「等待完成」設定為「是」，您必須在工作流程中使用「更新工作流程狀態」動作，否則應用程式最終會逾時，而不會向使用者指出完成狀態。

對於多個選取的文件

作業識別碼：
MultipleSelectedDocuments

此觸發器可讓您在 iManage Work 中為一或多個選取的文件啟動工作流程。 提供將在 iManage Work 應用程式中向使用者顯示的顯示名稱。 如果「等待完成」設定為「是」，您必須在工作流程中使用「更新工作流程狀態」動作，否則應用程式最終會逾時，而不會向使用者指出完成狀態。

參數

名稱 機碼 必要 類型 Description
工作流程顯示名稱
 workflowName True string

指定對 iManage Work 使用者可見的工作流程的顯示名稱。
Description
 description True string

指定工作流程的描述。
圖書館 ID
 libraryId True string

指定工作流程可用的程式庫識別碼。
表單 ID
 formId True string

指定呈現給使用者的表單識別碼，以收集工作流程所使用的輸入。
傳回資料夾ID
 inferFolderId True boolean

指定工作流程是否需要文件的資料夾 ID。
可供使用者使用
 users string

指定一或多個使用者 ID，以分號區隔，以分號區隔，工作流程可供其使用。
可供團體使用
 groups string

指定一或多個群組識別碼，以分號分隔，工作流程可供使用。
顯示每份文件的表格
 showFormPerObject boolean

指定表單是針對每個選取物件單獨呈現，還是僅對所有選取物件呈現一次。
等待完成
 waitForCompletion boolean

指定應用程式是否等待工作流程完成執行。 如果設定為「是」，您必須使用「更新工作流程狀態」動作。

傳回

此作業會輸出隨機的結果。

針對多個選取的工作區

作業識別碼：
MultipleSelectedWorkspaces

此觸發器允許您在 iManage Work 中為一個或多個選定的工作區啟動工作流程。 提供將在 iManage Work 應用程式中向使用者顯示的顯示名稱。 如果「等待完成」設定為「是」，您必須在工作流程中使用「更新工作流程狀態」動作，否則應用程式最終會逾時，而不會向使用者指出完成狀態。

參數

名稱 機碼 必要 類型 Description
工作流程顯示名稱
 workflowName True string

指定對 iManage Work 使用者可見的工作流程的顯示名稱。
Description
 description True string

指定工作流程的描述。
圖書館 ID
 libraryId True string

指定工作流程可用的程式庫識別碼。
表單 ID
 formId True string

指定呈現給使用者的表單識別碼，以收集工作流程所使用的輸入。
可供使用者使用
 users string

指定一或多個使用者 ID，以分號區隔，以分號區隔，工作流程可供其使用。
可供團體使用
 groups string

指定一或多個群組識別碼，以分號分隔，工作流程可供使用。
等待完成
 waitForCompletion boolean

指定應用程式是否等待工作流程完成執行。 如果設定為「是」，您必須使用「更新工作流程狀態」動作。

傳回

此作業會輸出隨機的結果。

針對選取的工作區

作業識別碼：
SingleSelectedWorkspace

此觸發器可讓您在 iManage 工作庫中為所選工作區啟動工作流程。 提供將在 iManage Work 應用程式中向使用者顯示的顯示名稱。 如果「等待完成」設定為「是」，您必須在工作流程中使用「更新工作流程狀態」動作，否則應用程式最終會逾時，而不會向使用者指出完成狀態。

參數

名稱 機碼 必要 類型 Description
工作流程顯示名稱
 workflowName True string

指定對 iManage Work 使用者可見的工作流程的顯示名稱。
Description
 description True string

指定工作流程的描述。
圖書館 ID
 libraryId True string

指定工作流程可用的程式庫識別碼。
表單 ID
 formId True string

指定呈現給使用者的表單識別碼，以收集工作流程所使用的輸入。
可供使用者使用
 users string

指定一或多個使用者 ID，以分號區隔，以分號區隔，工作流程可供其使用。
可供團體使用
 groups string

指定一或多個群組識別碼，以分號分隔，工作流程可供使用。
等待完成
 waitForCompletion boolean

指定應用程式是否等待工作流程完成執行。 如果設定為「是」，您必須使用「更新工作流程狀態」動作。

傳回

此作業會輸出隨機的結果。

針對選取的文件

作業識別碼：
SingleSelectedDocument

此觸發器可讓您在 iManage Work 資料庫中啟動所選文件的工作流程。 提供將在 iManage Work 應用程式中向使用者顯示的顯示名稱。 如果「等待完成」設定為「是」，您必須在工作流程中使用「更新工作流程狀態」動作，否則應用程式最終會逾時，而不會向使用者指出完成狀態。

參數

名稱 機碼 必要 類型 Description
工作流程顯示名稱
 workflowName True string

指定對 iManage Work 使用者可見的工作流程的顯示名稱。
Description
 description True string

指定工作流程的描述。
圖書館 ID
 libraryId True string

指定工作流程可用的程式庫識別碼。
表單 ID
 formId True string

指定呈現給使用者的表單識別碼，以收集工作流程所使用的輸入。
傳回資料夾ID
 inferFolderId True boolean

指定工作流程是否需要文件的資料夾 ID。
可供使用者使用
 users string

指定一或多個使用者 ID，以分號區隔，以分號區隔，工作流程可供其使用。
可供團體使用
 groups string

指定一或多個群組識別碼，以分號分隔，工作流程可供使用。
在工作區中可用
 workspaces string

指定一或多個工作區 ID，以分號分隔，其中工作流程可用。
文件類別
 classes string

指定一或多個文件類別 ID，以分號分隔，工作流程可用。
等待完成
 waitForCompletion boolean

指定應用程式是否等待工作流程完成執行。 如果設定為「是」，您必須使用「更新工作流程狀態」動作。

傳回

此作業會輸出隨機的結果。

定義

最小文件設定檔在陣列中

指出文件每個版本的設定檔。

名稱 路徑 類型 Description
作者
 author string

指出建立文件之使用者的 ID。 例如，'JSMITH'。
作者描述
 author_description string

指出文件作者的其他資訊。
基本文件屬性
 basic_properties string

指出包含基本文件屬性的可內嵌 '' 元素。
文件類別
 class string

指出文件的類別。
評論
 comment string

指出文件的其他資訊。
內容類型
 content_type string

指出文件內容類型。
文件建立日期
 create_date string

指示將文件匯入 iManage Work 系統的日期和時間 （ISO 8601 格式）。 此日期可能與「file_create_date」不同。
自訂1
 custom1 string

指出 custom1 的值。
Custom1 說明
 custom1_description string

指出有關 custom1 屬性的其他資訊。
自訂2
 custom2 string

指出 custom2 的值。
Custom2 說明
 custom2_description string

指出有關 custom2 屬性的其他資訊。
自訂3
 custom3 string

指出 custom3 的值。
Custom3 說明
 custom3_description string

指出有關 custom3 屬性的其他資訊。
自訂4
 custom4 string

指出 custom4 的值。
Custom4 說明
 custom4_description string

指出有關 custom4 屬性的其他資訊。
自訂5
 custom5 string

指出 custom5 的值。
Custom5 說明
 custom5_description string

指出有關 custom5 屬性的其他資訊。
自訂6
 custom6 string

指出 custom6 的值。
Custom6 說明
 custom6_description string

指出有關 custom6 屬性的其他資訊。
自訂7
 custom7 string

指出 custom7 的值。
Custom7 說明
 custom7_description string

指出 custom7 屬性的其他資訊。
自訂8
 custom8 string

指出 custom8 的值。
Custom8 說明
 custom8_description string

指出有關 custom8 屬性的其他資訊。
自訂9
 custom9 string

指出 custom9 的值。
Custom9 說明
 custom9_description string

指出有關 custom9 屬性的其他資訊。
自訂10
 custom10 string

指出 custom10 的值。
Custom10 說明
 custom10_description string

指出 custom10 屬性的其他資訊。
自訂11
 custom11 string

指出 custom11 的值。
Custom11 說明
 custom11_description string

指出 custom11 屬性的其他資訊。
自訂12
 custom12 string

指出 custom12 的值。
Custom12 說明
 custom12_description string

指出有關 custom12 屬性的其他資訊。
自訂13
 custom13 string

表示 custom13 的值。
自訂14
 custom14 string

表示 custom14 的值。
自訂15
 custom15 string

表示 custom15 的值。
自訂16
 custom16 string

表示 custom16 的值。
自訂17
 custom17 double

表示 custom17 的值。
自訂18
 custom18 double

表示 custom18 的值。
自訂19
 custom19 double

表示 custom19 的值。
客製化20
 custom20 double

表示 custom20 的值。
自訂21
 custom21 string

以 ISO 8601 日期時間格式指出 custom21 屬性的值。
自訂22
 custom22 string

以 ISO 8601 日期時間格式指出 custom22 屬性的值。
客製化23
 custom23 string

以 ISO 8601 日期時間格式指出 custom23 屬性的值。
定制24
 custom24 string

以 ISO 8601 日期時間格式指出 custom24 屬性的值。
客製化25
 custom25 boolean

指出 custom25 的值。
客製化26
 custom26 boolean

指出 custom26 的值。
自訂27
 custom27 boolean

指出 custom27 的值。
客製化28
 custom28 boolean

指出 custom28 的值。
自訂29
 custom29 string

指出 custom29 的值。
Custom29 說明
 custom29_description string

指出 custom29 屬性的其他資訊。
客製化30
 custom30 string

指出 custom30 的值。
Custom30 說明
 custom30_description string

指出有關 custom30 屬性的其他資訊。
資料庫
 database string

指出儲存文件的資料庫。
文件預設安全性
 default_security string

指出預設安全性存取層級。 可能的值為 'inherit'、'private'、'view'、'public'。
文件編號
 document_number integer

指出文件的文件編號。
文件網址
 document_url string

指出文件的可共用連結。
文件編輯日期
 edit_date string

指出文件最近變更的日期和時間 （ISO 8601 格式）。
設定檔編輯日期
 edit_profile_date string

指出文件設定檔最近變更的日期和時間 （ISO 8601 格式）。
文件擴展
 extension string

指出文件的副檔名 （也稱為應用程式副檔名）。
完整檔案名稱
 full_file_name string

指出文件的完整檔名。 包括副檔名。
文件 ID
 id string

指出文件的 ID。 例如，'ACTIVE_US！453.1'。
可索引
 indexable boolean

指出系統是否為文件編製索引。
已出庫
 is_checked_out boolean

指出文件是否已出庫使用。
已宣告
 is_declared boolean

指出文件是否宣告為記錄。 宣告為記錄的文件無法編輯或刪除，除非由 iManage Work 系統管理者編輯或刪除。
是外部的
 is_external boolean

指出文件是否與外部使用者共用。
HIPAA 是
 is_hipaa boolean

指出文件是否已加密。
正在使用中
 is_in_use boolean

指出文件是否正在使用中。
文件連結
 iwl string

指出文件的 iManage 工作連結 （iWL）。 iWL 用於由具有「read_write」或「full_access」的使用者以受保護的檢視模式開啟文件。
最後一個使用者
 last_user string

指出最近編輯文件的使用者 ID。 例如，'JSMITH'。
上位使用者描述
 last_user_description string

指出最近編輯文件的最後一個使用者的其他資訊。
文件名稱
 name string

指出文件的檔案名稱。
Operator
 operator string

指出已出庫使用文件或目前正在編輯其設定檔的使用者 ID。 例如，'JSMITH'。
操作員說明
 operator_description string

指出運運算元的其他資訊。
相關
 is_related boolean

指出文件是否與另一個文件相關。
文件大小
 size integer

指出文件的大小（以位元組為單位）。
類型
 type string

指出文件類型。 例如，WORD for Microsoft Word。 如需目前的類型清單，請聯絡您的 iManage Work 系統管理員。
文件版本
 version integer

指出文件的版本號碼。
Ws類型
 wstype string

指出物件的 iManage 工作類型。 可能的值為 'document'、'folder'、'workspace'、'email'、'document_shortcut'、'folder_shortcut'、'workspace_shortcut'、'user'。

用戶檔案

指出使用者的相關資訊。

名稱 路徑 類型 Description
允許登入
 allow_logon boolean

指出是否允許使用者登入。
自訂1
 custom1 string

指出有關使用者的其他資訊。
自訂2
 custom2 string

指出有關使用者的其他資訊。
自訂3
 custom3 string

指出有關使用者的其他資訊。
目錄 ID
 directory_id string

指出外部目錄 （例如 ADFS） 的識別碼，用於使用者設定檔同步處理。
專有名稱
 distinguished_name string

指出物件的名稱，代表將項目追蹤回 LDAP 樹狀結構根目錄的名稱完整路徑。
編輯日期
 edit_date string

指出使用者設定檔最近變更的日期和時間 （ISO 8601 格式）。
Email
 email string

指出使用者的電子郵件 ID。
Exchange 自動探索 URL
 exch_autodiscover string

指出使用者的 Exchange 伺服器詳細資料。
Extension
 extension string

指出使用者的電話號碼分機。
登入嘗試失敗
 failed_logins integer

指出使用者目前嘗試登入失敗的次數。
傳真
 fax string

表示使用者的傳真號碼。
強制更改密碼
 force_password_change boolean

表示使用者必須在下次登入時變更其密碼。 僅適用於虛擬用戶，由「user_nos」值「2」表示。
全名
 full_name string

指出使用者的完整名稱。
General
 general string

指出使用者的一般資訊。
使用者識別碼
 id string

指出使用者的 ID。 例如，'JSMITH'。
是外部使用者
 is_external boolean

表示外部使用者。 外部使用者的存取權限有限，通常用於臨時團隊成員、顧問或組織外部的人員。
上次同步時間
 last_sync_ts string

指出使用者設定檔與外部目錄 （例如 LDAP 或 Microsoft Active Directory （ADFS） ） 的上次同步處理時間 （以 ISO 8601 日期時間格式）。
地點
 location string

指出使用者的地理位置。
密碼永不過期
 password_never_expire boolean

指出使用者的密碼是否永遠不會過期。
電話號碼
 phone string

指出使用者的電話號碼。
首選圖書館
 preferred_library string

指出偏好的程式庫。 偏好的程式庫是使用者的預設程式庫。 每個使用者都必須有一個偏好的程式庫。
密碼變更時間
 pwd_changed_ts string

指出上次變更使用者密碼的時間 （以 ISO 8601 日期時間格式）。 這僅適用於虛擬使用者（其使用者NOS為2）。
SSID
 ssid string

指出使用者的唯一系統產生 ID。
使用者網域
 user_domain string

指出使用者目錄服務的完整網域名稱。
擴充使用者 ID
 user_id_ex string

指出從外部目錄 （例如 Microsoft Active Directory （ADFS） ） 接收的使用者 ID 的原始值。
用戶 NOS
 user_nos integer

指出使用者從中同步處理的作業系統類型。 可能的值為 2 （虛擬使用者） 和 6 （企業使用者）。 如需相關資訊，請聯絡您的 iManage Work 系統管理員。
用戶編號
 user_num integer

指出使用者的數值系統識別碼。

UserProfileInArray

名稱 路徑 類型 Description
允許登入
 allow_logon boolean

指出是否允許使用者登入。
自訂1
 custom1 string

指出有關使用者的其他資訊。
自訂2
 custom2 string

指出有關使用者的其他資訊。
自訂3
 custom3 string

指出有關使用者的其他資訊。
目錄 ID
 directory_id string

指出外部目錄 （例如 ADFS） 的識別碼，用於使用者設定檔同步處理。
專有名稱
 distinguished_name string

指出物件的名稱，代表將項目追蹤回 LDAP 樹狀結構根目錄的名稱完整路徑。
編輯日期
 edit_date string

指出使用者設定檔最近變更的日期和時間 （ISO 8601 格式）。
Email
 email string

指出使用者的電子郵件 ID。
Exchange 自動探索 URL
 exch_autodiscover string

指出使用者的 Exchange 伺服器詳細資料。
Extension
 extension string

指出使用者的電話號碼分機。
登入嘗試失敗
 failed_logins integer

指出使用者目前嘗試登入失敗的次數。
傳真
 fax string

表示使用者的傳真號碼。
強制更改密碼
 force_password_change boolean

表示使用者必須在下次登入時變更其密碼。 僅適用於虛擬用戶，由「user_nos」值「2」表示。
全名
 full_name string

指出使用者的完整名稱。
General
 general string

指出使用者的一般資訊。
ID
 id string

指出使用者的 ID。 例如，'JSMITH'。
是外部使用者
 is_external boolean

表示外部使用者。 外部使用者的存取權限有限，通常用於臨時團隊成員、顧問或組織外部的人員。
上次同步時間
 last_sync_ts string

指出使用者設定檔與外部目錄 （例如 LDAP 或 Microsoft Active Directory （ADFS） ） 的上次同步處理時間 （以 ISO 8601 日期時間格式）。
地點
 location string

指出使用者的地理位置。
密碼永不過期
 password_never_expire boolean

指出使用者的密碼是否永遠不會過期。
電話號碼
 phone string

指出使用者的電話號碼。
首選圖書館
 preferred_library string

指出偏好的程式庫。 偏好的程式庫是使用者的預設程式庫。 每個使用者都必須有一個偏好的程式庫。
密碼變更時間
 pwd_changed_ts string

指出上次變更使用者密碼的時間 （以 ISO 8601 日期時間格式）。 這僅適用於虛擬使用者（其使用者NOS為2）。
SSID
 ssid string

指出使用者的唯一系統產生 ID。
網域
 user_domain string

指出使用者目錄服務的完整網域名稱。
擴充使用者 ID
 user_id_ex string

指出從外部目錄 （例如 Microsoft Active Directory （ADFS） ） 接收的使用者 ID 的原始值。
NOS
 user_nos integer

指出使用者從中同步處理的作業系統類型。 可能的值為 2 （虛擬使用者） 和 6 （企業使用者）。 如需相關資訊，請聯絡您的 iManage Work 系統管理員。
Number
 user_num integer

指出使用者的數值系統識別碼。

分類節點值

指出每個分類節點值。

名稱 路徑 類型 Description
SSID
 created_by.ssid string

指出建立節點值之使用者的唯一系統產生 ID。
建立日期
 create_date date-time

指出建立節點值的日期和時間 （以 ISO 8601 格式）。
Description
 description string

指出節點值的描述。
SSID
 edited_by.ssid string

指出上次編輯節點值之使用者的唯一系統產生 ID。
編輯日期
 edit_date date-time

指出上次編輯節點值的日期和時間 （以 ISO 8601 格式）。
已啟用
 enabled boolean

指出節點值是否已啟用。
ID
 id string

指出節點值的顯示識別碼。
SSID
 parent.ssid string

指出系統產生的直接母節點的唯一 ID。
SSID
 ssid string

指出節點值的唯一系統產生 ID。
路徑
 path array of object

指出節點值的完整路徑。 路徑是排序清單，從分類中的頂層節點開始，然後是所有節點，一直到相符節點的直接父節點。
每個 ID
 path.id string

指出路徑中節點值的顯示識別碼。
每個SSID
 path.ssid string

指出路徑中節點值的唯一系統產生識別碼。

UpdatePermissions回應

名稱 路徑 類型 Description
預設安全性
 data.default_security string

指出物件的預設安全性。 可能的值為 'inherit'、'public'、'view' 或 'private'。
存取權限
 data.acl AccessPermissions

指出一或多個使用者和/或群組的存取權限集合。
所有使用者 ID
 data.all_user_ids string

指出所有使用者 ID 的清單，串連為字串，並以分號區隔。
所有群組 ID
 data.all_group_ids string

指出所有群組 ID 的清單，串連為字串，並以分號分隔。

存取權限

指出一或多個使用者和/或群組的存取權限集合。

名稱 路徑 類型 Description
受託人名稱
 name string

指出受託人的名稱。
受託人 ID
 id string

指出受託人的識別碼。 這可以是使用者 ID 或群組 ID。
受託人 SID
 sid string

指出使用者或群組的安全性識別碼。
受託人類型
 type string

指出傳回的受託人類型。 可能的值為 'user' 或 'group'。
存取層級
 access_level string

指出使用者或群組對物件的存取權限。 可能的值為 'no_access'、'read'、'read_write' 或 'full_access'。
存取層級顯示名稱
 access_level_display_name string

指出指派給此物件之使用者或群組的人類可讀存取層級顯示名稱。 可能的值為「無存取權」、「唯讀」、「讀取/寫入」或「完全存取權」。
存取權
 access integer

指出使用者或群組對物件所擁有的存取權限的數值。 可能的值為 0 （no_access）、1 （讀取）、2 （read_write） 或 3 （full_access）。
是外部的
 is_external boolean

指出使用者是外部使用者，或群組是否僅限於外部使用者。
允許登入
 allow_logon boolean

指出是否允許使用者登入。 不適用於團體。
已啟用
 enabled boolean

指出群組是否已啟用。 不適用於使用者。
有受限制的成員
 has_restricted_member boolean

指出群組中是否至少有一個使用者可以存取此物件，但被 iManage Security Policy Manager 拒絕。

物件

這是類型 'object'。

二進位

這是基本資料類型「二進位」。