HighQ （預覽版）

此連接器可實現對 HighQ API 的安全和身份驗證訪問，從而允許將協作和內容管理功能無縫整合到自訂工作流程和應用程式中。它支援文件自動化、資料同步和工作流程編排，使法律和專業服務團隊能夠簡化營運、減少手動工作並提高生產力。

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

服務	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）

連絡人
名稱	高Q
URL	https://www.thomsonreuters.com/en-gb/help/highq/feature-updates/support/technical-support
Email	highq-support@thomsonreuters.com

連接器中繼資料
Publisher	湯森路透公司
網站	https://legal.thomsonreuters.com/en/products/highq
隱私策略	https://www.thomsonreuters.com/en/privacy-statement
類別	通敵;內容和文件

HighQ

概觀

HighQ 提供對 HighQ API 的無縫、安全、經過身份驗證的訪問。此連接器可與各種 HighQ 服務無縫交互，包括 ISheet 模塊、文檔資源 API、ISheet 管理 API 和用戶操作。它旨在促進與 HighQ Collaborate 平台的集成，提供檢索和建立 iSheet 項目、管理文件文件和管理使用者帳戶等功能。

連接器版本： 1.0.0
名：高Q
描述： 此連接器提供對 HighQ API 的無縫、安全和經過身份驗證的訪問。
㨟：
- 名字： 高Q
- 網址：HighQ Support
- 電子郵件：highq-support@thomsonreuters.com

Authentication

連接器利用動態環境變數進行安全連線：

主持人： @environmentVariables("highqt_host")
基本路徑： /@environmentVariables("highqt_instancename")/api
客戶編號：@environmentVariables("highqt_clientid")
客戶端密碼：@environmentVariables("highqt_clientsecret")

有關詳細的身份驗證程序，請參閱 HighQ 技術支援入口網站或聯絡 HighQ 支援。

連接器作業

ISheet 模組

擷取 iSheet 項目
GET /{version}/isheet/{isheetid}/items
擷取指定 iSheet 中的項目清單。
建立 iSheet 項目
POST /{version}/isheet/{isheetid}/items
將新項目插入 iSheet，支援多個 iSheet，並透過漸進式鍵進行狀態追蹤。

文件資源 API

擷取檔案資訊
GET /{version}/files/{fileid}
擷取 HighQ Collaborate 平台上特定檔案的詳細資訊。
上傳檔案
POST /{version}/files/content
將檔案上傳至指定的資料夾，並在提供標頭時 Content-Range 支援區塊上傳。
擷取資料夾清單
GET /{version}/folders/{folderid}/items
擷取指定資料夾內支援排序和分頁的資料夾清單。

ISheet 系統管理 API

擷取 iSheet 欄
GET /{version}/isheets/admin/{isheetid}/columns
擷取指定 iSheet 的欄組態。

使用者作業

擷取使用者
GET /{version}/users
擷取支援篩選、分頁和詳細使用者角色的使用者清單。
新增使用者
POST /{version}/users
建立具有擴充屬性和驗證的新使用者帳戶。
封存使用者
DELETE /{version}/users/{userid}
從系統封存現有使用者。

文件和網站管理

建立資料夾
POST /{version}/folders
在指定的父資料夾下建立新資料夾。
移動文件
PUT /{version}/files/move
將一或多個檔案從同一網站內的一個資料夾移至另一個資料夾。
現場管理作業：
- 將現有群組新增至網站： POST /{version}/sites/{siteid}/groups/{groupid}
- 更新站點組： PUT /{version}/sites/{siteid}/groups/{groupid}
- 新增網站： POST /{version}/sites

使用者入門

組態：
- 定義環境變數 highqt_host ， highqt_instancename 並在 Power Platform 環境中定義。
驗證：
- 請遵循 HighQ 提供的指導方針，為 API 請求設定安全身份驗證。
用法：
- 將 HighQ 匯入您的 Power Platform 執行個體。
- 視需要利用可用的作業。請參閱上面提供的操作摘要以獲取指導。

參數和設定

路徑參數：
包括必要的參數，例如 version、、 isheetidfileidfolderid、和 userid （如適用）。
查詢參數：
選擇性參數（例如 sheetviewid、 sortcolumnidlimit、和） offset 可用於精簡 API 回應。
身體參數：
對於需要請求內文的作業（例如，建立 iSheet 項目或使用者），請確保請求遵循定義的結構描述（例如 isheetDBO、 FolderDBO或 IntegrationUserDBO）。

疑難排解和限制

錯誤代碼：
標準 HTTP 狀態碼會跨作業使用：
- 200 為了成功運營
- 401 未經授權的存取
- 403 禁止或驗證失敗
- 405 對於無效的 HTTP 方法
- 500 對於內部伺服器錯誤
  請參閱個別 API 文件以取得詳細的錯誤說明。
限制：
某些端點可能有預設限制（例如，預設 limit 為 100 筆記錄）。排序和過濾大型資料集可能需要其他參數。

其他資源

如需更多詳細資訊和擴充文檔，請參閱：

HighQ 技術支持
HighQ 連接器套件隨附的內部文件。

授權和支援

如需授權詳細資料和技術支援：

聯繫人：Highq
支援網址： HighQ 技術支援
支持電子郵件： highq-support@thomsonreuters.com

節流限制

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

動作

上傳檔案

此 API 呼叫會將檔案上傳至 HighQ Collaborate 平台上的指定資料夾。當提供 Content-Range 標頭時，它支援區塊上傳。

取得資料夾資訊

此方法提供指定資料夾識別碼的資料夾詳細資料。

封存使用者

此 API 呼叫可用來封存系統內的使用者。

錯誤代碼

摘要	參考代碼（V4 之前）	參考代碼（V4）
系統內不存在下列使用者	110	110
需要使用者 ID	109	109
使用者 ID 格式不正確	113	113
使用者的 ID 長度不能超過 50 個字元	N/A	304

JIRA 門票： https://dev.highq.com/jira/browse/COL-67441

將現有群組新增至網站

此 API 方法將現有的系統群組新增至網站。
此 API 已擴充，可在網站中新增現有的系統基本使用者群組（系統/組織型別）。

建立 iSheet 項目的步驟

此 API 呼叫用於插入 iSheet 項目。可以支持多個 iSheet。

若要根據漸進式索引鍵取得 iSheet 項目的狀態，請呼叫 API POST /api/3/progressivekeystatus/{progressive_key}

例如 POST /api/{version}/progressivekeystatus/{progressive_key}

名稱	類型	Description
progressive_key	繩子	檢查操作狀態的鍵。

回應


              
              <progressivekeyresponse>

               \t<項目>

                \t\t<項目>

                 \t\t\t<itemID>1232</itemID>

                 \t\t\t<狀態>SUCCESS/<狀態>

                 \t\t\t<狀態代碼>200</狀態代碼>

                 \t\t\t<訊息>記錄新增成功</訊息>

                \t\t</項目>

                \t\t<項目>

                 \t\t\t<itemID>1233</itemid>

                 \t\t\t<狀態>SUCCESS/<狀態>

                 \t\t\t<狀態代碼>200</狀態代碼>

                 \t\t\t<訊息>記錄新增成功</訊息>

                \t\t</項目>

               \t</項目>

              </progressivekeyresponse>

建立資料夾

此 API 會在指定的網站內建立新資料夾。它允許您提供資料夾詳細資訊並確保在給定的父資料夾下建立資料夾。

擷取 iSheet 欄

此 API 呼叫會擷取與指定 iSheet 相關聯的欄。 API 版本 3 及更高版本支援此功能。

擷取 iSheet 項目清單

此 API 呼叫會擷取指定 iSheet 中包含的項目清單。

擷取使用者清單

擷取使用者清單此 API 會從系統擷取使用者清單。 ## 主要功能 - 使用多個過濾選項獲取用戶詳細信息 - 支持使用和 `limit` 分`offset`頁 - 最新版本中引入的新查詢參數和字段 - 具有用戶角色和屬性的結構化響應 ## 新的查詢參數（Version-Specific） - 在 V12 中引入： - `systemAdminSearch`：當設置為 `1`時，僅返回具有系統管理員角色的用戶。 - V18 中引入：- `userid`：接受逗號分隔值（CSV）。 ## 回應正文更新 - 新增欄位： - `emaildomain`，， `org`，`invitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcodepublicprofiledateOfBirth`## 位址格式變更（從 V11 開始） - `location` 為了保持一致性，標籤已重新命名為。`address` - 範例回應： `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` ## 使用者角色（在 API v11+ 中引進） - 範例回應： `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## 限制和偏移 - 限制行為： - 預設值： `100` 如果未提供值。 - 用於 `-1` 傳回所有記錄。 - 如果值小於 `-1`，則預設為 `100`。 - 偏移行為：- 預設值： `0` 如果未提供值。 - 如果偏移超過記錄總數，則預設值回到 `0`。 ## 引入的新角色 - V12： `Basic User`， `Allow user to bypass XSS protection` - V14： `Allow user to manage Contract Express system groups` ## 錯誤代碼 |總結 |參考代碼（V4 之前） |參考代碼（V4） | |---------|----------------------|--------------| |使用者狀態輸入無效（ACTIVE、ARCHIVED、INACTIVE） |147 |147 | |組織 ID 無效 |不適用 |260 | |無效 `neverinvited` 值（true/false） |不適用 |387 | |無效 `neverlogin` 值（true/false） |不適用 |388 | |值無效 `groupids` |不適用 |214 | |無效 `notingroup` 值（true/false） |不適用 |389 | |無效 `ordertype` （支援：姓名、組織、狀態等） |不適用 |289 | |無效 `orderby` （支援：asc、desc） |不適用 |290 | |無效 `offset` 值 | 138 | 138 | |無效 `limit` 值 | 137 | 137 | ## 附註 - 從 V13 開始，此 API 對所有使用者開放（先前僅限於系統管理員）。 - 從 V18 開始，該 `userregistered2FA` 欄位會指出使用者是否已註冊 2FA。 --- 此描述遵循 Swagger 2.0 結構描述格式，應放置在自訂連接器結構描述的描述欄位中。

擷取檔案資訊

此 API 呼叫會從 HighQ Collaborate 平台擷取指定檔案的詳細資訊。

擷取資料夾清單

此 API 呼叫會擷取指定資料夾內包含的資料夾清單。 'limit' 參數設定要傳回的最大項目數，而 'offset' 參數指定資料檢索的起始位置。如果省略這些參數，則會套用預設值，且資料夾會依建立日期遞增順序傳回。

新增網站

使用此 API 來建立新網站。網站物件僅支援在建立網站介面中可見的屬性。

此 API 需要網站名稱（以及在 ASP 層級設定的必要欄位（如果有的話）才能建立新網站。

「module」標籤代表要在網站中設定的不同模組，如請求屬性所示。
通過傳遞“sitetemplateid”標籤從模板創建站點
- 對於低於版本 7，如果請求中未提供任何模組（未傳遞模組」標籤），則將進行範本模組配置。如果模組標籤提供設定，它會遵守該設定，並依要求中指定的設定（而不是使用範本模組設定）
- 對於大於版本 7，如果要求中給出了任何模組（「模組」標籤已傳遞）或未，則會進行範本模組設定。

這個方法不支援在此呼叫中上傳網站影像，網站圖示支援會以個別呼叫的形式提供。
方法呼叫需要現有的類別識別碼。類別識別碼應該由呼叫應用程式透過先前呼叫網站類別介面來取得。如果請求中未提供類別，則預設會新增任何類別（不是實際的任何類別）。

站點開始和結束日期應採用“dd MMM yyyy”的格式，而不是 UTC。 API 用戶端一律會要求實際日期。

“landingpage”的默認值為“文件（根文件夾）”。
“landingpage” 期望文件模塊的三種不同措辭或標識。可能的值包括：
- 檔案（根資料夾）
- 檔案（最近的活動）
- 檔案（進階搜尋）
方法實作現在支援（從 5.1 開始）多語言網站名稱。 API 版本 6 或更高版本 <的網站名稱> 將根據使用者偏好順序在請求內文中表示。 API 第 5 版或更早版本 <的網站名稱> 將代表預設的英國英語。
<sitenametranslations> 將代表每種語言的站點名稱（從 5.1 開始，這將是“對象本身 API”中的附加標籤）API 版本 6 或更高版本，在請求正文中，它們同時發送兩個標籤， <即 sitename> 和 <sitenametranslations，> 然後我們需要驗證值，例如 <，sitename> 必須與用戶的語言偏好相關的相應 <翻譯> 標籤匹配。 API 7 或更高版本，從範本建立的網站將遵循來源範本中的模組，並忽略在請求內文中傳送的模組清單。

方法實作現在支援透過提供 “sitetemplateid” 標籤從範本建立網站（舊方法）

請注意，未來將棄用使用此 API 從範本建立網站的支援。要從模板創建站點，請使用新的 API 從模板（/sites/templates/{templateid}/site）創建站點，這是一個長輪詢 API（支持長時間運行的請求）

此方法支援使用 API 版本 10 以上將多個案件編號新增至網站。 “matternos”標籤表示多個具有唯讀或非唯讀的事項編號。舊版本（小於版本 10）單一物質編號「matterno」將反映網站中現有多個物質編號的第一個物質編號。

版本 18 以上：需要類別（網站用途）。如果網站用途已隱藏，則會顯示訊息;否則，隱藏的網站用途不會新增至網站。

版本 17 之前：網站所有者是登錄用戶;無法新增其他使用者。

版本 18 以上：網站擁有者可以將其他使用者新增至網站。

從 API 版本 19 開始，引入了一個名為“customPages”的新模塊，它與 home 模塊緊密耦合。因此，如果主模組值為 True，則 customPages 將為 true，反之亦然。

更新網站

使用此 API 端點來更新現有網站的詳細資料。 API支援建立網站API中使用的相同欄位。

此方法支援使用 API 版本 10 以上將多個案件編號新增至網站。 “matternos”標籤表示多個具有唯讀或非唯讀的事項編號。

版本 18 以上：需要類別（網站用途）。如果網站用途已隱藏，則會顯示訊息;否則，隱藏的網站用途不會新增至網站。

現在，也可以為網站擁有者指派其他使用者，但他們必須是網站參與者，且角色高於網站管理員。

版本 18 以上：網站擁有者可以將其他使用者新增至網站。

從 API 版本 19 開始，引入了一個名為 customPages 的新模組，它與 home 模組緊密耦合。如果主模組值為 True，則 customPages 必須為 true，反之亦然。

請注意，get site 回應中的所有屬性/元素都不可更新/插入。請參閱下表，瞭解哪些是唯讀、可更新或可插入的。

更新網站群組

此 API 方法會更新網站中現有群組的名稱。
此 API 已擴充，以更新網站中現有基本使用者群組的名稱。

添加使用者

此 API 呼叫可用來將新使用者新增至系統。
注意:
1.新增支援以下新欄位
emaildomain， org， invitationsent， createdby， createddate， modifiedby， modifieddate， ifpartner， lastlogindate， invalidlogins， externalid， publicwebsiteprofileid， systemuser， resetpassworddate， usertypeid， avatar， practicegroup， langcode， publicprofile， dateOfBirth
2. API 版本 4 中新增了地址標籤
<地址>
<地址 ID>1

摘要	參考代碼（V4 之前）	參考代碼（V4）
電子郵件地址為必填項	101	101
無效的電子郵件地址	104	104
名字是必填的	102	102
名字允許的字元數上限必須介於 1 到 100 之間	102	352
秘書/助理的電子郵件地址無效	104	353
狀態必須為作用中或非作用中	116	116
輸入的部門不能超過 256 個字元	N/A	354
輸入的 ifpartner 屬性無效	N/A	355
輸入的systemuser屬性無效	N/A	356
輸入的 usertypeid 屬性無效	N/A	357
輸入的langcode屬性無效	N/A	358
輸入的 sourcetype 屬性無效。有效值為 System、Active Directory 或 System default 。	N/A	359
請輸入有效電話號碼	N/A	360
請輸入有效的電話號碼，格式為{countrycode} ${areacode }${number}。	N/A	361
請輸入有效的手機號碼，格式為{countrycode}${number}。	N/A	362
輸入有效的辦公室電話國家/地區代碼	N/A	363
辦公室電話國家/地區代碼最多可以有 4 位數字	N/A	364
輸入有效的辦公室電話區號	N/A	365
辦公室電話區號最多可以有 5 位數字	N/A	366
辦公室電話號碼最多應為 15 位數字	N/A	368
輸入有效的手機國家/地區代碼	N/A	369
手機國家代碼最多可以有 4 位數字	N/A	372
請輸入有效的手機號碼	N/A	373
手機號碼最多應為 20 位數字	N/A	374
網域不存在	105	105
系統中已存在電子郵件	111	111
在自行註冊網域的情況下提及組織	187	187
在特殊領域的情況下提及組織	115	115
組織識別碼的格式不正確	112	112
組織不存在	106	106
網域存在於其他組織中	114	114
輸入的地址 ID 無效	N/A	308
在系統中找不到社交連結名稱。	N/A	375
社交連結名稱是必填項	N/A	376
社交連結值是必填的	N/A	377
社交連結值的字元數上限必須介於 1 到 500 之間	N/A	378
輸入自訂連結的名稱	N/A	379
所需的自訂連結值	N/A	380
自訂連結名稱的字元數上限必須介於 1 到 500 之間	N/A	381
自訂連結值的字元數上限必須介於 1 到 500 之間	N/A	382
必要的訊息連結名稱	N/A	383
在系統中找不到訊息鏈結名稱	N/A	384
必要的訊息連結值	N/A	385
訊息鏈結值的字元數上限必須介於 1 到 500 之間	N/A	386
社交連結已停用	N/A	408
訊息連結已停用	N/A	409
自訂連結已停用	N/A	410

JIRA 門票： https://dev.highq.com/jira/browse/COL-65685

移動文件

此 API 會將多個檔案從同一網站內的一個資料夾移至另一個資料夾。

上傳檔案

作業識別碼：: insertDocument

此 API 呼叫會將檔案上傳至 HighQ Collaborate 平台上的指定資料夾。當提供 Content-Range 標頭時，它支援區塊上傳。

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	指定正在使用的 API 版本。
要上傳的檔案	file	True	file	指定要上傳的檔案。
父資料夾識別碼	parentfolderid	True	string	指定要上傳檔案的父資料夾的唯一識別碼。
覆寫重複旗標	overrideduplicate		boolean	指出是否應覆寫重複的檔案上傳。
文件名稱	filename	True	string	指定文件的名稱。
版本說明	versionnote		string	提供說明檔案版本的附註。
漸進式操作鍵	progressiveoperkey		string	指定在檔案上傳期間用於漸進式作業的索引鍵。
DMS 資料庫名稱	dmsdatabasename		string	指定文件管理系統資料庫的名稱。
DMS 編輯日期	dmseditdate		string	指定文件管理系統中記錄的編輯日期。
DMS 父資料夾 ID	dmsparentfolderid		string	指定文件管理系統中父資料夾的唯一識別碼。
DMS 文件 ID	dmsdocid		string	指定文件管理系統中文件的唯一 ID。
DMS 文件版本	dmsversion		string	指定文件管理系統中記錄的文件版本。
通知詳情	notification		string	提供有關檔案上傳時要傳送的任何通知的詳細資訊。
批次識別碼	batchid		string	指定批次作業的唯一識別碼。
根資料夾識別碼	rootfolderid		string	指定根資料夾的唯一 ID。

取得資料夾資訊

作業識別碼：: getFolderInfo

此方法提供指定資料夾識別碼的資料夾詳細資料。

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	API 版本
資料夾 ID	folderid	True	string	資料夾ID
狀態資訊	statusinfo		boolean	statusinfo 參數可讓您存取資料夾的其他相關資訊。可用信息包括共享狀態、登錄用戶的收藏夾狀態

傳回

身體: FolderDBOV2

封存使用者

作業識別碼：: deleteUser

此 API 呼叫可用來封存系統內的使用者。

錯誤代碼

摘要	參考代碼（V4 之前）	參考代碼（V4）
系統內不存在下列使用者	110	110
需要使用者 ID	109	109
使用者 ID 格式不正確	113	113
使用者的 ID 長度不能超過 50 個字元	N/A	304

JIRA 門票： https://dev.highq.com/jira/browse/COL-67441

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	API 版本
使用者 ID	userid	True	string	使用者 ID

將現有群組新增至網站

作業識別碼：: addExistingGroupToSite

此 API 方法將現有的系統群組新增至網站。
此 API 已擴充，可在網站中新增現有的系統基本使用者群組（系統/組織型別）。

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	版本
網站的 ID	siteid	True	string	網站的識別碼。
系統群組的識別碼	groupid	True	string	要新增至網站的系統群組識別碼。

傳回

身體: sitegroup

建立 iSheet 項目的步驟

作業識別碼：: insertISheetItems

此 API 呼叫用於插入 iSheet 項目。可以支持多個 iSheet。

若要根據漸進式索引鍵取得 iSheet 項目的狀態，請呼叫 API POST /api/3/progressivekeystatus/{progressive_key}

例如 POST /api/{version}/progressivekeystatus/{progressive_key}

名稱	類型	Description
progressive_key	繩子	檢查操作狀態的鍵。

回應


              
              <progressivekeyresponse>

               \t<項目>

                \t\t<項目>

                 \t\t\t<itemID>1232</itemID>

                 \t\t\t<狀態>SUCCESS/<狀態>

                 \t\t\t<狀態代碼>200</狀態代碼>

                 \t\t\t<訊息>記錄新增成功</訊息>

                \t\t</項目>

                \t\t<項目>

                 \t\t\t<itemID>1233</itemid>

                 \t\t\t<狀態>SUCCESS/<狀態>

                 \t\t\t<狀態代碼>200</狀態代碼>

                 \t\t\t<訊息>記錄新增成功</訊息>

                \t\t</項目>

               \t</項目>

              </progressivekeyresponse>

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	API 版本
iSheet 標識符	isheetid	True	integer	iSheet 的 ID
圖紙視圖識別碼	sheetviewid		integer	iSheet 視圖的 ID （選用）
識別碼	id		integer	isheet 標識符。
title	title		string	工作表的標題。
說明	description		string	工作表的描述。
狀態	status		string	工作表的狀態。
accesstype	accesstype		string	圖紙的存取類型。
型別	type		string	圖紙的類型。
檢視連結	viewlink		string	查看工作表的 URL 連結。
允許區段	allowsections		string	指出是否允許區段。
允許查找	allowlookup		string	指出是否允許查閱。
顯示i表	displayisheet		string	顯示 isheet。
searchasdefaultview	searchasdefaultview		string	將搜尋設定為預設檢視。
啟用版本	enableversion		string	啟用版本。
enablesheetalerter	enablesheetalerter		string	啟動工作表警報器。
alerter條件	alertercondition		string	觸發警示的條件。
OverrideItemModifiedDate	overrideitemmodifieddate		string	超過項目修改日期。
enablebulkinsertupdate	enablebulkinsertupdate		string	允許大量插入更新。
欄位說明	fielddescriptions		string	欄位的描述。
啟用行鎖定	enablerowlocking		string	啟用列鎖定。
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	啟用多行文字的字元限制截斷。
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	設定截斷的字元限制。
允許選擇清單值重複使用	allowchoicelistvaluesforreuse		string	允許重複使用選擇清單值。
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	允許重複使用分數清單值。
allowIsheet註解	allowIsheetComments		string	允許在工作表上發表註解。
共用記錄限制	shareRecordsLimit		integer	共用記錄的限制。
shareRecordsLimit已啟用	shareRecordsLimitEnabled		integer	啟用共用記錄限制。
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	啟用新增記錄表單的共用。
允許ViewBase轉譯	allowViewBaseRendering		string	允許視圖的基本彩現。
列	column		object
記錄計數	recordcount		string	記錄總數。
檢視標識碼	viewId		integer	檢視的唯一識別碼。
siteId	siteId		integer	相關聯網站的識別碼。
siteName （網站名稱）	siteName		string	網站名稱。
sheetName	sheetName		string	工作表的名稱。
檢視名稱	viewName		string	視圖的名稱。
sheetId	sheetId		integer	圖紙的識別碼。
序列	sequence		string	標頭欄的序號。
columnValue	columnValue		string	標頭欄的值。
columnTypeId	columnTypeId		string	資料行類型的識別碼。
columnId	columnId		string	欄位的唯一標識碼。
columnType別名	columnTypeAlias		string	資料行類型的別名。
item序列	itemsequence		string	項目的序號。
項目ID	itemid		string	項目的唯一識別碼。
外部	externalid		string	與項目相關聯的外部識別碼。
columnid	columnid		integer	資料行的唯一識別碼
名稱	name		string	欄的名稱
型別	type		integer	數據行的數據類型。
systemgenerated類型	systemgeneratedtype		string	系統產生的類型資訊。
section	section		integer	欄所在的區段編號。
說明	description		string	欄的詳細說明。
addto預設視圖	addtodefaultview		string	指出是否將欄新增至預設檢視。
columnCondition狀態	columnconditionstate		string	資料行狀況的狀態。
rowid	rowid		integer	資料列的識別碼。
columnid	columnid		integer	資料行的識別碼。
運算子ID	operatorid		integer	運算子的識別碼。
奧普蘭德	oprand		string	篩選器的運算元值。
邏輯類型	logicaltype		string	過濾器的邏輯類型。
sheetfiltervaluetypeid	sheetfiltervaluetypeid		string	工作表篩選器值類型的 ID。
顯示類型	displaytype		string	篩選器的顯示類型。
來源資料欄 ID	sourceColumnId		integer	篩選器的來源資料行識別碼。
scoreConditionTypeid	scoreConditionTypeid		integer	分數條件類型的 ID。
預設值	defaultvalue		string	資料行的預設值。
直欄寬度	columnwidth		string	欄的寬度。
工作表名稱	sheetname		string	關聯圖紙的名稱。
網站名稱	sitename		string	網站名稱。
命令的	mandatory		string	指出該欄是否為必要。
允許搜尋	allowsearch		string	指定是否允許搜尋。
maxchars	maxchars		integer	字元數上限。
allowFieldFromanotheriSheet	allowfieldfromanotherisheet		string	允許來自其他工作表的欄位。
allowrichhtmltext	allowrichhtmltext		string	指定是否允許RTFHTML文字。
行數	numberoflines		integer	欄中的行數。
display方法	displaymethod		string	用來顯示欄的方法。
include其他選項	includeotheroption		string	包括一個“其他”選項。
單一或多重選擇在搜尋中	singleormultileselectioninsearch		string	指定搜尋中的選取類型。
識別碼	id		string	選擇的唯一標識符。
標籤	label		string	選項的標籤。
分數	score		string	與選擇相關聯的分數。
color	color		string	選擇的顏色代碼。
imageid	imageid		integer	相關聯影像的 ID。
includeinalert偏好設定	includeinalertpreferences		string	包含在警示偏好設定中。
min	min		string	資料行的最小值。
max	max		string	資料行的最大值。
小數點位數	decimalplaces		integer	小數位數。
顯示千個分隔符	showthousandseparators		string	顯示千個分隔符號。
顯示百分比	showaspercentage		string	以百分比顯示值。
格式類型	formattype		string	指定欄的格式類型。
日期格式	dateformat		string	定義欄的日期格式。
預設日期和時間	defaultdateandtime		string	設定資料行的預設日期和時間值。
工作表查詢	sheetlookup		string	指出欄是否是對另一個工作表的查閱。
欄位顯示	fielddisplay		string	決定欄位的顯示方式。
允許多個使用者	allowmultipleusers		string	指定多個使用者是否可以存取欄位。
方法類型	methodtype		string	定義資料行的方法類型。
表單	sheetids		string	列出與欄相關聯之圖紙的 ID。
allowuserstorename連結	allowuserstorenamelinks		string	指出使用者是否可以重新命名欄中的連結。
sheetid	sheetid		integer	指定圖紙的 ID。
欄 ID	columnids		string	列出欄的 ID。
檢視ID	viewid		integer	指定視圖的 ID。
allowMultiple值	allowmultiplevalues		string	指出欄中是否允許多個值。
限制刪除	restrictdelete		string	指定是否限制欄的刪除。
displaycolumnname字首	displaycolumnnameprefix		string	設定欄名稱顯示的字首。
連結名稱	linkname		string	定義與欄相關聯的連結名稱。
donotcountweekendsonlycountmontofri	donotcountweekendsonlycountmontofri		string	指定是否在計算中排除週末。
currentsheetcolumnid	currentsheetcolumnid		integer	目前圖紙欄的 ID。
targetsheetcolumnid	targetsheetcolumnid		integer	目標圖紙欄的 ID。
公式	formula		string	指定套用至欄的公式。
開始值	startvalue		integer	設定欄的起始值。
prefix	prefix		string	定義資料行值的前置詞。
後綴	postfix		string	定義直欄值的後置詞。
最小長度	minlength		integer	指定欄值的長度下限。
lookupg詞彙表id	lookupglossarysheetid		integer	指定查閱詞彙表的 ID。
LookUpGlossarySheetViewID	lookupglossarysheetviewid		integer	指定查閱詞彙表的檢視 ID。
寬度	width		integer	設定欄的寬度。
otherscore值	otherscorevalue		string	定義資料行的其他分數值。
importdatafromexternalsource	importdatafromexternalsource		string	指出資料是否從外部來源匯入。
分析引擎	analysisengine		string	指定用於欄的分析引擎。
AttachmentCustomFolderId	attachmentcustomfolderid		integer	指定附件的自訂資料夾 ID。
isattachmentfoldercurrentsite	isattachmentfoldercurrentsite		integer	指出附件資料夾是否在目前網站中。
singleLineEmail驗證	singleLineEmailValidation		string	指定是否套用單行電子郵件驗證。
唯讀	readonly		string	指出資料行是否為唯讀。
虛擬欄	virtualColumn		integer	指定資料行是否為虛擬資料行。
允許內聯編輯	allowInlineEditing		string	指出是否允許欄進行內嵌編輯。
序列	sequence		string	資料行的序號。
屬性列ID	attributecolumnid		string	屬性資料行識別碼。
value	value		string	原始資料的價值。
date	date		string	原始資料的日期。
time	time		string	原始資料的時間。
linkdisplayname	linkdisplayname		string	顯示連結名稱。
linkdisplayurl	linkdisplayurl		string	顯示 URL 連結。
識別碼	id		string	查詢標識碼
電子郵件	email		string	電子郵件地址。
userlookup類型	userlookuptype		string	使用者查詢類型。
folderid	folderid		string	資料夾 ID。
docid	docid		string	文件 ID。
從日期開始	fromdate		string	從日期開始。
迄今為止	todate		string	迄今為止。
檔案	file		string	檔案內容。
名稱	name		string	附件的名稱。
順序	order		string	附件的順序。
識別碼	id		integer	附件的唯一識別碼。
副檔名	extension		string	檔案副檔名。
parentfolderid	parentfolderid		integer	父資料夾的識別碼。
檔案http連結	filehttplink		string	HTTP 連結來存取檔案。
folderpath	folderpath		string	包含檔案的資料夾路徑。
資料夾httplink	folderhttplink		string	資料夾的 HTTP 連結。
檔案大小	filesize		integer	以位元組為單位的檔案大小。
編輯狀態	redactionStatus		boolean	指出檔案是否已密文。
displayname	displayname		string	附件的顯示名稱。
網站ID	siteid		integer	與附件相關聯的網站識別碼。
記錄ID	recordid		string	記錄 ID。
連結名稱	linkname		string	連結名稱。
APILINK	apilink		string	API 連結。
網址連結	httplink		string	HTTP 連結。
colView位置	colViewPosition		integer	欄在視圖中的位置。
資料行類型	columntype		string	欄的類型。
建立日期	createdDate		date-time	建立資料行的日期和時間。
修改日期	modifiedDate		date-time	上次修改資料行的日期和時間。
注入參考欄	injectReferenceColumn		integer	插入資料行的參照
parentColumnID	parentColumnID		integer	父資料行的識別碼。
reuseColumnIDfromisheet	reusecolumnidfromisheet		integer	從輸入表重複使用的資料行 ID。
選擇清單ID	choicelistid		integer	與資料行相關聯之選擇清單的識別碼。
alerter選項	alerteroption		string	項目的警示選項設定。
sheettypeid	sheettypeid		integer	圖紙類型的識別碼。
啟用智能表單	enableSmartForm		string	啟動智慧表單功能。
允許刪除項目視圖	allowDeletedItemsView		string	允許檢視已刪除的項目。
allowAllColumnsInCustomView	allowAllColumnsInCustomView		string	允許自訂檢視中的所有資料行。

傳回

身體: ProgressiveKeyDBO

建立資料夾

作業識別碼：: addFolder

此 API 會在指定的網站內建立新資料夾。它允許您提供資料夾詳細資訊並確保在給定的父資料夾下建立資料夾。

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	指定 API 版本。
批次識別碼	batchid		string	批次作業的唯一識別碼。
根資料夾識別碼	rootfolderid		string	根資料夾的唯一識別碼。
父資料夾識別碼	parentfolderid	True	string	將建立新資料夾的父資料夾的唯一識別碼。
允許重複資料夾	allowduplicatefolder		boolean	指出是否允許在指定的父資料夾中使用重複的資料夾。
名稱	name	True	string	資料夾的名稱。
說明	description		string	資料夾的描述。
access繼承	accessInherited		integer	指出是否繼承資料夾存取權。
batchID	batchID		string	作業的批次識別碼。
dmsfolderid	dmsfolderid		string	DMS 資料夾識別碼。
dmsParentFolderID	dmsParentFolderID		string	DMS 父資料夾識別碼。
DMS創建日期	dmscreateddate		date-time	DMS 資料夾的建立日期。
dms修改者	dmsmodifiedBy		string	上次修改 DMS 資料夾的使用者。
dms資料庫名稱	dmsdatabasename		string	DMS 資料庫的名稱。
DMS連結	dmslink		boolean	指出 DMS 連結是否可用。
dmslink由	dmslinkby		string	連結 DMS 資料夾的使用者。
電子郵件中繼資料	emailmetadata		string	與資料夾相關聯的電子郵件中繼資料。

傳回

身體: FolderDBOV1

擷取 iSheet 欄

作業識別碼：: getIsheetColumns

此 API 呼叫會擷取與指定 iSheet 相關聯的欄。 API 版本 3 及更高版本支援此功能。

參數

名稱	機碼	必要	類型	Description
iSheet ID	isheetid	True	integer	指定需要欄的 iSheet 的唯一 ID。
API 版本	version	True	string	指定正在使用的 API 版本。
iSheet 視圖 ID	sheetviewid		string	指定 iSheet 視圖的 ID。如果省略，則會傳回所有資料行。
包括已刪除的 iSheet 欄	onlyForDeletedIsheet		boolean	指出是否要包括已刪除 iSheet 中的欄。預設值為 false。

傳回

身體: columns

擷取 iSheet 項目清單

作業識別碼：: getISheetItems

此 API 呼叫會擷取指定 iSheet 中包含的項目清單。

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	指定正在使用的 API 版本。
iSheet ID	isheetid	True	integer	指定 iSheet 的唯一 ID。
iSheet 視圖 ID	sheetviewid		integer	指定 iSheet 視圖的 ID。如果省略，則會傳回預設檢視。
排序欄 ID	sortcolumnid		integer	指定用於排序結果的資料行 ID。
排序順序	sortorder		integer	指定排序順序。例如，使用 0 表示遞增順序，或使用另一個值表示遞減順序。
記錄限制	limit		integer	指定要傳回的記錄數目上限;如果未指定，預設值為 100。
記錄偏移	offset		integer	指定記錄擷取的起始位置;如果未指定，預設值為 0。
包括所有欄	allColumnRequired		boolean	此旗標指出是否要包含所有資料行資料，而不論目前的檢視為何。
忽略檢視限制	isIgnoreView		boolean	此旗標指出在擷取項目資料時是否忽略檢視限制。

傳回

名稱	路徑	類型	Description
isheet	isheet	array of object	iSheet 項目的清單。
itemId（項目識別碼）	isheet.itemId	string	項目的唯一識別碼。
資料	isheet.data	array of object	項目的詳細數據。
序列	isheet.data.sequence	string	與資料相關聯的序號。
columnDisplayName	isheet.data.columnDisplayName	string	資料行的顯示名稱。
value	isheet.data.value	string	資料行中包含的值。

擷取使用者清單

作業識別碼：: getAllSystemUsers

擷取使用者清單此 API 會從系統擷取使用者清單。 ## 主要功能 - 使用多個過濾選項獲取用戶詳細信息 - 支持使用和 `limit` 分`offset`頁 - 最新版本中引入的新查詢參數和字段 - 具有用戶角色和屬性的結構化響應 ## 新的查詢參數（Version-Specific） - 在 V12 中引入： - `systemAdminSearch`：當設置為 `1`時，僅返回具有系統管理員角色的用戶。 - V18 中引入：- `userid`：接受逗號分隔值（CSV）。 ## 回應正文更新 - 新增欄位： - `emaildomain`，， `org`，`invitationsentcreatedbycreateddatemodifiedbymodifieddate` - `ifpartnerlastlogindateinvalidloginsexternalidpublicwebsiteprofileid` - `systemuserresetpassworddateusertypeidavatarpracticegroup` - `langcodepublicprofiledateOfBirth`## 位址格式變更（從 V11 開始） - `location` 為了保持一致性，標籤已重新命名為。`address` - 範例回應： `xml <address> <addressid>1</addressid> <addressline1>2nd floor</addressline1> <addressline2>additional</addressline2> <city>London</city> <state>state</state> <country>UK</country> <postCode>EC4R</postCode> </address>` ## 使用者角色（在 API v11+ 中引進） - 範例回應： `xml <roles> <role> <alias>SYSTEM_ADMIN</alias> <name>System Admin</name> </role> <role> <alias>EXTERNAL_ADMIN</alias> <name>External Admin</name> </role> <role> <alias>INTERNAL_USER</alias> <name>Internal User</name> </role> </roles>` ## 限制和偏移 - 限制行為： - 預設值： `100` 如果未提供值。 - 用於 `-1` 傳回所有記錄。 - 如果值小於 `-1`，則預設為 `100`。 - 偏移行為：- 預設值： `0` 如果未提供值。 - 如果偏移超過記錄總數，則預設值回到 `0`。 ## 引入的新角色 - V12： `Basic User`， `Allow user to bypass XSS protection` - V14： `Allow user to manage Contract Express system groups` ## 錯誤代碼 |總結 |參考代碼（V4 之前） |參考代碼（V4） | |---------|----------------------|--------------| |使用者狀態輸入無效（ACTIVE、ARCHIVED、INACTIVE） |147 |147 | |組織 ID 無效 |不適用 |260 | |無效 `neverinvited` 值（true/false） |不適用 |387 | |無效 `neverlogin` 值（true/false） |不適用 |388 | |值無效 `groupids` |不適用 |214 | |無效 `notingroup` 值（true/false） |不適用 |389 | |無效 `ordertype` （支援：姓名、組織、狀態等） |不適用 |289 | |無效 `orderby` （支援：asc、desc） |不適用 |290 | |無效 `offset` 值 | 138 | 138 | |無效 `limit` 值 | 137 | 137 | ## 附註 - 從 V13 開始，此 API 對所有使用者開放（先前僅限於系統管理員）。 - 從 V18 開始，該 `userregistered2FA` 欄位會指出使用者是否已註冊 2FA。 --- 此描述遵循 Swagger 2.0 結構描述格式，應放置在自訂連接器結構描述的描述欄位中。

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	API 的版本。
使用者狀態	status		string	依狀態篩選使用者：「作用中」、「已封存」、「非作用中」或「已鎖定」。
分頁偏移	offset		string	分頁的起始位置。
結果限制	limit		string	每個要求要傳回的項目數。
組織識別碼	orgid		string	依組織識別碼篩選使用者。
從未受邀的使用者	neverinvited		string	擷取從未受邀的使用者。
從未登入的使用者	neverlogin		string	擷取從未登入的使用者。
使用者識別碼	userid		string	按使用者的唯一使用者 ID 篩選使用者。
群組識別碼	groupid		string	依群組識別碼篩選使用者。
不在群組中的使用者	notingroup		string	擷取不在任何群組中的使用者。
排序順序類型	ordertype		string	依指定欄位（例如名稱、組織或狀態）對使用者進行排序。
排序順序	orderby		string	以遞增或遞減順序排序結果。
外部 ID	externalid		string	依外部識別碼篩選使用者。
名字	firstname		string	依名字篩選使用者。
姓氏	lastname		string	依姓氏篩選使用者。
電子郵件地址	email		string	依電子郵件地址篩選使用者。
使用者搜尋	search		string	按各種屬性搜索用戶，包括姓名、電子郵件和職位。
字母過濾器	alphabets		string	篩選姓氏以特定字母開頭的使用者。
職稱	jobtitle		string	按職稱篩選使用者。
地點	locations		string	按城市過濾用戶。
部門	departments		string	依部門篩選使用者。
組織名稱	organisations		string	依組織名稱篩選使用者。
專長	specialities		string	按用戶的專長過濾用戶。
系統管理員搜尋	systemAdminSearch		string	擷取具有系統管理員角色的使用者。

傳回

身體: users

擷取檔案資訊

作業識別碼：: getDocumentInfo

此 API 呼叫會從 HighQ Collaborate 平台擷取指定檔案的詳細資訊。

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	指定正在使用的 API 版本。
檔案 ID	fileid	True	string	指定檔案的唯一 ID。
最新 DMS 資訊旗標	lastdmsinfo		boolean	指出是否要從文件管理系統擷取最新資訊。
資料夾類型	foldertype		string	指定資料夾的類型（如果適用）。
包含檔案狀態資訊	statusinfo		boolean	指出是否要包含其他檔案狀態資訊，例如共用狀態、我的最愛狀態、任務計數和讚好狀態。預設值為 false。
包含電子郵件中繼資料	emailmetadata		boolean	指出是否包含電子郵件中繼資料，例如寄件者、收件者和時間戳記。預設值為 false。

傳回

身體: DocumentDBO

擷取資料夾清單

作業識別碼：: getFolderList

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	指定正在使用的 API 版本。
資料夾 ID	folderid	True	string	指定資料夾的唯一識別碼。
物品限制	limit		string	指定要傳回的項目數目上限。
項目偏移	offset		string	指定傳回項目的起始位置。
排序順序方向	orderby		string	指定排序項目的順序方向。使用 'asc' 進行升序，或使用 'desc' 進行降序。
排序準則	ordertype		string	指定排序項目的準則，例如名稱、作者或上次修改日期。
包含資料夾狀態資訊	statusinfo		boolean	指出是否要包含其他資料夾狀態資訊。預設值為 false。
包括智慧資料夾	includesmartfolder		boolean	指出是否要在傳回的清單中包含智慧資料夾。預設值為 false。

傳回

名稱	路徑	類型	Description
檔案夾	folder	array of object
items	folder	object

新增網站

作業識別碼：: createSite

參數

名稱	機碼	必要	類型	Description
所要求的 API 版本	version	True	string	API 版本
識別碼	id		integer	網站識別碼。
網站名稱	sitename		string	網站的名稱。
角色	role		string	網站的角色。
網站說明	sitedescription		string	網站的描述。
啟用模組	enabledmodules		string	為網站啟用的模組清單。
sitefolderID	sitefolderID		string	網站資料夾的識別碼。
sitefolder權限	sitefolderpermission		string	網站資料夾的權限層級。
啟用	enable		string	啟用 HomeDBO 的狀態。
啟用	enable		string	啟用 ActivityDBO 的狀態。
微博	microblog		string	與 ActivityDBO 相關的微博內容。
docid	docid		string	文件 ID。
博客標題	blogTitle		string	部落格文章的標題。
部落格內容	blogContent		string	部落格文章的內容。
顯示評論	showComment		integer	顯示註解。
標籤清單	tagList		array of string	與部落格相關聯的標籤清單。
狀態	status		integer	部落格文章的狀態。
網站標識碼	siteID		integer	相關聯網站的識別碼。
作者	author		string	博客的作者。
categoryList	categoryList		array of string	指派給部落格文章的類別。
通知類型識別碼	notificationTypeID		integer	通知類型的識別碼。
訊息	message		string	與部落格相關的訊息內容。
messageCode	messageCode		integer	與訊息相關聯的程式碼。
外部識別碼	externalID		string	連結至部落格的外部識別碼。
發佈日期	publishDate		string	博客的發布日期。
程序類型	processtype		string	與部落格相關聯的處理程序類型。
啟用	enable		string	啟用 BlogDBO 的狀態。
維基ID	wikiid		integer	維基的唯一標識符。
currentversionid	currentversionid		integer	目前維基版本的標識符
家長維基ID	parentwikiid		integer	父維基的標識符。
維基標題	wikititle		string	維基的標題。
維基內容	wikicontent		string	維基的內容。
顯示評論	showcomment		integer	指出是否已啟用註解。
創建日期	createddate		string	維基的創建日期。
修改日期	modifieddate		string	維基的最後修改日期。
標籤列表	taglist		string	與維基相關聯的標籤以逗號分隔的清單。
維基百科	wikipath		string	存取 wiki 的路徑。
維基草稿ID	wikidraftid		integer	維基草稿版本的標識符。
草稿類型	drafttype		string	與 wiki 相關聯的草稿類型。
狀態	status		integer	維基的當前狀態。
維基版本ID	wikiversionid		integer	wiki 的版本標識符。
索引	index		string	工作的索引或識別碼。
parenttaskid	parenttaskid		integer	父任務的識別碼。
任務ID	taskid		integer	工作的唯一識別碼。
title	title		string	任務的標題。
說明	description		string	任務的詳細描述。
過期	duedate		string	任務完成的到期日。
開始日期	startdate		string	啟動任務的開始日期。
MatterMapTaskID	mattermaptaskid		string	連結至事務對應任務的識別碼。
型別	type		string	任務的類型或類別。
依賴	dependenton		string	此工作相依的工作。
天數從依賴	daysfromdependent		string	相依任務的天數。
忽略週末	ignoreweekend		integer	指出是否在排程中忽略週末。
duration	duration		integer	完成任務的持續時間。
資源	resource		string	指派給任務的資源。
活動標題	eventTitle		string	活動名稱。
活動內容	eventContent		string	活動內容。
顯示評論	showComment		integer	指出是否已啟用事件的註解。
標籤清單	tagList		array of string	與事件相關聯的標籤清單。
狀態	status		integer	事件的當前狀態。
網站標識碼	siteID		integer	網站的識別碼。
連絡人	contact		string	活動的聯繫信息。
categoryList	categoryList		array of string	列出事件的類別。
通知類型識別碼	notificationTypeID		integer	與事件相關的通知類型。
訊息	message		string	事件的訊息。
messageCode	messageCode		integer	事件的訊息碼。
外部識別碼	externalID		string	外部識別碼。
startDate	startDate		string	事件的開始日期。
結束日期	endDate		string	事件的結束日期。
startTime	startTime		string	事件的開始時間。
endTime	endTime		string	事件的結束時間。
位置	location		string	活動地點。
作者	author		string	事件的作者。
程序類型	processtype		string	事件的處理時間。
啟用	enable		string	啟用是活動。
識別碼	id		integer	iSheet 的唯一識別碼。
title	title		string	iSheet 的標題。
說明	description		string	isheet 的描述。
狀態	status		string	isheet 的狀態。
accesstype	accesstype		string	訪問 isheet 的類型。
型別	type		string	isheet 的類型。
檢視連結	viewlink		string	查看 iSheet 的連結。
允許區段	allowsections		string	是否允許區段。
允許查找	allowlookup		string	是否啟用查閱欄位。
顯示i表	displayisheet		string	iSheet 的顯示選項。
searchasdefaultview	searchasdefaultview		string	指出搜尋是否為預設檢視。
啟用版本	enableversion		string	已啟用版本控制旗標。
enablesheetalerter	enablesheetalerter		string	旗標以啟用工作表警示。
alerter條件	alertercondition		string	觸發警示的條件。
OverrideItemModifiedDate	overrideitemmodifieddate		string	覆寫修改日期旗標。
enablebulkinsertupdate	enablebulkinsertupdate		string	啟用大量插入/更新。
欄位說明	fielddescriptions		string	iSheet 的欄位描述。
啟用行鎖定	enablerowlocking		string	啟用列層級鎖定。
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	截斷多行文字旗標。
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	多行截斷的字元限制。
允許選擇清單值重複使用	allowchoicelistvaluesforreuse		string	允許重複使用選擇清單值。
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	允許重複使用分數清單值。
allowIsheet註解	allowIsheetComments		string	允許在 iSheet 中註解。
共用記錄限制	shareRecordsLimit		integer	允許共享的記錄限制。
shareRecordsLimit已啟用	shareRecordsLimitEnabled		integer	已啟用記錄共用限制。
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	啟用表單共用以新增記錄。
記錄計數	recordcount		string	目前的記錄計數。
sheettypeid	sheettypeid		integer	iSheet 的類型 ID
啟用	enable		string	啟用 QA 功能。
使用者識別碼	userid		integer	使用者識別碼。
電子郵件	email		string	電子郵件地址。
httpavatar	httpavatar		string	頭像的 HTTP URL。
頭像	avatar		string	頭像圖像。
用戶鏈接	userlink		string	連結至使用者設定檔。
網址連結	httplink		string	使用者設定檔的 HTTP 連結。
phone	phone		string	電話號碼。
行動	mobile		string	手機號碼。
部門	department		string	使用者的部門。
啟用	enable		string	啟用 Contract Express 整合。
管理員註釋	adminnote		string	與該網站相關的行政說明。
開始日期	startdate		string	網站作業的開始日期。
結束日期	enddate		string	網站作業的結束日期。
創建日期	createddate		string	網站建立日期。
存檔日期	archiveddate		string	網站封存的日期。
客戶編號	clientno		string	與網站相關聯的用戶端號碼。
馬特諾	matterno		string	與網站相關聯的案件編號。
登陸頁面	landingpage		string	網站的登陸頁面URL。
連結	link		string	與網站相關的連結。
狀態	status		string	網站的目前狀態。
狀態ID	statusid		integer	網站狀態的識別碼。
size	size		string	網站的大小。
帳單附註	billingnotes		string	與網站計費相關的註釋。
計費下一個發票日期	billingnextinvoicedate		string	網站的下一張發票日期。
billinglastinvoicedate	billinglastinvoicedate		string	網站最後一張發票的日期。
檔案頁數	filepagecount		string	網站上檔案的總頁數。
最大頁數	maxpagecount		string	網站上檔案允許的頁數上限。
網站http連結	sitehttplink		string	網站的 HTTP 連結。
是同義的	isSyncable		integer	指出網站是否可同步處理。
enforceUser群組	enforceusergroups		string	針對網站強制執行的使用者群組。
csvSite類別	csvSiteCategory		string	CSV 格式的網站類別。
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	預設語言的網站名稱。
看得見的	visible		integer	指出網站是否可見。
網站標誌名稱	siteLogoName		string	網站標誌檔案的名稱。
siteLogo檔案大小	siteLogoFileSize		integer	網站標誌的檔案大小。
網站標誌高度	siteLogoHeight		integer	網站標誌的高度。
網站標誌寬度	siteLogoWidth		integer	網站標誌的寬度。
網站狀態	siteStatus		integer	網站的狀態碼。
applySite條款	applySiteTerms		integer	指出是否套用網站術語。
網站術語	siteTerm		string	適用於網站的條款。
術語類型	termType		integer	套用至網站的字詞類型。
下一個登入網站條款	nextLoginSiteTerms		integer	指出下次登入時是否需要網站術語。
defaultSiteTerms啟用	defaultSiteTermsEnable		integer	指出是否已啟用預設網站字詞。
進階QA任務	advancedQAPermission		integer	網站的進階 QA 權限層級。
isInternal	isInternal		integer	指出網站是否為內部網站。
PSM	psm		integer	Product Service Manager 識別碼。
siteLabel顯示	siteLabelDisplay		string	網站的顯示標籤。
允許網站管理	allowSiteAdministration		integer	指出是否允許網站管理。
siteLevel密碼啟用	siteLevelPasswordEnable		integer	啟用網站層級密碼保護。
siteLevelPasscode啟用	siteLevelPasscodeEnable		integer	啟用網站層級密碼保護。
密碼UsingAuthApp	passcodeUsingAuthApp		integer	指出密碼驗證是否使用驗證應用程式。
網站密碼	sitePassword		string	與網站相關聯的密碼。
ipRestriction啟用	ipRestrictionEnable		integer	啟用網站存取的 IP 限制。
可用IP	availableIP		string	允許存取網站的 IP 位址以逗號分隔的清單。
highqDrive	highqDrive		integer	指出是否已啟用 HighQ Drive 整合。
applySite首頁	applySiteHomePage		integer	套用網站的自訂首頁。
網站首頁	siteHomePage		string	網站自訂首頁的 URL。
siteHomePage類型	siteHomePageType		integer	首頁的類型。
next登入網站首頁	nextLoginSiteHomePage		integer	設定下次登入網站首頁。
applyDisplayContent	applyDisplayContent		integer	套用顯示內容設定。
顯示內容	displayContent		string	要在網站上顯示的內容。
rss安全	rssSecurity		integer	RSS 摘要安全性層級。
加密密碼	encryptedPassword		integer	指出網站密碼是否已加密。
可用的IPRangeCSV	availableIPRangeCSV		string	允許存取網站的 IP 位址範圍以逗號分隔的清單。
siteModuleID	siteModuleID		integer	網站模組的識別碼。
icalSecurity	icalSecurity		integer	iCal 摘要安全性層級。
預設顯示內容	defaultDisplayContent		string	要在網站上顯示的預設內容。
預設電子郵件警示	defaultEmailAlert		integer	啟用預設電子郵件警示。
excelReport頁尾	excelReportFooter		integer	在 Excel 報表中包含頁尾。
excelReport頁尾文字	excelReportFooterText		string	要在 Excel 報表頁尾中顯示的文字。
公告MLJSON	announcementMLJSON		string	網站的 JSON 格式公告。
templateType	templateType		integer	用於網站的範本類型。
templateLicense	templateLicence		integer	網站範本的授權類型。
openChannelAppID	openChannelAppID		string	開放通道整合的應用程式 ID。
項目ID	itemid		integer	與網站相關聯之項目的識別碼。
sitemetadatasheetid	sitemetadatasheetid		integer	與網站相關聯的中繼資料表識別碼。
我的網站	mysite		boolean	指出這是否是使用者的個人網站。
最後存取日期	lastaccesseddate		string	上次存取網站的日期和時間。
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	網站檢視器的預設中繼資料索引標籤。
documentMetadataViewId	documentMetadataViewId		integer	檢視識別碼的文件中繼資料。
folderMetadataViewId	folderMetadataViewId		integer	檢視識別碼的資料夾中繼資料。
文件排序	docSort		integer	文件的排序順序。
folderSort	folderSort		integer	資料夾的排序順序。
defaultFolderRenderView	defaultFolderRenderView		integer	決定資料夾的預設檢視模式。
isTaskAttachment預設值	isTaskAttachmentDefault		integer	任務附件的預設位置。
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	指定為工作附件預設位置的資料夾的唯一識別碼。
收藏夾	favourite		string	最喜歡的狀態。
enabledocumentredaction	enabledocumentredaction		boolean	指定是否為網站啟用文件密文。
提及群組	mentiongroups		integer	上述組。
啟用檔案關係	enablefilerelationships		boolean	指出是否已啟用檔案關係。
FileRelationshipSitePermissionLevel	filerelationshipsitepermissionlevel		integer	管理檔案關聯性所需的權限層級。

傳回

身體: site

更新網站

作業識別碼：: updateSite

使用此 API 端點來更新現有網站的詳細資料。 API支援建立網站API中使用的相同欄位。

此方法支援使用 API 版本 10 以上將多個案件編號新增至網站。 “matternos”標籤表示多個具有唯讀或非唯讀的事項編號。

版本 18 以上：需要類別（網站用途）。如果網站用途已隱藏，則會顯示訊息;否則，隱藏的網站用途不會新增至網站。

現在，也可以為網站擁有者指派其他使用者，但他們必須是網站參與者，且角色高於網站管理員。

版本 18 以上：網站擁有者可以將其他使用者新增至網站。

從 API 版本 19 開始，引入了一個名為 customPages 的新模組，它與 home 模組緊密耦合。如果主模組值為 True，則 customPages 必須為 true，反之亦然。

請注意，get site 回應中的所有屬性/元素都不可更新/插入。請參閱下表，瞭解哪些是唯讀、可更新或可插入的。

參數

名稱	機碼	必要	類型	Description
所要求的 API 版本	version	True	string	API 版本
網站的唯一識別碼	siteid	True	string	網站的識別碼
識別碼	id		integer	網站識別碼。
網站名稱	sitename		string	網站的名稱。
角色	role		string	網站的角色。
網站說明	sitedescription		string	網站的描述。
啟用模組	enabledmodules		string	為網站啟用的模組清單。
sitefolderID	sitefolderID		string	網站資料夾的識別碼。
sitefolder權限	sitefolderpermission		string	網站資料夾的權限層級。
啟用	enable		string	啟用 HomeDBO 的狀態。
啟用	enable		string	啟用 ActivityDBO 的狀態。
微博	microblog		string	與 ActivityDBO 相關的微博內容。
docid	docid		string	文件 ID。
博客標題	blogTitle		string	部落格文章的標題。
部落格內容	blogContent		string	部落格文章的內容。
顯示評論	showComment		integer	顯示註解。
標籤清單	tagList		array of string	與部落格相關聯的標籤清單。
狀態	status		integer	部落格文章的狀態。
網站標識碼	siteID		integer	相關聯網站的識別碼。
作者	author		string	博客的作者。
categoryList	categoryList		array of string	指派給部落格文章的類別。
通知類型識別碼	notificationTypeID		integer	通知類型的識別碼。
訊息	message		string	與部落格相關的訊息內容。
messageCode	messageCode		integer	與訊息相關聯的程式碼。
外部識別碼	externalID		string	連結至部落格的外部識別碼。
發佈日期	publishDate		string	博客的發布日期。
程序類型	processtype		string	與部落格相關聯的處理程序類型。
啟用	enable		string	啟用 BlogDBO 的狀態。
維基ID	wikiid		integer	維基的唯一標識符。
currentversionid	currentversionid		integer	目前維基版本的標識符
家長維基ID	parentwikiid		integer	父維基的標識符。
維基標題	wikititle		string	維基的標題。
維基內容	wikicontent		string	維基的內容。
顯示評論	showcomment		integer	指出是否已啟用註解。
創建日期	createddate		string	維基的創建日期。
修改日期	modifieddate		string	維基的最後修改日期。
標籤列表	taglist		string	與維基相關聯的標籤以逗號分隔的清單。
維基百科	wikipath		string	存取 wiki 的路徑。
維基草稿ID	wikidraftid		integer	維基草稿版本的標識符。
草稿類型	drafttype		string	與 wiki 相關聯的草稿類型。
狀態	status		integer	維基的當前狀態。
維基版本ID	wikiversionid		integer	wiki 的版本標識符。
索引	index		string	工作的索引或識別碼。
parenttaskid	parenttaskid		integer	父任務的識別碼。
任務ID	taskid		integer	工作的唯一識別碼。
title	title		string	任務的標題。
說明	description		string	任務的詳細描述。
過期	duedate		string	任務完成的到期日。
開始日期	startdate		string	啟動任務的開始日期。
MatterMapTaskID	mattermaptaskid		string	連結至事務對應任務的識別碼。
型別	type		string	任務的類型或類別。
依賴	dependenton		string	此工作相依的工作。
天數從依賴	daysfromdependent		string	相依任務的天數。
忽略週末	ignoreweekend		integer	指出是否在排程中忽略週末。
duration	duration		integer	完成任務的持續時間。
資源	resource		string	指派給任務的資源。
活動標題	eventTitle		string	活動名稱。
活動內容	eventContent		string	活動內容。
顯示評論	showComment		integer	指出是否已啟用事件的註解。
標籤清單	tagList		array of string	與事件相關聯的標籤清單。
狀態	status		integer	事件的當前狀態。
網站標識碼	siteID		integer	網站的識別碼。
連絡人	contact		string	活動的聯繫信息。
categoryList	categoryList		array of string	列出事件的類別。
通知類型識別碼	notificationTypeID		integer	與事件相關的通知類型。
訊息	message		string	事件的訊息。
messageCode	messageCode		integer	事件的訊息碼。
外部識別碼	externalID		string	外部識別碼。
startDate	startDate		string	事件的開始日期。
結束日期	endDate		string	事件的結束日期。
startTime	startTime		string	事件的開始時間。
endTime	endTime		string	事件的結束時間。
位置	location		string	活動地點。
作者	author		string	事件的作者。
程序類型	processtype		string	事件的處理時間。
啟用	enable		string	啟用是活動。
識別碼	id		integer	iSheet 的唯一識別碼。
title	title		string	iSheet 的標題。
說明	description		string	isheet 的描述。
狀態	status		string	isheet 的狀態。
accesstype	accesstype		string	訪問 isheet 的類型。
型別	type		string	isheet 的類型。
檢視連結	viewlink		string	查看 iSheet 的連結。
允許區段	allowsections		string	是否允許區段。
允許查找	allowlookup		string	是否啟用查閱欄位。
顯示i表	displayisheet		string	iSheet 的顯示選項。
searchasdefaultview	searchasdefaultview		string	指出搜尋是否為預設檢視。
啟用版本	enableversion		string	已啟用版本控制旗標。
enablesheetalerter	enablesheetalerter		string	旗標以啟用工作表警示。
alerter條件	alertercondition		string	觸發警示的條件。
OverrideItemModifiedDate	overrideitemmodifieddate		string	覆寫修改日期旗標。
enablebulkinsertupdate	enablebulkinsertupdate		string	啟用大量插入/更新。
欄位說明	fielddescriptions		string	iSheet 的欄位描述。
啟用行鎖定	enablerowlocking		string	啟用列層級鎖定。
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled		string	截斷多行文字旗標。
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval		string	多行截斷的字元限制。
允許選擇清單值重複使用	allowchoicelistvaluesforreuse		string	允許重複使用選擇清單值。
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse		string	允許重複使用分數清單值。
allowIsheet註解	allowIsheetComments		string	允許在 iSheet 中註解。
共用記錄限制	shareRecordsLimit		integer	允許共享的記錄限制。
shareRecordsLimit已啟用	shareRecordsLimitEnabled		integer	已啟用記錄共用限制。
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing		string	啟用表單共用以新增記錄。
記錄計數	recordcount		string	目前的記錄計數。
sheettypeid	sheettypeid		integer	iSheet 的類型 ID
啟用	enable		string	啟用 QA 功能。
使用者識別碼	userid		integer	使用者識別碼。
電子郵件	email		string	電子郵件地址。
httpavatar	httpavatar		string	頭像的 HTTP URL。
頭像	avatar		string	頭像圖像。
用戶鏈接	userlink		string	連結至使用者設定檔。
網址連結	httplink		string	使用者設定檔的 HTTP 連結。
phone	phone		string	電話號碼。
行動	mobile		string	手機號碼。
部門	department		string	使用者的部門。
啟用	enable		string	啟用 Contract Express 整合。
管理員註釋	adminnote		string	與該網站相關的行政說明。
開始日期	startdate		string	網站作業的開始日期。
結束日期	enddate		string	網站作業的結束日期。
創建日期	createddate		string	網站建立日期。
存檔日期	archiveddate		string	網站封存的日期。
客戶編號	clientno		string	與網站相關聯的用戶端號碼。
馬特諾	matterno		string	與網站相關聯的案件編號。
登陸頁面	landingpage		string	網站的登陸頁面URL。
連結	link		string	與網站相關的連結。
狀態	status		string	網站的目前狀態。
狀態ID	statusid		integer	網站狀態的識別碼。
size	size		string	網站的大小。
帳單附註	billingnotes		string	與網站計費相關的註釋。
計費下一個發票日期	billingnextinvoicedate		string	網站的下一張發票日期。
billinglastinvoicedate	billinglastinvoicedate		string	網站最後一張發票的日期。
檔案頁數	filepagecount		string	網站上檔案的總頁數。
最大頁數	maxpagecount		string	網站上檔案允許的頁數上限。
網站http連結	sitehttplink		string	網站的 HTTP 連結。
是同義的	isSyncable		integer	指出網站是否可同步處理。
enforceUser群組	enforceusergroups		string	針對網站強制執行的使用者群組。
csvSite類別	csvSiteCategory		string	CSV 格式的網站類別。
siteNameInDefaultLanguage	siteNameInDefaultLanguage		string	預設語言的網站名稱。
看得見的	visible		integer	指出網站是否可見。
網站標誌名稱	siteLogoName		string	網站標誌檔案的名稱。
siteLogo檔案大小	siteLogoFileSize		integer	網站標誌的檔案大小。
網站標誌高度	siteLogoHeight		integer	網站標誌的高度。
網站標誌寬度	siteLogoWidth		integer	網站標誌的寬度。
網站狀態	siteStatus		integer	網站的狀態碼。
applySite條款	applySiteTerms		integer	指出是否套用網站術語。
網站術語	siteTerm		string	適用於網站的條款。
術語類型	termType		integer	套用至網站的字詞類型。
下一個登入網站條款	nextLoginSiteTerms		integer	指出下次登入時是否需要網站術語。
defaultSiteTerms啟用	defaultSiteTermsEnable		integer	指出是否已啟用預設網站字詞。
進階QA任務	advancedQAPermission		integer	網站的進階 QA 權限層級。
isInternal	isInternal		integer	指出網站是否為內部網站。
PSM	psm		integer	Product Service Manager 識別碼。
siteLabel顯示	siteLabelDisplay		string	網站的顯示標籤。
允許網站管理	allowSiteAdministration		integer	指出是否允許網站管理。
siteLevel密碼啟用	siteLevelPasswordEnable		integer	啟用網站層級密碼保護。
siteLevelPasscode啟用	siteLevelPasscodeEnable		integer	啟用網站層級密碼保護。
密碼UsingAuthApp	passcodeUsingAuthApp		integer	指出密碼驗證是否使用驗證應用程式。
網站密碼	sitePassword		string	與網站相關聯的密碼。
ipRestriction啟用	ipRestrictionEnable		integer	啟用網站存取的 IP 限制。
可用IP	availableIP		string	允許存取網站的 IP 位址以逗號分隔的清單。
highqDrive	highqDrive		integer	指出是否已啟用 HighQ Drive 整合。
applySite首頁	applySiteHomePage		integer	套用網站的自訂首頁。
網站首頁	siteHomePage		string	網站自訂首頁的 URL。
siteHomePage類型	siteHomePageType		integer	首頁的類型。
next登入網站首頁	nextLoginSiteHomePage		integer	設定下次登入網站首頁。
applyDisplayContent	applyDisplayContent		integer	套用顯示內容設定。
顯示內容	displayContent		string	要在網站上顯示的內容。
rss安全	rssSecurity		integer	RSS 摘要安全性層級。
加密密碼	encryptedPassword		integer	指出網站密碼是否已加密。
可用的IPRangeCSV	availableIPRangeCSV		string	允許存取網站的 IP 位址範圍以逗號分隔的清單。
siteModuleID	siteModuleID		integer	網站模組的識別碼。
icalSecurity	icalSecurity		integer	iCal 摘要安全性層級。
預設顯示內容	defaultDisplayContent		string	要在網站上顯示的預設內容。
預設電子郵件警示	defaultEmailAlert		integer	啟用預設電子郵件警示。
excelReport頁尾	excelReportFooter		integer	在 Excel 報表中包含頁尾。
excelReport頁尾文字	excelReportFooterText		string	要在 Excel 報表頁尾中顯示的文字。
公告MLJSON	announcementMLJSON		string	網站的 JSON 格式公告。
templateType	templateType		integer	用於網站的範本類型。
templateLicense	templateLicence		integer	網站範本的授權類型。
openChannelAppID	openChannelAppID		string	開放通道整合的應用程式 ID。
項目ID	itemid		integer	與網站相關聯之項目的識別碼。
sitemetadatasheetid	sitemetadatasheetid		integer	與網站相關聯的中繼資料表識別碼。
我的網站	mysite		boolean	指出這是否是使用者的個人網站。
最後存取日期	lastaccesseddate		string	上次存取網站的日期和時間。
defaultViewerMetaDataTab	defaultViewerMetaDataTab		integer	網站檢視器的預設中繼資料索引標籤。
documentMetadataViewId	documentMetadataViewId		integer	檢視識別碼的文件中繼資料。
folderMetadataViewId	folderMetadataViewId		integer	檢視識別碼的資料夾中繼資料。
文件排序	docSort		integer	文件的排序順序。
folderSort	folderSort		integer	資料夾的排序順序。
defaultFolderRenderView	defaultFolderRenderView		integer	決定資料夾的預設檢視模式。
isTaskAttachment預設值	isTaskAttachmentDefault		integer	任務附件的預設位置。
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId		integer	指定為工作附件預設位置的資料夾的唯一識別碼。
收藏夾	favourite		string	最喜歡的狀態。
enabledocumentredaction	enabledocumentredaction		boolean	指定是否為網站啟用文件密文。
提及群組	mentiongroups		integer	上述組。
啟用檔案關係	enablefilerelationships		boolean	指出是否已啟用檔案關係。
FileRelationshipSitePermissionLevel	filerelationshipsitepermissionlevel		integer	管理檔案關聯性所需的權限層級。

更新網站群組

作業識別碼：: updateSiteGroup

此 API 方法會更新網站中現有群組的名稱。
此 API 已擴充，以更新網站中現有基本使用者群組的名稱。

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	版本
網站的 ID	siteid	True	string	網站的識別碼。
API 版本	groupid	True	string	`The ID of the site group.`
名稱	name		string
識別碼	id		integer
copypermissionsfrom（複製權限來源）	copypermissionsfrom		string
訊息	message		string
類型標識	typeID		integer
型別	type		string
用戶數量	numberofusers		string
創建	created		string
modified	modified		string
系統群組識別碼	systemGroupID		integer
說明	description		string
基本使用者群組	basicusergroup		integer

傳回

身體: sitegroup

添加使用者

作業識別碼：: createUser

摘要	參考代碼（V4 之前）	參考代碼（V4）
電子郵件地址為必填項	101	101
無效的電子郵件地址	104	104
名字是必填的	102	102
名字允許的字元數上限必須介於 1 到 100 之間	102	352
秘書/助理的電子郵件地址無效	104	353
狀態必須為作用中或非作用中	116	116
輸入的部門不能超過 256 個字元	N/A	354
輸入的 ifpartner 屬性無效	N/A	355
輸入的systemuser屬性無效	N/A	356
輸入的 usertypeid 屬性無效	N/A	357
輸入的langcode屬性無效	N/A	358
輸入的 sourcetype 屬性無效。有效值為 System、Active Directory 或 System default 。	N/A	359
請輸入有效電話號碼	N/A	360
請輸入有效的電話號碼，格式為{countrycode} ${areacode }${number}。	N/A	361
請輸入有效的手機號碼，格式為{countrycode}${number}。	N/A	362
輸入有效的辦公室電話國家/地區代碼	N/A	363
辦公室電話國家/地區代碼最多可以有 4 位數字	N/A	364
輸入有效的辦公室電話區號	N/A	365
辦公室電話區號最多可以有 5 位數字	N/A	366
辦公室電話號碼最多應為 15 位數字	N/A	368
輸入有效的手機國家/地區代碼	N/A	369
手機國家代碼最多可以有 4 位數字	N/A	372
請輸入有效的手機號碼	N/A	373
手機號碼最多應為 20 位數字	N/A	374
網域不存在	105	105
系統中已存在電子郵件	111	111
在自行註冊網域的情況下提及組織	187	187
在特殊領域的情況下提及組織	115	115
組織識別碼的格式不正確	112	112
組織不存在	106	106
網域存在於其他組織中	114	114
輸入的地址 ID 無效	N/A	308
在系統中找不到社交連結名稱。	N/A	375
社交連結名稱是必填項	N/A	376
社交連結值是必填的	N/A	377
社交連結值的字元數上限必須介於 1 到 500 之間	N/A	378
輸入自訂連結的名稱	N/A	379
所需的自訂連結值	N/A	380
自訂連結名稱的字元數上限必須介於 1 到 500 之間	N/A	381
自訂連結值的字元數上限必須介於 1 到 500 之間	N/A	382
必要的訊息連結名稱	N/A	383
在系統中找不到訊息鏈結名稱	N/A	384
必要的訊息連結值	N/A	385
訊息鏈結值的字元數上限必須介於 1 到 500 之間	N/A	386
社交連結已停用	N/A	408
訊息連結已停用	N/A	409
自訂連結已停用	N/A	410

JIRA 門票： https://dev.highq.com/jira/browse/COL-65685

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	API 版本
索引	index		integer	使用者的唯一索引。
使用者識別碼	userid		integer	用戶的唯一識別碼。
名字	firstname		string	使用者的名字。
姓氏	lastname		string	使用者的姓氏。
執業組	practicegroup		string	使用者所屬的練習群組。
朗碼	langcode		string	使用者的語言代碼。
localeID	localeID		string	使用者的地區設定 ID。
公開簡介	publicprofile		string	使用者的公開設定檔。
PWPID	pwpid		string	使用者的 PWP ID。
使用者類型ID	usertypeid		string	使用者類型 ID。
systemuser	systemuser		string	系統使用者旗標。
電子郵件	email		string	使用者的電子郵件地址。
phone	phone		string	使用者的電話號碼。
行動	mobile		string	用戶的手機號碼。
部門	department		string	用戶部門。
組織	org		string	使用者所屬的組織。
位址行1	addressline1		string	地址的第一行。
地址行2	addressline2		string	地址的第二行。
地址行3	addressline3		string	地址的第三行。
city	city		string	位址所在的城市。
狀態	state		string	地址的狀態。
country	country		string	地址的國家/地區。
郵遞區號	postcode		string	地址的郵遞區號。
地址ID	addressid		string	地址的唯一識別碼。
位址行1	addressline1		string	地址的第一行。
地址行2	addressline2		string	地址的第二行。
地址行3	addressline3		string	地址的第三行。
city	city		string	位址所在的城市。
狀態	state		string	地址的狀態。
country	country		string	地址的國家/地區。
郵政編碼	postCode		string	地址的郵遞區號。
已知	knownas		string	地址的替代名稱或暱稱。
體驗	experience		array of string
識別碼	id		string	連結ID
名稱	name		string	連結名稱。
value	value		string	連結值。
識別碼	id		string	連結ID
名稱	name		string	連結名稱。
value	value		string	連結值。
識別碼	id		string	連結ID
名稱	name		string	連結名稱。
value	value		string	連結值。
圖像	img		string
reports至	reportsto		string
metadataname	metadataname		array of string
metadata值	metadatavalue		array of string
組成群組	group		array of string
外部	externalid		string	使用者的外部 ID。
職稱	jobtitle		string	使用者的職稱。
秘書名稱	secretaryname		string	使用者秘書的名稱。
秘書郵件	secretarymail		string	使用者秘書的電子郵件。
專長	specialities		string	用戶的專長。
title	title		string	使用者的職稱。
戈斯比	goesby		string	使用者的偏好名稱。
後綴	suffix		string	使用者名稱的尾碼。
原子連結	atomlink		string	與使用者相關聯的 Atom 連結。
簡介	bio		string	用戶傳記。
dateOfBirth	dateOfBirth		string	使用者的出生日期。
連結	link		string	與使用者相關聯的連結。
狀態	status		string	使用者的狀態。
狀態代碼	statuscode		string	使用者的狀態碼。
訊息	message		string	與使用者相關聯的訊息。
來源類型	sourcetype		string	使用者的來源類型。
orgid	orgid		string	組織 ID。
if合作夥伴	ifpartner		string	合作夥伴旗標。
電子郵件網域	emaildomain		string	使用者的電子郵件網域。
邀請已發送	invitationsent		string	邀請已發送旗標。
創建者	createdby		string	建立記錄的使用者。
創建日期	createddate		string	記錄的建立日期。
修改者	modifiedby		string	修改記錄的使用者。
修改日期	modifieddate		string	記錄修改日期。
lastlogindate	lastlogindate		string	上次登入的日期。
無效登入	invalidlogins		string	無效登入嘗試的計數。
publicwebsiteprofileid	publicwebsiteprofileid		string	公用網站設定檔 ID。
重設密碼日期	resetpassworddate		string	密碼重設日期。
頭像	avatar		string	虛擬人偶影像 URL。
以下計數	followingcount		integer	被追蹤的使用者計數。
追隨者計數	followercount		integer	追隨者人數。
以下	following		boolean	後續旗標。
角色	role		string	使用者的角色。
是基本用戶	isbasicuser		string	基本使用者旗標。
加密使用者識別碼	encryptedUserId		string	加密的使用者 ID。
自行註冊	selfregistered		integer	自行註冊旗標。
註冊與2FA	registeredWith2FA		string	雙因素驗證註冊旗標。
isInternal	isInternal		integer	內部使用者旗標。
組織名稱	orgName		string	組織的名稱。

傳回

身體: IntegrationUserDBO

移動文件

作業識別碼：: moveDocuments

此 API 會將多個檔案從同一網站內的一個資料夾移至另一個資料夾。

參數

名稱	機碼	必要	類型	Description
API 版本	version	True	string	指定 API 版本。
目標資料夾ID	targetfolder	True	string	將移動檔案的目標資料夾的唯一識別碼。
fileidCSV	fileidCSV		string	要移動的檔案 ID 的逗號分隔清單。

定義

錯誤DBO

名稱	路徑	類型
摘要	summary	string
ref	ref	string
連結	link	string

文件DBO

名稱	路徑	類型	Description
docid	docid	string	文件 ID。

columns

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

地點DBO

名稱	路徑	類型	Description
位址行1	addressline1	string	地址的第一行。
地址行2	addressline2	string	地址的第二行。
地址行3	addressline3	string	地址的第三行。
city	city	string	位址所在的城市。
狀態	state	string	地址的狀態。
country	country	string	地址的國家/地區。
郵遞區號	postcode	string	地址的郵遞區號。

UserName

名稱	路徑	類型	Description
title	title	string	使用者的職稱。
名字	firstname	string	使用者的名字。
姓氏	lastname	string	使用者的姓氏。
戈斯比	goesby	string	使用者的偏好名稱。

中繼資料清單DBO

名稱	路徑	類型	Description
metadataname	metadataname	array of string
metadata值	metadatavalue	array of string

NameValueLink

名稱	路徑	類型	Description
識別碼	id	string	連結ID
名稱	name	string	連結名稱。
value	value	string	連結值。

Link

名稱	路徑	類型	Description
連結	link	array of NameValueLink

經驗DBO

名稱	路徑	類型	Description
體驗	experience	array of string

群組DBO

名稱	路徑	類型	Description
組成群組	group	array of string

使用者

名稱	路徑	類型	Description
使用者識別碼	userid	integer	使用者識別碼。
以下	following	boolean	以下。
電子郵件	email	string	電子郵件地址。
名稱	name	UserName
用戶鏈接	userlink	string	使用者連結。
網址連結	httplink	string	HTTP 連結。
httpavatar	httpavatar	string	HTTP 頭像。
頭像	avatar	integer	用戶的頭像。
外部	externalid	string	外部 ID。
出生日期	dateofbirth	string	出生日期。
phone	phone	string	電話號碼。
職稱	jobtitle	string	職位名稱。
行動	mobile	string	手機號碼。
部門	department	string	部門。
狀態	status	string	狀態。
組織	org	string	會。
組織名稱	orgName	string	組織名稱。
位置	location	LocationDBO
圖像	img	string	像。
體驗	experiences	ExperiencesDBO
社交鏈接	sociallinks	Link
自訂連結	customlink	Link
訊息連結	messaginglink	Link
秘書名稱	secretaryname	string	秘書姓名。
秘書郵件	secretarymail	string	秘書郵件。
簡介	bio	string	用戶傳記。
來源類型	sourcetype	string	來源類型。
專長	specialities	string	專長。
reports至	reportsto	string	使用者目前使用者報告對象。
中繼資料	metadata	MetadataListDBO
groups	groups	GroupsDBO
後綴	suffix	string	使用者名稱的尾碼。
原子連結	atomlink	string	與使用者相關聯的 Atom 連結。
連結	link	string	與使用者相關聯的連結。
loggeduser類似	loggeduserlike	integer	登錄用戶的點贊數。
使用者名稱	userName	string	使用者名稱。

users

名稱	路徑	類型	Description
使用者	user	array of user

資料夾DBOV1

名稱	路徑	類型	Description
folderid	folderid	string	已建立資料夾的唯一識別碼。

DmsDBO

名稱	路徑	類型	Description
dmsfolderid	dmsfolderid	string	DMS 資料夾識別碼。
dmsParentFolderID	dmsParentFolderID	string	DMS 父資料夾識別碼。
DMS創建日期	dmscreateddate	date-time	DMS 資料夾的建立日期。
dms修改者	dmsmodifiedBy	string	上次修改 DMS 資料夾的使用者。
dms資料庫名稱	dmsdatabasename	string	DMS 資料庫的名稱。
DMS連結	dmslink	boolean	指出 DMS 連結是否可用。
dmslink由	dmslinkby	string	連結 DMS 資料夾的使用者。

網站群組

名稱	路徑	類型
名稱	name	string
識別碼	id	integer
copypermissionsfrom（複製權限來源）	copypermissionsfrom	string
訊息	message	string
類型標識	typeID	integer
型別	type	string
用戶數量	numberofusers	string
創建	created	string
modified	modified	string
系統群組識別碼	systemGroupID	integer
說明	description	string
基本使用者群組	basicusergroup	integer

Address

名稱	路徑	類型	Description
地址ID	addressid	string	地址的唯一識別碼。
位址行1	addressline1	string	地址的第一行。
地址行2	addressline2	string	地址的第二行。
地址行3	addressline3	string	地址的第三行。
city	city	string	位址所在的城市。
狀態	state	string	地址的狀態。
country	country	string	地址的國家/地區。
郵政編碼	postCode	string	地址的郵遞區號。
已知	knownas	string	地址的替代名稱或暱稱。

整合UserDBO

名稱	路徑	類型	Description
索引	index	integer	使用者的唯一索引。
使用者識別碼	userid	integer	用戶的唯一識別碼。
名字	firstname	string	使用者的名字。
姓氏	lastname	string	使用者的姓氏。
執業組	practicegroup	string	使用者所屬的練習群組。
朗碼	langcode	string	使用者的語言代碼。
localeID	localeID	string	使用者的地區設定 ID。
公開簡介	publicprofile	string	使用者的公開設定檔。
PWPID	pwpid	string	使用者的 PWP ID。
使用者類型ID	usertypeid	string	使用者類型 ID。
systemuser	systemuser	string	系統使用者旗標。
電子郵件	email	string	使用者的電子郵件地址。
phone	phone	string	使用者的電話號碼。
行動	mobile	string	用戶的手機號碼。
部門	department	string	用戶部門。
組織	org	string	使用者所屬的組織。
位置	location	LocationDBO
address	address	Address
體驗	experiences	ExperiencesDBO
社交鏈接	sociallinks	Link
訊息連結	messaginglink	Link
自訂連結	customlink	Link
圖像	img	string
reports至	reportsto	string
中繼資料	metadata	MetadataListDBO
groups	groups	GroupsDBO
外部	externalid	string	使用者的外部 ID。
職稱	jobtitle	string	使用者的職稱。
秘書名稱	secretaryname	string	使用者秘書的名稱。
秘書郵件	secretarymail	string	使用者秘書的電子郵件。
專長	specialities	string	用戶的專長。
title	title	string	使用者的職稱。
戈斯比	goesby	string	使用者的偏好名稱。
後綴	suffix	string	使用者名稱的尾碼。
原子連結	atomlink	string	與使用者相關聯的 Atom 連結。
簡介	bio	string	用戶傳記。
dateOfBirth	dateOfBirth	string	使用者的出生日期。
連結	link	string	與使用者相關聯的連結。
狀態	status	string	使用者的狀態。
狀態代碼	statuscode	string	使用者的狀態碼。
訊息	message	string	與使用者相關聯的訊息。
來源類型	sourcetype	string	使用者的來源類型。
orgid	orgid	string	組織 ID。
if合作夥伴	ifpartner	string	合作夥伴旗標。
電子郵件網域	emaildomain	string	使用者的電子郵件網域。
邀請已發送	invitationsent	string	邀請已發送旗標。
創建者	createdby	string	建立記錄的使用者。
創建日期	createddate	string	記錄的建立日期。
修改者	modifiedby	string	修改記錄的使用者。
修改日期	modifieddate	string	記錄修改日期。
lastlogindate	lastlogindate	string	上次登入的日期。
無效登入	invalidlogins	string	無效登入嘗試的計數。
publicwebsiteprofileid	publicwebsiteprofileid	string	公用網站設定檔 ID。
重設密碼日期	resetpassworddate	string	密碼重設日期。
頭像	avatar	string	虛擬人偶影像 URL。
以下計數	followingcount	integer	被追蹤的使用者計數。
追隨者計數	followercount	integer	追隨者人數。
以下	following	boolean	後續旗標。
角色	role	string	使用者的角色。
是基本用戶	isbasicuser	string	基本使用者旗標。
加密使用者識別碼	encryptedUserId	string	加密的使用者 ID。
自行註冊	selfregistered	integer	自行註冊旗標。
註冊與2FA	registeredWith2FA	string	雙因素驗證註冊旗標。
isInternal	isInternal	integer	內部使用者旗標。
組織名稱	orgName	string	組織的名稱。

網站

名稱	路徑	類型	Description
識別碼	id	integer	網站識別碼。
網站名稱	sitename	string	網站的名稱。
角色	role	string	網站的角色。
網站說明	sitedescription	string	網站的描述。
啟用模組	enabledmodules	string	為網站啟用的模組清單。
sitefolderID	sitefolderID	string	網站資料夾的識別碼。
sitefolder權限	sitefolderpermission	string	網站資料夾的權限層級。
模組	module	ModuleDBO
管理員註釋	adminnote	string	與該網站相關的行政說明。
開始日期	startdate	string	網站作業的開始日期。
結束日期	enddate	string	網站作業的結束日期。
創建日期	createddate	string	網站建立日期。
存檔日期	archiveddate	string	網站封存的日期。
客戶編號	clientno	string	與網站相關聯的用戶端號碼。
馬特諾	matterno	string	與網站相關聯的案件編號。
登陸頁面	landingpage	string	網站的登陸頁面URL。
連結	link	string	與網站相關的連結。
狀態	status	string	網站的目前狀態。
狀態ID	statusid	integer	網站狀態的識別碼。
size	size	string	網站的大小。
帳單附註	billingnotes	string	與網站計費相關的註釋。
計費下一個發票日期	billingnextinvoicedate	string	網站的下一張發票日期。
billinglastinvoicedate	billinglastinvoicedate	string	網站最後一張發票的日期。
檔案頁數	filepagecount	string	網站上檔案的總頁數。
最大頁數	maxpagecount	string	網站上檔案允許的頁數上限。
網站http連結	sitehttplink	string	網站的 HTTP 連結。
是同義的	isSyncable	integer	指出網站是否可同步處理。
enforceUser群組	enforceusergroups	string	針對網站強制執行的使用者群組。
csvSite類別	csvSiteCategory	string	CSV 格式的網站類別。
siteNameInDefaultLanguage	siteNameInDefaultLanguage	string	預設語言的網站名稱。
看得見的	visible	integer	指出網站是否可見。
網站標誌名稱	siteLogoName	string	網站標誌檔案的名稱。
siteLogo檔案大小	siteLogoFileSize	integer	網站標誌的檔案大小。
網站標誌高度	siteLogoHeight	integer	網站標誌的高度。
網站標誌寬度	siteLogoWidth	integer	網站標誌的寬度。
網站狀態	siteStatus	integer	網站的狀態碼。
applySite條款	applySiteTerms	integer	指出是否套用網站術語。
網站術語	siteTerm	string	適用於網站的條款。
術語類型	termType	integer	套用至網站的字詞類型。
下一個登入網站條款	nextLoginSiteTerms	integer	指出下次登入時是否需要網站術語。
defaultSiteTerms啟用	defaultSiteTermsEnable	integer	指出是否已啟用預設網站字詞。
進階QA任務	advancedQAPermission	integer	網站的進階 QA 權限層級。
isInternal	isInternal	integer	指出網站是否為內部網站。
PSM	psm	integer	Product Service Manager 識別碼。
siteLabel顯示	siteLabelDisplay	string	網站的顯示標籤。
允許網站管理	allowSiteAdministration	integer	指出是否允許網站管理。
siteLevel密碼啟用	siteLevelPasswordEnable	integer	啟用網站層級密碼保護。
siteLevelPasscode啟用	siteLevelPasscodeEnable	integer	啟用網站層級密碼保護。
密碼UsingAuthApp	passcodeUsingAuthApp	integer	指出密碼驗證是否使用驗證應用程式。
網站密碼	sitePassword	string	與網站相關聯的密碼。
ipRestriction啟用	ipRestrictionEnable	integer	啟用網站存取的 IP 限制。
可用IP	availableIP	string	允許存取網站的 IP 位址以逗號分隔的清單。
highqDrive	highqDrive	integer	指出是否已啟用 HighQ Drive 整合。
applySite首頁	applySiteHomePage	integer	套用網站的自訂首頁。
網站首頁	siteHomePage	string	網站自訂首頁的 URL。
siteHomePage類型	siteHomePageType	integer	首頁的類型。
next登入網站首頁	nextLoginSiteHomePage	integer	設定下次登入網站首頁。
applyDisplayContent	applyDisplayContent	integer	套用顯示內容設定。
顯示內容	displayContent	string	要在網站上顯示的內容。
rss安全	rssSecurity	integer	RSS 摘要安全性層級。
加密密碼	encryptedPassword	integer	指出網站密碼是否已加密。
可用的IPRangeCSV	availableIPRangeCSV	string	允許存取網站的 IP 位址範圍以逗號分隔的清單。
siteModuleID	siteModuleID	integer	網站模組的識別碼。
icalSecurity	icalSecurity	integer	iCal 摘要安全性層級。
預設顯示內容	defaultDisplayContent	string	要在網站上顯示的預設內容。
預設電子郵件警示	defaultEmailAlert	integer	啟用預設電子郵件警示。
excelReport頁尾	excelReportFooter	integer	在 Excel 報表中包含頁尾。
excelReport頁尾文字	excelReportFooterText	string	要在 Excel 報表頁尾中顯示的文字。
公告MLJSON	announcementMLJSON	string	網站的 JSON 格式公告。
templateType	templateType	integer	用於網站的範本類型。
templateLicense	templateLicence	integer	網站範本的授權類型。
openChannelAppID	openChannelAppID	string	開放通道整合的應用程式 ID。
項目ID	itemid	integer	與網站相關聯之項目的識別碼。
sitemetadatasheetid	sitemetadatasheetid	integer	與網站相關聯的中繼資料表識別碼。
我的網站	mysite	boolean	指出這是否是使用者的個人網站。
最後存取日期	lastaccesseddate	string	上次存取網站的日期和時間。
defaultViewerMetaDataTab	defaultViewerMetaDataTab	integer	網站檢視器的預設中繼資料索引標籤。
documentMetadataViewId	documentMetadataViewId	integer	檢視識別碼的文件中繼資料。
folderMetadataViewId	folderMetadataViewId	integer	檢視識別碼的資料夾中繼資料。
文件排序	docSort	integer	文件的排序順序。
folderSort	folderSort	integer	資料夾的排序順序。
defaultFolderRenderView	defaultFolderRenderView	integer	決定資料夾的預設檢視模式。
isTaskAttachment預設值	isTaskAttachmentDefault	integer	任務附件的預設位置。
taskAttachmentDefaultFolderId	taskAttachmentDefaultFolderId	integer	指定為工作附件預設位置的資料夾的唯一識別碼。
收藏夾	favourite	string	最喜歡的狀態。
enabledocumentredaction	enabledocumentredaction	boolean	指定是否為網站啟用文件密文。
提及群組	mentiongroups	integer	上述組。
啟用檔案關係	enablefilerelationships	boolean	指出是否已啟用檔案關係。
FileRelationshipSitePermissionLevel	filerelationshipsitepermissionlevel	integer	管理檔案關聯性所需的權限層級。

模組DBO

名稱	路徑	類型
家	home	HomeDBO
活動	activity	ActivityDBO
文件	document	DocumentDBO
部落格	blog	BlogDBO
維基百科	wiki	WikiDBO
工作	task	TaskDBO
事件	event	EventDBO
isheet	isheet	ISheetDBO
品質保證	qa	QaDBO
人員	people	PeopleDBO
合約快遞	contractexpress	ContractExpressDBO

首頁DBO

名稱	路徑	類型	Description
啟用	enable	string	啟用 HomeDBO 的狀態。

活動DBO

名稱	路徑	類型	Description
啟用	enable	string	啟用 ActivityDBO 的狀態。
微博	microblog	string	與 ActivityDBO 相關的微博內容。

博客DBO

名稱	路徑	類型	Description
博客標題	blogTitle	string	部落格文章的標題。
部落格內容	blogContent	string	部落格文章的內容。
顯示評論	showComment	integer	顯示註解。
標籤清單	tagList	array of string	與部落格相關聯的標籤清單。
狀態	status	integer	部落格文章的狀態。
網站標識碼	siteID	integer	相關聯網站的識別碼。
作者	author	string	博客的作者。
categoryList	categoryList	array of string	指派給部落格文章的類別。
通知類型識別碼	notificationTypeID	integer	通知類型的識別碼。
訊息	message	string	與部落格相關的訊息內容。
messageCode	messageCode	integer	與訊息相關聯的程式碼。
外部識別碼	externalID	string	連結至部落格的外部識別碼。
發佈日期	publishDate	string	博客的發布日期。
程序類型	processtype	string	與部落格相關聯的處理程序類型。
啟用	enable	string	啟用 BlogDBO 的狀態。

維基DBO

名稱	路徑	類型	Description
維基ID	wikiid	integer	維基的唯一標識符。
currentversionid	currentversionid	integer	目前維基版本的標識符
家長維基ID	parentwikiid	integer	父維基的標識符。
維基標題	wikititle	string	維基的標題。
維基內容	wikicontent	string	維基的內容。
顯示評論	showcomment	integer	指出是否已啟用註解。
創建日期	createddate	string	維基的創建日期。
修改日期	modifieddate	string	維基的最後修改日期。
標籤列表	taglist	string	與維基相關聯的標籤以逗號分隔的清單。
維基百科	wikipath	string	存取 wiki 的路徑。
維基草稿ID	wikidraftid	integer	維基草稿版本的標識符。
草稿類型	drafttype	string	與 wiki 相關聯的草稿類型。
狀態	status	integer	維基的當前狀態。
維基版本ID	wikiversionid	integer	wiki 的版本標識符。

任務DBO

名稱	路徑	類型	Description
索引	index	string	工作的索引或識別碼。
parenttaskid	parenttaskid	integer	父任務的識別碼。
任務ID	taskid	integer	工作的唯一識別碼。
title	title	string	任務的標題。
說明	description	string	任務的詳細描述。
過期	duedate	string	任務完成的到期日。
開始日期	startdate	string	啟動任務的開始日期。
MatterMapTaskID	mattermaptaskid	string	連結至事務對應任務的識別碼。
型別	type	string	任務的類型或類別。
依賴	dependenton	string	此工作相依的工作。
天數從依賴	daysfromdependent	string	相依任務的天數。
忽略週末	ignoreweekend	integer	指出是否在排程中忽略週末。
duration	duration	integer	完成任務的持續時間。
資源	resource	string	指派給任務的資源。

活動DBO

名稱	路徑	類型	Description
活動標題	eventTitle	string	活動名稱。
活動內容	eventContent	string	活動內容。
顯示評論	showComment	integer	指出是否已啟用事件的註解。
標籤清單	tagList	array of string	與事件相關聯的標籤清單。
狀態	status	integer	事件的當前狀態。
網站標識碼	siteID	integer	網站的識別碼。
連絡人	contact	string	活動的聯繫信息。
categoryList	categoryList	array of string	列出事件的類別。
通知類型識別碼	notificationTypeID	integer	與事件相關的通知類型。
訊息	message	string	事件的訊息。
messageCode	messageCode	integer	事件的訊息碼。
外部識別碼	externalID	string	外部識別碼。
startDate	startDate	string	事件的開始日期。
結束日期	endDate	string	事件的結束日期。
startTime	startTime	string	事件的開始時間。
endTime	endTime	string	事件的結束時間。
位置	location	string	活動地點。
作者	author	string	事件的作者。
程序類型	processtype	string	事件的處理時間。
啟用	enable	string	啟用是活動。

是希特DBO

名稱	路徑	類型	Description
識別碼	id	integer	iSheet 的唯一識別碼。
title	title	string	iSheet 的標題。
說明	description	string	isheet 的描述。
狀態	status	string	isheet 的狀態。
accesstype	accesstype	string	訪問 isheet 的類型。
型別	type	string	isheet 的類型。
檢視連結	viewlink	string	查看 iSheet 的連結。
允許區段	allowsections	string	是否允許區段。
允許查找	allowlookup	string	是否啟用查閱欄位。
顯示i表	displayisheet	string	iSheet 的顯示選項。
searchasdefaultview	searchasdefaultview	string	指出搜尋是否為預設檢視。
啟用版本	enableversion	string	已啟用版本控制旗標。
enablesheetalerter	enablesheetalerter	string	旗標以啟用工作表警示。
alerter條件	alertercondition	string	觸發警示的條件。
OverrideItemModifiedDate	overrideitemmodifieddate	string	覆寫修改日期旗標。
enablebulkinsertupdate	enablebulkinsertupdate	string	啟用大量插入/更新。
欄位說明	fielddescriptions	string	iSheet 的欄位描述。
啟用行鎖定	enablerowlocking	string	啟用列層級鎖定。
setcharlimittruncatemultilinetextenabled	setcharlimittruncatemultilinetextenabled	string	截斷多行文字旗標。
setcharlimittruncatemultilinetextval	setcharlimittruncatemultilinetextval	string	多行截斷的字元限制。
允許選擇清單值重複使用	allowchoicelistvaluesforreuse	string	允許重複使用選擇清單值。
allowscorelistvaluesforreuse	allowscorelistvaluesforreuse	string	允許重複使用分數清單值。
allowIsheet註解	allowIsheetComments	string	允許在 iSheet 中註解。
共用記錄限制	shareRecordsLimit	integer	允許共享的記錄限制。
shareRecordsLimit已啟用	shareRecordsLimitEnabled	integer	已啟用記錄共用限制。
enableIsheetAddRecordFormSharing	enableIsheetAddRecordFormSharing	string	啟用表單共用以新增記錄。
記錄計數	recordcount	string	目前的記錄計數。
sheettypeid	sheettypeid	integer	iSheet 的類型 ID

卡德博

名稱	路徑	類型	Description
啟用	enable	string	啟用 QA 功能。

人民DBO

名稱	路徑	類型	Description
人	person	array of PersonDBO

個人DBO

名稱	路徑	類型	Description
使用者識別碼	userid	integer	使用者識別碼。
電子郵件	email	string	電子郵件地址。
httpavatar	httpavatar	string	頭像的 HTTP URL。
頭像	avatar	string	頭像圖像。
用戶鏈接	userlink	string	連結至使用者設定檔。
網址連結	httplink	string	使用者設定檔的 HTTP 連結。
phone	phone	string	電話號碼。
行動	mobile	string	手機號碼。
部門	department	string	使用者的部門。

合約ExpressDBO

名稱	路徑	類型	Description
啟用	enable	string	啟用 Contract Express 整合。

資料夾DBOV2

名稱	路徑	類型	Description
名稱	name	string	資料夾名稱。
說明	description	string	資料夾描述。
parentFolderID	parentFolderID	integer	父資料夾識別碼。
access繼承	accessInherited	integer	存取繼承狀態。
batchID	batchID	string	批次識別碼
數位管理系統	dms	DmsDBO
識別碼	id	integer	資料夾 ID。
連結	link	string	資料夾連結。
創建日期	createddate	string	創建日期。
修改日期	modifieddate	string	修改日期。
子系	child	integer	子資料夾。
檔案計數	filecount	integer	檔案數。
創建者	createdby	UserDBO
修改者	modifiedby	UserDBO
folderid	folderid	integer	資料夾 ID。
dmsfolderid	dmsfolderid	string	DMS 資料夾識別碼。
網站ID	siteid	integer	站台識別碼
位置	location	string	資料夾位置。
使用權限	permission	PermissionDBO
content狀態	contentstatus	integer	內容狀態。
自動編號	autonumbering	string	自動編號組態。
資料夾大小	foldersize	string	資料夾大小。
共用狀態	sharedstatus	integer	共用狀態。
我的最愛狀態	favouritestatus	integer	最喜歡的狀態。
資料夾類型	foldertype	string	資料夾類型。
itemId（項目識別碼）	itemId	integer	項目 ID。
folderMetadataSheetId	folderMetadataSheetId	integer	工作表 ID 的資料夾中繼資料。

用戶DBO

名稱	路徑	類型	Description
名字	firstname	string	名字。
姓氏	lastname	string	姓。
電子郵件	email	string	電子郵件地址。
使用者識別碼	userid	integer	使用者識別碼。

許可DBO

名稱	路徑	類型	Description
檢視表	view	integer	檢視權限。
編輯	edit	integer	編輯權限。
刪除	delete	integer	刪除權限。
addEditAll檔案	addEditAllFiles	integer	添加/編輯所有文件權限。
管理員	admin	integer	管理員權限。
檢視所有檔案	viewAllFiles	integer	查看所有文件權限。
禁用保存	disableSave	integer	停用儲存權限。
上傳檔案	uploadFile	integer	上傳檔案權限。
更新檔案	updateFile	integer	update file 權限。
刪除檔案	deleteFile	integer	刪除檔案權限。

漸進式金鑰DBO

名稱	路徑	類型	Description
漸進式鍵	progressivekey	string	漸進式操作的關鍵。
網站ID	siteid	integer	網站的識別碼。
progressivekey狀態	progressivekeystatus	string	漸進式索引鍵的狀態。
使用者識別碼	userid	integer	使用者的識別碼。
回應內文	responsebody	string	回應的正文。
訊息	message	string	訊息內容。
訊息代碼	messagecode	string	與訊息相關聯的程式碼。
整合回應DBO	integrationResponseDBO	IntegrationResponseDBO
columns	columns	ColumnErrorsDBO
items	items	ItemErrorsDBO
importisheet範本	importisheettemplate	importISheetTemplateDBO
錯誤	error	ErrorDBO
內容類型	contentType	string	內容類型。
失敗實體	failedEntities	integer	失敗實體的數目。
下載鏈接	downloadlink	string	下載內容的連結。
附件	attachment	Attachment
連結	link	string	關聯的連結。
文件識別碼	documentid	integer	文件的識別碼。
progresskey	progresskey	string	用於跟踪的進度鍵。
progresskey狀態	progresskeystatus	string	進度索引鍵的狀態。

整合回應DBO

名稱	路徑	類型	Description
integrationResponseUsers物件	integrationResponseUsersObject	IntegrationResponseUsersObject
失敗實體	failedEntities	integer	處理失敗的實體數目。
success實體	successEntities	integer	成功處理的實體數目。

整合回應使用者物件

名稱	路徑	類型	Description
使用者	user	array of IntegrationUserDBO

資料行錯誤DBO

名稱	路徑	類型	Description
列	column	array of ColumnErrorDBO
失敗實體	failedEntities	integer	因資料行錯誤而失敗的實體數目。
success實體	successEntities	integer	成功處理的實體數目。

資料行錯誤DBO

名稱	路徑	類型	Description
索引	index	integer	有錯誤之資料行的索引位置。
columnid	columnid	integer	有錯誤之資料行的唯一識別碼。
名稱	name	string	有錯誤的資料行名稱。
狀態	status	string	指出錯誤狀況的狀態。
狀態代碼	statuscode	string	代表錯誤狀態的程式碼。
訊息	message	string	詳細的錯誤訊息。

項目錯誤DBO

名稱	路徑	類型	Description
項目	item	array of ItemErrorDBO
失敗實體	failedEntities	integer	因項目錯誤而失敗的實體數目。
success實體	successEntities	integer	儘管有項目錯誤，但仍成功處理的實體數目。

項目錯誤DBO

名稱	路徑	類型	Description
索引	index	integer	有錯誤之項目的索引位置。
columns	columns	ColumnErrorsDBO
項目ID	itemid	string	有錯誤之項目的唯一識別碼。
外部	externalid	string	與項目相關聯的外部識別碼。
識別碼	id	string	項目的內部識別碼。
名稱	name	string	有錯誤的項目名稱。
狀態	status	string	指出錯誤狀況的狀態。
狀態代碼	statuscode	string	代表錯誤狀態的程式碼。
訊息	message	string	詳細的錯誤訊息。
成功刪除計數	successdeletedcount	integer	成功刪除的實體計數。
失敗計數	failurecount	integer	處理失敗的實體計數。
失敗實體	failedEntities	integer	因項目錯誤而失敗的實體數目。
success實體	successEntities	integer	成功處理的實體數目。

importISheetTemplateDBO

名稱	路徑	類型	Description
linkedtemplateid	linkedtemplateid	integer	連結範本的識別碼。
aliasname	aliasname	string	範本的別名。
linkedisheet	linkedisheet	string	連結輸入表的識別碼。
importdata	importdata	string	要從範本匯入的資料。
附錄表名稱	appendisheetname	string	要附加資料的工作表名稱。
templateparameter群組	templateparametergroups	ISheetTemplateParameterGroups
templateSheetIdMap	templateSheetIdMap	object
樣板ID	templateId	integer	範本的識別碼。
模板標題	templateTitle	string	範本的標題。
檢視ID	viewIDs	string	以逗號分隔的檢視 ID 清單。

ISheetTemplateParameterGroups

名稱	路徑	類型	Description
templateparameter群組	templateparametergroup	array of ISheetTemplateParameterGroup

ISheetTemplateParameter群組

名稱	路徑	類型	Description
templateruleid	templateruleid	integer	isheet 範本參數群組。
template參數	templateparameter	array of ISheetTemplateParameter

ISheetTemplate參數

名稱	路徑	類型	Description
識別碼	id	integer	isheet 範本參數的識別碼。
名稱	name	string	isheet 範本參數的名稱。
資料	data	string	iSheet 範本參數的資料。

Attachment

名稱	路徑	類型	Description
檔案	file	string	檔案內容。
名稱	name	string	附件的名稱。
順序	order	string	附件的順序。
識別碼	id	integer	附件的唯一識別碼。
副檔名	extension	string	檔案副檔名。
parentfolderid	parentfolderid	integer	父資料夾的識別碼。
檔案http連結	filehttplink	string	HTTP 連結來存取檔案。
folderpath	folderpath	string	包含檔案的資料夾路徑。
資料夾httplink	folderhttplink	string	資料夾的 HTTP 連結。
檔案大小	filesize	integer	以位元組為單位的檔案大小。
編輯狀態	redactionStatus	boolean	指出檔案是否已密文。
displayname	displayname	string	附件的顯示名稱。
網站ID	siteid	integer	與附件相關聯的網站識別碼。

共用方式為

HighQ （預覽版）

HighQ

概觀

Authentication

連接器作業

ISheet 模組

文件資源 API

ISheet 系統管理 API

使用者作業

文件和網站管理

使用者入門

參數和設定

疑難排解和限制

其他資源

授權和支援

節流限制

動作

上傳檔案

參數

取得資料夾資訊

參數

傳回

封存使用者

參數

將現有群組新增至網站

參數

傳回

建立 iSheet 項目的步驟

參數

傳回

建立資料夾

參數

傳回

擷取 iSheet 欄

參數

傳回

擷取 iSheet 項目清單

參數

傳回

擷取使用者清單

參數

傳回

擷取檔案資訊

參數

傳回

擷取資料夾清單

參數

傳回

新增網站

參數

傳回

更新網站

參數

更新網站群組

參數

傳回

添加使用者

參數

傳回

移動文件

參數

定義

錯誤DBO

文件DBO

columns

地點DBO

UserName

中繼資料清單DBO

NameValueLink

Link

經驗DBO

群組DBO

使用者

users

資料夾DBOV1

DmsDBO

網站群組

Address

整合UserDBO