QPP NextGen （預覽版）
Quark Publishing Platform （QPP） NextGen 是一個基於雲端的元件內容管理系統 （CCMS），用於自動發布高度監管的企業內容。 QPP NextGen 連接器可協助將資料從內容生態系統雙向移動，以簡化流程並加快上市時間。
此連接器適用於以下產品和區域：
| 服務 | Class | Regions |
|---|---|---|
| 副駕駛工作室 | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 邏輯應用程式 | 標準 | 所有 Logic Apps 區域， 但下列區域除外： - Azure Government 區域 - Azure 中國區域 - 美國國防部 （DoD） |
| Power Apps | 進階 | 除下列區域外的所有 Power Apps 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| Power Automate（自動化服務） | 進階 | 除下列區域外的所有 Power Automate 區域 ： - 美國政府 （GCC） - 美國政府（海灣合作委員會高中） - 由 21Vianet 營運的中國雲 - 美國國防部 （DoD） |
| 連絡人 | |
|---|---|
| 名稱 | 夸克技術支持 |
| URL | https://quarksoftware.my.site.com |
| support_cases@quark.com |
| 連接器中繼資料 | |
|---|---|
| Publisher | 夸克軟件公司 |
| 網站 | https://www.quark.com/ |
| 隱私策略 | https://www.quark.com/privacy-policy |
| 類別 | 內容和文件;生產力 |
Quark Publishing Platform （QPP） NextGen 是一個基於雲端的元件內容管理系統 （CCMS），用於自動發布高度監管的企業內容。 QPP NextGen 連接器可協助將資料從內容生態系統雙向移動，以簡化流程並加快上市時間。
先決條件
- 您需要 QPP-NG 環境（以上版本 v3.3）和 QPP-NG 授權才能使用我們的 連接器。
- 您必須在租用戶上建立現有的用戶端 （連線），最好是個別的，以讓他們想要此連接器的動作和觸發程式互動。 更多詳細資訊可以在取得認證部分找到。
- 瞭解如何使用 Power Automate，並使用動態內容或使用查詢建立器從其他動作回應中取得價值。
如何取得認證
使用我們的連接器建立新連線時，您會看到 3 個參數。 獲取每個細節的詳細信息如下。 建立和法力使用連接器建立新連線時，使用者會看到 3 個參數。 獲取每個細節的詳細信息如下。 建立和管理 QPP-NG 連線應由管理員使用者完成。 請洽詢您的 QPP-NG 環境管理員。
您也可以適當地命名您的認證，以便稍後輕鬆識別它們。 移至 Power Automate 中的 連線 ，搜尋連接器名稱，然後編輯現有連線，然後提供適當的名稱。
- 客戶編號：您可以流覽至所需的 QPP-NG 租用戶 [管理員應用程式]，然後瀏覽 [設定>] [連線]。 他們可以在此處建立新連線或使用現有連線。 只需輸入用戶端 ID 的連線名稱即可。
- 客戶端密碼： 與用戶端識別碼一樣，導覽至 連線 ，然後輸入現有連線的 密碼 。 如果您沒有密碼，請重新生成密碼。 秘密應該安全地儲存現有連線，並由系統管理員管理。在重新產生密碼之前，請先洽詢管理員。
- 主機名稱： 您要建立連線以與連接器互動的 QPP-NG 租用戶的主機名稱。 範例 （yourtenantname.app.quark.com）。當您存取 QPP-NG 環境時，應該會看到 URL。
建立認證之後，您可以測試認證，以查看認證是否正確。
可以在手動流程中從我們的連接器使用 getUser 等簡單動作，使用預設欄位測試流程。
首次建立連線時，可能會遇到一些錯誤代碼如下：
- 無用的主機 URL （500）： 再次檢查 QPP-NG 環境的主機名稱，用戶端 ID 和密碼應該屬於此連線。
- 未經授權/unauthorized_client （401）： 對於無效的用戶端或無效的用戶端認證，請確定用戶端 ID 和用戶端密碼有效，且屬於所使用的主機名稱。
開始使用 QPP-NG Integration Hub
若要開始使用，您可以使用內建觸發器，從 QPP-NG 租使用者接聽類型資產、集合等的各種事件。
- 在 Power Automate 中建立新的自動化流程。
- 選取我們的 QPP-NG 連接器，然後選擇觸發器。
- 填寫必填欄位。 請參閱 Github Readme 文件中的 Webhook-trigger 區段。
- 針對您要註冊 Webhook 的 QPP-NG 租用戶選取適當的連線。 您也可以建立新的連線。 請遵循 如何取得認證 一節中給出的步驟。
- 儲存流程。 這將在後面執行註冊請求。 當您返回流程詳細資訊頁面（或按一下返回按鈕）時，您應該會在頂部看到一個綠色底線，提及一切順利且流程已準備好觸發。
- 流程執行一次後，您可以進一步取得流程執行的 Webhook 回應，並使用回應來產生動態內容。 為此，您可以使用剖析json OOTB動作。
- 如果這是在 QPP-NG 租用戶上註冊具有此變更類型 （事件） 的第一個 Webhook，您必須等候 15 分鐘才能啟用 Webhook，然後您可以預期會觸發流程。
如果具有 Webhook 觸發程序的流程檢查器中出現錯誤，Power Automate 將在流程檢查器中顯示紅色。 請打開它並檢查錯誤。 以下是您可能遇到的一些錯誤，以及緩解這些錯誤的步驟。
- 名稱已存在的 Webhook 提供 Webhook 的唯一名稱，或在另一個手動流程中使用具有相同連線的刪除 Webhook 作業。 選取具有相同名稱的 Webhook 並將其刪除。 有關 Webhook 的更多信息，請訪問 Quark 開發者門戶。
- 錯誤請求（400） 請檢查根據文檔和錯誤詳細信息提供的參數。
- 找不到資源 （404） & 訂閱要求中缺少位置標頭 請刪除流程，然後建立新的 Webhook 觸發程序和流程。 如果流程很大，請複製流程，並在啟用流程和儲存時，Power Automate 將嘗試執行新的 Webhook 註冊。
已知問題和限制
- 目前，您將無法更新已註冊 Webhook 觸發程序的參數。 因應措施是從流程中刪除目前的 Webhook 作業，並在其位置新增新的 QPP-NG Webhook 觸發程式。 若要從 QPP-NG 環境中刪除先前註冊的 Webhook，請使用刪除作業建立新的手動流程，從下拉式清單中選取先前的 Webhook，然後執行流程。 如果此因應措施不起作用且流程很大，請複製流程，並在更新 Webhook 詳細資料後儲存並啟用它。 這也會成功建立新的 Webhook 註冊。
- 您也可以在刪除和建立新的觸發器之前關閉流程。 這也將確保您的新 Webhook 將被註冊。
- 如果 QPP-NG Webhook 服務無法叫用已註冊的 Webhook 觸發程式 3 次，則會停用 Webhook。
- 儲存某些未給定參數的動作（空）會產生錯誤（預期正文中有一些值）。
- 如果這是具有此變更型別 （事件） 的第一個 Webhook，您必須等待 15 分鐘才能啟動 Webhook，然後您可以預期會觸發流程。
- 請使用舊版設計工具檢視以獲得最佳體驗，因為新設計工具可能會因為持續開發而發生問題，這類與新設計工具有問題的動作包括 CheckOut、SetAttributeValues、InitNewCheckin 和 CreateQuery。
常見錯誤和補救措施
- 在註冊 Webhooks Trigger 作為第一步時，如果未正確提供詳細信息，則在註冊我們的服務時可能會出現問題。 使用觸發器儲存流程並返回顯示過去 28 天執行的「流程詳細資料」頁面視窗後，可以縮小範圍。 如果顯示紅色，則表示Webhook尚未正確註冊。 請檢查錯誤。 如果錯誤是由於遺失 Location 標頭或找不到資源而發生，請嘗試刪除並重新建立觸發程式。
- 如果您的流程未觸發，可能是因為現有的 Webhook 註冊為不存在的端點，例如已刪除的流程等。在這種情況下，請使用您的 API 權杖執行 API https://{Host.name}/webhooks/api/v3/registrations，以取得 QPP-NG 環境中所有已註冊 Webhook 的清單，並使用此回應，透過刪除 Webhooks 動作來移除任何這類 Webhook。 您還需要確保 Webhooks 服務已正確配置並使用 （）https://quarksoftware.my.site.com 從您的 Quark 支援執行。
- 如果您未收到特殊許可權使用者或任何驗證錯誤，請確認為模擬提供的使用者名稱在您的 QPP-NG 租用戶中具有足夠的許可權，
- 如果出現特定問題，請參閱 Github 上開放原始碼儲存庫上共用的範例和檔案 Readme.md 或參閱 Quark 開發人員入口網站 以取得有關端點和功能的詳細資訊。
常見問題
我可以在不同的 QPP-NG 環境中使用動作和觸發程式嗎？
是的，這是可能的。 您只需根據環境填寫主機名稱參數，並使用與該環境的適當連接。
如果我們在某件事上遇到困難或有疑問，您能幫助我們嗎？
當然 只需發送電子郵件至 [email protected] （https://quarksoftware.my.site.com），並確保您在描述問題時提及 Microsoft Power Automate 連接器。
在哪裡可以取得有關動作和端點的詳細資訊？
有關各種 Quark API 的更多信息，請 參見此處。 只需導覽至 Content Platform 索引標籤即可。由於此連接器僅包含 QPP-NG 平台可能的實際 API 的子集，因此此站點可用於通過在 [email protected] 上記錄功能請求來探索和請求更多操作和端點。
正在建立連線
連接器支援下列驗證類型：
| 預設值 | 建立連線的參數。 | 所有區域 | 不可共享 |
預設
適用：所有地區
建立連線的參數。
這不是可共用的連線。 如果 Power App 與其他使用者共用，系統會明確提示其他使用者建立新連線。
| 名稱 | 類型 | Description | 為必填項目 |
|---|---|---|---|
| 用戶端識別碼 （clientId） | 字串 | 從您的服務認證中指定用戶端識別碼。 | 對 |
| 用戶端密碼 （clientSecret） | securestring | 從您的服務認證中指定用戶端密碼。 | 對 |
| 主機名稱 | 字串 | 指定主機名稱 | 對 |
節流限制
| 名稱 | 呼叫 | 續約期間 |
|---|---|---|
| 每個連線的 API 呼叫 | 100 | 60 秒 |
動作
| 上傳 （Blob） |
此請求用於通過輸入流上傳文件。 如需詳細資訊，請參閱 GitHub 文件。 |
| 下載 （Blob） |
此請求用於通過下載URL的輸入流下載文件。 如需詳細資訊，請參閱 GitHub 文件。 |
| 使用篩選器取得分頁查詢結果 |
此要求會傳回分頁的查詢元素，以及儲存在系統中的查詢詳細資料，並在查詢中使用特定篩選器。 如需詳細資訊，請查看 github 文件。 |
| 使用者是群組成員嗎 |
此要求會傳回 true 或 false，表示使用者是 userId 特定群組的成員。 |
| 依名稱取得使用者 |
此請求將傳回特定於使用者名稱的使用者中繼資料。 如需詳細資訊，請參閱 GitHub 文件。 |
| 依名稱取得內容類型資訊 |
此要求可用來依內容類型名稱擷取內容類型資訊。 有關詳細信息，請參閱 Github 文檔。 |
| 依名稱取得屬性 |
傳回 QPPNG 伺服器中所有現有屬性，其中包含指定名稱的 meta 資料。 如需詳細資訊，請參閱 GitHub 文件。 |
| 依名稱取得屬性值 |
取得逗號分隔名稱的屬性值。 如需詳細資訊，請參閱 GitHub 文件。 |
| 依名稱取得工作流程 |
此要求會依名稱傳回指定工作流程的所有中繼資料。 有關詳細信息，請參閱 Github 文檔。 |
| 依名稱取得群組 |
此請求將傳回群組名稱特定的群組。 |
| 依識別碼取得使用者 |
此要求可用來擷取指定使用者的中繼資料。 如需詳細資訊，請參閱 GitHub 文件。 |
| 刪除 Webhook |
刪除指定事件和變更類型的現有 Webhook。 如需詳細資訊，請查看 github 文件。 |
| 取得子項資產關係 |
取得給定父資產ID的子資產關係。有關詳細信息，請參閱 Github 文檔。 |
| 取得所有使用者 |
此請求用於提取所有用戶。 詳情請參閱 Github 文件。 |
| 取得所有查詢 |
此請求將返回具有定義的所有查詢。 有關詳細信息，請參閱 Github 文檔。 |
| 取得父資產關係 |
此要求會傳回父資產關聯的關聯性清單。 如需詳細資訊，請參閱 GitHub 文件。 |
| 取得發佈狀態 |
取得指定資產的發佈狀態。 有關詳細信息，請參閱 Github 文檔。 |
| 取得資產下載資訊 |
要求會傳回資產下載資訊，可與下載Blob動作一起使用，以下載資產串流。 如需詳細資訊，請查看 github 文件。 |
| 取得資產中繼資料 |
取得指定資產識別碼的資產資料。如需詳細資訊，請查看 Github 文件。 |
| 取得集合的群組 |
此要求會針對指定的工作流程和狀態，傳回指定集合的適用路由群組陣列。 如需詳細資訊，請查看 github 文件。 |
| 啟動新簽入 |
請求將根據給定的 Qpp 屬性值陣列簽入本機檔案，例如，將資產簽入 QPPNG 所需的屬性值是名稱、集合、副檔名等。 如需詳細資訊，請查看 github 文件。 |
| 啟動簽入和更新 |
要求會簽入並更新 QPPNG 中現有的資產。 資產需要事先簽出。 之前使用結帳動作。 如需詳細資訊，請查看 github 文件。 |
| 建立新屬性 |
建立新屬性，並傳回其識別碼以及成功訊息。 如需詳細資訊，請參閱 GitHub 文件。 |
| 建立新的清單屬性 |
建立新屬性，並在成功建立屬性訊息後傳回其識別碼。 如需詳細資訊，請查看 github 文件。 |
| 建立查詢 |
在要求本文中建立具有定義和詳細資料的查詢。 如需詳細資訊，請參閱 GitHub 文件。 |
| 從標識碼取得屬性值 |
取得逗號分隔 ID 的屬性值。 如需詳細資訊，請查看 Github 文件。 |
| 更新內容類型的屬性對應 |
在要求內文中具有指定屬性對應，更新內容類型和子項的屬性對應。 如需詳細資訊，請參閱 GitHub 文件。 |
| 根據授權類型取得權杖 |
此要求會擷取 QPPNG 的指定使用者名稱及密碼的記號。 如需詳細資訊，請參閱 GitHub 文件。 |
| 獲取群組成員 |
此要求會傳回使用者清單，以及群組識別碼特有的所有中繼資料。如需詳細資訊，請參閱 GitHub 文件。 |
| 發佈資產非同步 |
傳回正在發佈的資產的內容ID。 與取得發佈狀態搭配使用。 如需詳細資訊，請參閱 GitHub 文件。 |
| 結帳 |
將具有指定assetId的資產標示為「已簽出」。有關詳細信息，請參閱 Github 文檔。 |
| 設定屬性值 |
設定 QPP 平台的屬性值。 如需詳細資訊，請查看 Github 文件。 |
上傳 （Blob）
此請求用於通過輸入流上傳文件。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
檔案識別碼
|
fileIdentifier | True | string |
檔案識別碼是指檔案的類型。 |
|
內容識別碼
|
contextId | True | string |
內容識別碼是指資源資訊。 |
|
輸入資料流程資源
|
InputStreamResource | True |
資源的輸入串流，需要二進位輸入。 |
下載 （Blob）
此請求用於通過下載URL的輸入流下載文件。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
驗證權杖
|
authTokenforHeader | True | string |
此處需要另外的驗證權杖。 TokenFromAuthWrapper 動作可在此處使用來擷取權杖。 |
|
檔案識別碼
|
fileIdentifier | True | string |
檔案識別碼是指檔案的類型。 |
|
內容識別碼
|
contextId | True | string |
內容識別碼是指資源資訊。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容類型
|
$content-type | string |
文件的內容類型，例如 application/pdf。 |
|
Content
|
$content | byte |
文件的內容採用 Base64 編碼。 |
使用篩選器取得分頁查詢結果
此要求會傳回分頁的查詢元素，以及儲存在系統中的查詢詳細資料，並在查詢中使用特定篩選器。 如需詳細資訊，請查看 github 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
現有的 QPPNG 查詢 ID
|
queryId | True | integer |
這是參照現有的 QPPNG 查詢 ID。 |
|
查詢標識碼
|
queryId | integer |
查詢的唯一識別碼。 |
|
|
查詢名稱
|
queryName | string |
查詢的名稱。 |
|
|
負責人識別碼
|
ownerId | integer |
查詢擁有者的識別碼。 |
|
|
參數化
|
parameterized | boolean |
指出查詢是否已參數化。 |
|
|
數據行標識碼
|
columnId | True | integer |
顯示欄的識別碼。 |
|
寬度
|
width | True | integer |
顯示欄的寬度。 |
|
屬性欄
|
attributeColumn | True | boolean |
指出資料行是否為屬性資料行。 |
|
數據行標識碼
|
columnId | integer |
用於排序的資料行的識別碼。 |
|
|
Descending
|
descending | boolean |
指出排序是否為遞減順序。 |
|
|
屬性欄
|
attributeColumn | boolean |
指出排序的直欄是否為屬性直欄。 |
|
|
顯示模式
|
displayMode | True | integer |
顯示模式設定。 |
|
屬性 ID
|
attributeId | integer |
分組屬性的 ID。 |
|
|
Descending
|
descending | boolean |
指出分組是否以遞減順序排列。 |
|
|
探索模式
|
exploreMode | integer |
探索模式設定。 |
|
|
邏輯運算子
|
logicalOperator | True | integer |
條件的邏輯運算子。 |
|
比較運算子
|
comparisonOperator | True | integer |
條件的比較運算子。 |
|
否定
|
negated | True | boolean |
指出條件是否被否定。 |
|
參數化
|
parameterized | True | boolean |
指出條件是否已參數化。 |
|
類型
|
type | True | integer |
條件的類型。 |
|
屬性識別碼
|
attributeId | True | integer |
搜尋的屬性 ID。 |
|
搜尋的值
|
value | True | string |
值來搜尋。 |
|
內容類型
|
contentType | integer |
查詢內容內容類型的識別碼。 |
|
|
Collections
|
collections | array of integer |
查詢內容的集合識別碼清單。 |
|
|
遞迴
|
recursive | boolean |
指出查詢內容是否為遞迴。 |
|
|
包括所有版本
|
includeAllVersions | boolean |
指出查詢內容中是否包含所有版本。 |
|
|
包括分支
|
includeBranches | boolean |
指出分支是否包含在查詢內容中。 |
|
|
查詢結果
|
queryResults |
傳回
Response 元素，用於列出查詢結果。
- 清單回應查詢結果元素
- ListResponseQueryResultElement
使用者是群組成員嗎
此要求會傳回 true 或 false，表示使用者是 userId 特定群組的成員。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
QPPNG 使用者的 ID
|
userId | True | integer |
QPPNG 使用者的 ID。 |
|
QPPNG中組的ID
|
groupId | True | integer |
QPPNG 中群組的 ID。 |
依名稱取得使用者
此請求將傳回特定於使用者名稱的使用者中繼資料。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
QPPNG 使用者的使用者名稱
|
userName | True | string |
這是指 QPPNG 使用者的使用者名稱。 |
傳回
- 身體
- User
依名稱取得內容類型資訊
此要求可用來依內容類型名稱擷取內容類型資訊。 有關詳細信息，請參閱 Github 文檔。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
內容類型名稱
|
contentTypeName | True | string |
內容類型的名稱。 |
傳回
- response
- array of ContentTypeInfo
依名稱取得屬性
傳回 QPPNG 伺服器中所有現有屬性，其中包含指定名稱的 meta 資料。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
屬性名稱
|
attributeNames | True | string |
屬性名稱應該參照 QPP 伺服器的屬性名稱 （如果是多個，則以逗點分隔）。 |
傳回
- response
- array of Attribute
依名稱取得屬性值
取得逗號分隔名稱的屬性值。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
資產識別碼
|
assetId | True | integer |
AssetId 應該參照 QPP 伺服器的資產。 |
|
屬性名稱
|
attributes | True | string |
屬性名稱字串應該參照 QPPNG 伺服器的屬性名稱，如果是多個，則以逗點區隔。 |
傳回
- response
- array of AttributeValue
依名稱取得工作流程
此要求會依名稱傳回指定工作流程的所有中繼資料。 有關詳細信息，請參閱 Github 文檔。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
工作流程名稱
|
workflowName | True | string |
需要擷取中繼資料的工作流程名稱。 |
傳回
工作流程的詳細資料。
- Workflow
- Workflow
依名稱取得群組
此請求將傳回群組名稱特定的群組。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
群組名稱
|
groupName | True | string |
變數 groupName 應該參照 QPP 伺服器群組的名稱。 |
傳回
- 身體
- Group
依識別碼取得使用者
此要求可用來擷取指定使用者的中繼資料。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
QPPNG 使用者 ID
|
userId | True | integer |
QPPNG 使用者的 ID。 |
傳回
- 身體
- User
刪除 Webhook
刪除指定事件和變更類型的現有 Webhook。 如需詳細資訊，請查看 github 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
名稱或識別碼
|
nameOrId | True | string |
環境中現有 Webhook 的名稱或識別碼。 |
傳回
取得子項資產關係
取得給定父資產ID的子資產關係。有關詳細信息，請參閱 Github 文檔。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
父資產識別碼
|
parentAssetId | True | integer |
父資產 ID 應參照 QPP 伺服器的父資產。 |
傳回
- response
- array of AssetRelation
取得所有使用者
此請求用於提取所有用戶。 詳情請參閱 Github 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
傳回
列出使用者的回應元素。
- 清單回應使用者
- ListResponseUser
取得所有查詢
此請求將返回具有定義的所有查詢。 有關詳細信息，請參閱 Github 文檔。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
傳回
- response
- array of QueryDefinition
取得父資產關係
此要求會傳回父資產關聯的關聯性清單。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
子資產 ID
|
childAssetId | True | integer |
變數 childAssetId 應該參照 QPP 伺服器的子資產，該資產與父項有關聯性，且需要找出其父項關聯性。 |
傳回
- response
- array of AssetRelation
取得發佈狀態
取得指定資產的發佈狀態。 有關詳細信息，請參閱 Github 文檔。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
內容識別碼
|
contextId | True | string |
內容識別碼 |
傳回
取得資產下載資訊
要求會傳回資產下載資訊，可與下載Blob動作一起使用，以下載資產串流。 如需詳細資訊，請查看 github 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
資產識別碼
|
assetId | True | integer |
AssetId 應該參照 QPP 伺服器的資產。 |
|
小版本
|
minorVersion | integer |
次要版本應指所需資產的次要版本。 提供 0 以取得最新版本的元資料。 |
|
|
主要版本
|
majorVersion | integer |
主要版本應指所需資產的主要版本。 提供 null 以擷取最新版本的中繼資料。 |
傳回
取得資產中繼資料
取得指定資產識別碼的資產資料。如需詳細資訊，請查看 Github 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
資產識別碼
|
assetId | True | integer |
所指向之 QPPNG 平台上資產的 ID。 |
傳回
- 身體
- Asset
取得集合的群組
此要求會針對指定的工作流程和狀態，傳回指定集合的適用路由群組陣列。 如需詳細資訊，請查看 github 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
QPPNG 集合的 ID
|
collectionId | True | integer |
變數 collectionId 應該參照 QPPNG 集合 ID。 |
傳回
啟動新簽入
請求將根據給定的 Qpp 屬性值陣列簽入本機檔案，例如，將資產簽入 QPPNG 所需的屬性值是名稱、集合、副檔名等。 如需詳細資訊，請查看 github 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
要略過的屬性/域數
|
_skiptoken | True | integer |
要略過的屬性/網域數目。 |
|
建立次要版本
|
createMinorVersion | True | boolean |
變數 createMinorVersion 應該參考 true 或 false 來建立版本以進行檢查。 |
|
屬性識別碼
|
attributeId | integer |
屬性識別碼。 |
|
|
屬性類型
|
type | integer |
屬性類型。 |
|
|
多值
|
multiValued | boolean |
指出屬性是否為多值。 |
|
|
Id
|
id | integer |
識別碼對應於名稱，例如對於首頁集合識別碼 1。 |
|
|
名稱
|
name | string |
屬性的名稱，例如內容類型名稱或集合名稱。 |
|
|
網域識別碼
|
domainId | integer |
與現有資料來源/網域清單相關聯的網域 ID。 其網域的 ID。 |
|
|
價值觀
|
value | string |
要設定的屬性值。 |
|
|
網域值 ID
|
id | integer |
網域值本身的 ID，例如使用者的網域值的 ID 將是使用者 ID，因為使用者清單是網域。 |
傳回
啟動簽入和更新
要求會簽入並更新 QPPNG 中現有的資產。 資產需要事先簽出。 之前使用結帳動作。 如需詳細資訊，請查看 github 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
建立次要版本
|
createMinorVersion | True | boolean |
變數 createMinorVersion 應該參考 true 或 false 來建立版本以進行檢查。 |
|
資產識別碼
|
assetId | integer |
要簽入之資產的資產識別碼。 |
傳回
建立新屬性
建立新屬性，並傳回其識別碼以及成功訊息。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
名稱
|
name | True | string |
屬性的名稱。 |
|
屬性類型
|
valueType | True | integer |
屬性類型。 |
傳回
與實體相關聯之屬性的詳細資料。
- Attribute
- CreateAttributeSchema
建立新的清單屬性
建立新屬性，並在成功建立屬性訊息後傳回其識別碼。 如需詳細資訊，請查看 github 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
要顯示的網域數目
|
_skiptoken | True | integer |
要從網域識別碼下拉式清單中略過的網域數目。 |
|
名稱
|
name | True | string |
屬性的名稱。 |
|
屬性類型
|
valueType | True | integer |
屬性類型，對於列表類型，應該是列表。 |
|
多值
|
multiValued | boolean |
指出屬性是否可以保留多個值。 |
|
|
有限存取
|
limitedAccess | boolean |
僅適用於清單型別 （指出屬性是否具有限制的存取權，需要在此之前為此設定角色）。 |
|
|
網域識別碼
|
domainId | integer |
與現有資料來源/網域清單相關聯的網域 ID。 使用跳過令牌在下拉列表中瀏覽 20 個項目。 |
傳回
與實體相關聯之屬性的詳細資料。
- Attribute
- CreateAttributeSchema
建立查詢
在要求本文中建立具有定義和詳細資料的查詢。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
要略過的屬性數目
|
_skiptoken | True | integer |
要從屬性下拉式清單中略過的屬性數目。 |
|
查詢名稱
|
queryName | True | string |
查詢的名稱。 |
|
參數化
|
parameterized | boolean |
指出查詢是否已參數化。 |
|
|
屬性識別碼
|
attributeId | integer |
搜尋的屬性 ID。 |
|
|
屬性類型
|
type | integer |
為條件選取的屬性類型。 |
|
|
比較運算子
|
comparisonOperator | integer |
條件的比較運算子。 |
|
|
否定
|
negated | boolean |
指出條件是否被否定。 |
|
|
搜尋的值
|
value | string |
值來搜尋。 |
|
|
邏輯運算子
|
logicalOperator | integer |
條件的邏輯 And OR 運算子。 |
|
|
數據行標識碼
|
columnId | True | integer |
顯示欄的識別碼。 |
|
寬度
|
width | True | integer |
顯示欄的寬度。 |
|
屬性欄
|
attributeColumn | True | boolean |
指出資料行是否為屬性資料行。 |
|
顯示模式
|
displayMode | True | integer |
顯示模式設定。 |
傳回
新建立的查詢識別碼。
- 新建立的查詢識別碼
- integer
從標識碼取得屬性值
取得逗號分隔 ID 的屬性值。 如需詳細資訊，請查看 Github 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
資產識別碼
|
assetId | True | integer |
所指向之 QPPNG 平台上資產的 ID。 |
|
QPPNG 屬性 ID
|
attributeIds | True | string |
屬性 ID 應該參照 QPP 伺服器的屬性 ID。 |
傳回
- response
- array of AttributeValue
更新內容類型的屬性對應
在要求內文中具有指定屬性對應，更新內容類型和子項的屬性對應。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
屬性識別碼
|
attributeId | True | integer |
需要對應的屬性識別碼。 |
|
內容類型標識符
|
contentTypeIds | True | string |
需要將這些屬性對應到的內容型別。 |
根據授權類型取得權杖
此要求會擷取 QPPNG 的指定使用者名稱及密碼的記號。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
用戶名稱
|
username | True | string |
請輸入您需要取得權杖的 QPPNG 環境使用者名稱。 |
|
密碼
|
password | True | string |
請輸入使用者名稱的密碼。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
存取令牌
|
access_token | string |
授與受保護資源存取權的權杖。 |
|
過期於
|
expires_in | integer |
存取權杖有效的持續時間 （以秒為單位）。 |
|
重新整理到期時間
|
refresh_expires_in | integer |
重新整理權杖有效的持續時間 （以秒為單位）。 |
|
令牌類型
|
token_type | string |
令牌的類型（例如，持有者）。 |
|
不在政策之前
|
not-before-policy | integer |
無法使用權杖的時間 （以秒為單位）。 |
|
Scope
|
scope | string |
存取令牌的範圍。 |
獲取群組成員
此要求會傳回使用者清單，以及群組識別碼特有的所有中繼資料。如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
群組識別碼
|
groupId | True | integer |
群組 ID 應該參照 QPPNG 群組。 |
傳回
- response
- array of User
發佈資產非同步
傳回正在發佈的資產的內容ID。 與取得發佈狀態搭配使用。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
資產識別碼
|
assetId | True | string |
變數 assetId 應該參照 QPP 伺服器的資產。 |
|
發佈頻道ID
|
publishingChannelId | True | string |
變數 channelId 應該參考要使用的通道 ID。 |
傳回
正在發佈的資產的內容ID。 與取得發佈狀態搭配使用，以檢查發佈狀態。
- 內容識別碼
- string
結帳
將具有指定assetId的資產標示為「已簽出」。有關詳細信息，請參閱 Github 文檔。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
資產識別碼
|
assetId | True | integer |
變數 assetId 應該參照 QPP 伺服器的資產。 |
|
屬性識別碼
|
attributeId | integer |
屬性的識別碼。 |
|
|
類型
|
type | integer |
屬性的類型。 |
|
|
價值觀
|
attributeValue | object |
價。 |
傳回
- 身體
- Asset
設定屬性值
設定 QPP 平台的屬性值。 如需詳細資訊，請查看 Github 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
資產識別碼
|
assetId | True | string |
QPP 平台資產 ID。 |
|
屬性識別碼
|
attributeId | integer |
屬性的識別碼。 |
|
|
類型
|
type | integer |
屬性的類型。 |
|
|
多值
|
multiValued | boolean |
指出屬性是否為多值。 |
|
|
價值觀
|
attributeValue | object |
價。 |
觸發程序
| 當已註冊的 Webhook 發生事件時觸發 |
註冊指定事件的 Webhook 並變更類型。 如需詳細資訊，請參閱 GitHub 文件。 |
當已註冊的 Webhook 發生事件時觸發
註冊指定事件的 Webhook 並變更類型。 如需詳細資訊，請參閱 GitHub 文件。
參數
| 名稱 | 機碼 | 必要 | 類型 | Description |
|---|---|---|---|---|
|
模擬使用者
|
user_name | True | string |
QPPNG 使用者的使用者名稱，需要模擬。 |
|
Webhook 名稱
|
name | True | string |
描述 Webhook 用途和意義的唯一名稱。 |
|
Webhook 類型
|
type | True | string |
描述將要接聽的 Webhook 類型，例如事件等。 |
|
物體
|
object | True | string |
描述要監聽的物件類型，例如資產等。 |
|
變更類型
|
changeType | True | array of string | |
|
篩選條件
|
filter | string |
可以定義篩選條件來篩選事件類型。 |
|
|
使用的版本
|
version | True | string |
QPPNG 平台中根據 Webhook 服務使用的版本。 |
傳回
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
使用的版本
|
version | string |
QPPNG 平台中每個 Webhook 服務使用的版本。 |
|
Webhook 類型
|
webhookInfo.type | string |
描述將要接聽的 Webhook 類型，例如事件等。 |
|
Webhook Id
|
webhookInfo.id | string |
Webhook 識別碼。 |
|
Webhook 名稱
|
webhookInfo.name | string |
唯一名稱，用於描述 Webhook 的目的和意義。 |
|
輔助數據
|
webhookInfo.auxData | string |
AuxData （如果在註冊時提供）。 |
定義
發佈輸出下載資訊
定義發佈輸出下載資訊。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
屬性地圖
|
attributesMap | object | |
|
直接下載
|
directDownload | boolean |
定義是否允許直接下載。 |
|
下載網址
|
downloadUrl | string |
提供可與下載 Blob 動作搭配使用的下載 URL，以從 Blob 位置下載。 |
WebhookSuccess回應
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | string |
定義 Webhook 成功回應的 ID。 |
|
地位
|
status | string |
定義 Webhook 成功回應的狀態。 |
|
Message
|
message | string |
定義 Webhook 成功回應的訊息。 |
|
版本
|
version | string |
定義 Webhook 成功回應的版本。 |
AttributeValue
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
屬性 ID
|
attributeId | integer |
定義 QPPNG 屬性的「屬性 ID」。 |
|
屬性名稱
|
attributeName | string |
定義 QPPNG 屬性的「屬性名稱」。 |
|
類型
|
type | integer |
定義 QPPNG 屬性的類型。 |
|
多值
|
multiValued | boolean |
定義屬性是否為多值。 |
|
價值觀
|
attributeValue | Value |
價。 |
資產上傳資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容 ID
|
contextId | string |
定義資產上傳的內容 ID。 |
|
上傳網址
|
uploadUrl | string |
定義資產的上傳URL。 |
資產
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
資產標識碼
|
assetId | integer |
定義 QPPNG 資產的資產 ID。 |
|
assetVersion
|
assetVersion | AssetVersion | |
|
屬性值
|
attributeValues | array of AttributeValue |
User
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
使用者識別碼。 |
|
名稱
|
name | string |
使用者名稱。 |
|
網域 ID
|
domainId | integer |
使用者的網域 ID。 |
|
來源參考
|
sourceReference | string |
使用者的來源參考。 |
|
子網域值
|
childDomainValues | array of DomainValue |
子網域值的陣列。 |
|
有孩子
|
hasChildren | boolean |
指出使用者是否有子項。 |
|
已刪除
|
isDeleted | boolean |
指出使用者是否已刪除。 |
|
是使用者
|
user | boolean |
指出實體是否為使用者。 |
|
LDAP 設定檔 ID
|
ldapProfileId | integer |
使用者的LDAP設定檔ID。 |
|
預設使用者類別識別碼
|
defaultUserClassId | integer |
預設使用者類別 ID。 |
|
電子郵件地址
|
emailAddress | string |
用戶的電子郵件位址。 |
|
已刪除
|
deleted | boolean |
指出使用者是否已刪除。 |
|
LDAP 識別名稱
|
ldapDistinguishedName | string |
使用者的 LDAP 識別名稱。 |
|
原住民受託人
|
nativeTrustee | boolean |
指出使用者是否為原生受託人。 |
|
名字
|
firstName | string |
使用者的名字。 |
|
姓氏
|
lastName | string |
使用者的姓氏。 |
|
電話號碼
|
phoneNumber | string |
使用者的電話號碼。 |
|
已啟用
|
enabled | boolean |
指出使用者是否已啟用。 |
|
外部驗證
|
externallyAuthenticated | boolean |
指出使用者是否經過外部驗證。 |
|
驗證名稱
|
nameForAuthentication | string |
驗證的名稱。 |
清單回應集合群組
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
get_count | integer |
回應中的項目數。 |
|
下一個連結
|
get_nextLink | string |
下一組結果的 URL。 |
|
價值觀
|
get_value | array of CollectionGroup |
集合群組陣列。 |
價值觀
價。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
object |
價。 |
資產版本
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
主要版本
|
majorVersion | integer |
資產的主要版本。 |
|
小版本
|
minorVersion | integer |
資產的次要版本。 |
|
分行識別碼
|
branchId | integer |
分支版本識別碼。 |
|
系統名稱
|
systemName | string |
資產版本的系統名稱。 |
網域值
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
網域值 ID。 |
|
名稱
|
name | string |
網域值的名稱。 |
|
網域 ID
|
domainId | integer |
網域值的網域 ID。 |
|
來源參考
|
sourceReference | string |
網域值的來源參考。 |
|
子網域值
|
childDomainValues | string |
子網域值的陣列。 |
|
有孩子
|
hasChildren | boolean |
指出網域值是否有子項。 |
|
已刪除
|
isDeleted | boolean |
指出是否刪除網域值。 |
收藏Group
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
群組識別碼
|
groupId | integer |
集合群組的 ID。 |
|
群組資訊
|
groupInfo | GroupInfo | |
|
覆寫的使用者類別識別碼
|
overriddenUserClassId | integer |
覆寫使用者類別的識別碼。 |
群組資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
群組 ID。 |
|
名稱
|
name | string |
群組的名稱。 |
|
網域 ID
|
domainId | integer |
群組的網域 ID。 |
|
來源參考
|
sourceReference | string |
群組的來源參考。 |
|
子網域值
|
childDomainValues | array of DomainValue |
子網域值的陣列。 |
|
有孩子
|
hasChildren | boolean |
指出群組是否有子項。 |
|
已刪除
|
isDeleted | boolean |
指出是否已刪除群組。 |
|
是使用者
|
user | boolean |
指出群組是否代表使用者。 |
|
LDAP 設定檔 ID
|
ldapProfileId | integer |
LDAP 設定檔 ID。 |
|
預設使用者類別識別碼
|
defaultUserClassId | integer |
預設使用者類別的 ID。 |
|
電子郵件地址
|
emailAddress | string |
群組的電子郵件地址。 |
|
已刪除
|
deleted | boolean |
指出是否已刪除群組。 |
|
LDAP 識別名稱
|
ldapDistinguishedName | string |
群組的 LDAP 識別名稱。 |
|
原住民受託人
|
nativeTrustee | boolean |
指出群組是否為原生受託人。 |
資產下載資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容 ID
|
contextId | string |
內容的識別碼。 |
|
下載網址
|
downloadUrl | string |
用於下載資產的URL。 |
Workflow
工作流程的詳細資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
工作流程的唯一識別碼。 |
|
名稱
|
name | string |
工作流程的名稱。 |
|
網域 ID
|
domainId | integer |
與工作流程相關聯之網域的識別碼。 |
|
來源參考
|
sourceReference | string |
與工作流程來源相關聯的參考。 |
|
子網域值
|
childDomainValues | array of DomainValue |
與工作流程相關聯的子網域值清單。 |
|
有孩子
|
hasChildren | boolean |
指出工作流程是否有子項。 |
|
已刪除
|
isDeleted | boolean |
指出工作流程是否已標示為已刪除。 |
|
狀態
|
statuses | array of Status |
工作流程中的狀態清單。 |
|
作者
|
createdBy | integer |
工作流程建立者的使用者 ID。 |
|
建立日期
|
created | string |
建立工作流程的日期。 |
|
上次修改者
|
lastModifiedBy | integer |
工作流程最後一個修飾元的使用者 ID。 |
|
上次修改日期
|
lastModified | string |
上次修改工作流程的日期。 |
|
受限制狀態轉換
|
constrainedStatusTransition | boolean |
定義狀態轉移是否受到限制。 |
|
狀態路由使用者類別
|
statusRoutingUserclasses | array of StatusRoutingUserClasses |
狀態路由使用者類別清單。 |
|
狀態轉換
|
statusTransitions | array of StatusTransition |
狀態轉換清單。 |
地位
代表狀態。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
狀態的唯一識別碼。 |
|
名稱
|
name | string |
狀態的名稱。 |
|
網域 ID
|
domainId | integer |
狀態的網域識別碼。 |
|
來源參考
|
sourceReference | string |
狀態來源的參照。 |
|
子網域值
|
childDomainValues | array of DomainValue |
子網域值的陣列。 |
|
有孩子
|
hasChildren | boolean |
指出狀態是否具有子狀態。 |
|
已刪除
|
isDeleted | boolean |
指出狀態是否已刪除。 |
|
工作流程識別碼
|
workflowId | integer |
與狀態相關聯的工作流程識別碼。 |
|
顏色：紅色
|
colorRed | integer |
狀態顏色的紅色元件。 |
|
顏色 綠色
|
colorGreen | integer |
狀態顏色的綠色元件。 |
|
顏色 藍色
|
colorBlue | integer |
狀態顏色的藍色元件。 |
|
Position
|
position | integer |
狀態的位置。 |
StatusRoutingUser類別
將狀態對應至使用者類別以進行路由。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
狀態標識碼
|
statusId | integer |
路由狀態的 ID。 |
|
路由使用者類別識別碼
|
routingUserClassIds | array of integer |
用於路由的使用者類別識別碼陣列。 |
|
基於使用者類別的路由
|
userClassBasedRouting | boolean |
指出是否已啟用使用者類別型路由。 |
狀態轉換
工作流程中狀態轉換的詳細資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
狀態標識碼
|
statusId | integer |
狀態轉換的識別碼。 |
|
工作流程起始狀態
|
workflowInitiatingStatus | boolean |
指出轉換是否由工作流程起始。 |
|
下一個 可能的狀態 ID
|
nextPossibleStatusIds | array of integer |
此轉換之後下一個可能狀態的識別碼。 |
資產關係
資產之間關係的詳細資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
資產關係的唯一 ID。 |
|
父資產 ID
|
parentAssetId | integer |
關係中父項資產的 ID。 |
|
parentAsset版本
|
parentAssetVersion | AssetVersion | |
|
子資產 ID
|
childAssetId | integer |
關係中子資產的 ID。 |
|
childAsset版本
|
childAssetVersion | AssetVersion | |
|
關係類型 ID
|
relationTypeId | integer |
關係類型的 ID。 |
|
關係狀態
|
relationState | integer |
關係狀態。 |
|
鎖定為子版本
|
lockedToChildVersion | boolean |
指示關聯是否鎖定至子版本的旗標。 |
|
凍結至目前版本
|
freezeToCurrentVersion | boolean |
指示關聯性是否凍結至目前版本的旗標。 |
|
關係屬性
|
relationAttributes | array of AttributeValue |
與關係相關聯的屬性。 |
Attribute
與實體相關聯之屬性的詳細資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
屬性的唯一 ID。 |
|
名稱
|
name | string |
屬性的名稱。 |
|
值類型
|
valueType | integer |
屬性所保留的值類型。 |
|
使用者定義
|
userDefined | boolean |
指出屬性是否為使用者定義。 |
|
可查詢
|
queryable | boolean |
指出屬性是否可查詢。 |
|
多值
|
multiValued | boolean |
指出屬性是否可以保留多個值。 |
|
修改等級
|
modificationLevel | integer |
屬性的修改層級。 |
|
建立日期
|
created | string |
建立屬性的日期。 |
|
上次修改日期
|
lastModified | string |
上次修改屬性的日期。 |
|
Creator
|
creator | integer |
建立屬性的使用者識別碼。 |
|
最後一個詞綴
|
lastModifier | integer |
上次修改屬性的使用者識別碼。 |
|
可顯示
|
displayable | boolean |
指出屬性是否可顯示。 |
|
有限存取
|
limitedAccess | boolean |
指出屬性是否具有有限的存取權。 |
|
有限訪問可更改
|
limitedAccessChangeable | boolean |
指出是否可以變更受限存取設定。 |
|
約束可變更
|
constraintsChangeable | boolean |
指出屬性的約束是否可以變更。 |
|
值偏好可更改
|
valuePreferencesChangeable | boolean |
指出是否可以變更值偏好設定。 |
|
布林值偏好設定
|
booleanValuePreferences | BooleanValuePreferences |
布林值的偏好設定。 |
|
數值偏好設定
|
numericValuePreferences | NumericValuePreferences |
數值的喜好設定。 |
|
日期值偏好設定
|
dateValuePreferences | DateValuePreferences |
日期值的偏好設定。 |
|
日期時間值偏好設定
|
dateTimeValuePreferences | DateTimeValuePreferences |
DateTime 值的偏好設定。 |
|
時間值偏好設定
|
timeValuePreferences | TimeValuePreferences |
時間值的喜好設定。 |
|
測量值偏好設定
|
measurementValuePreferences | MeasurementValuePreferences |
測量值的偏好設定。 |
|
文字值偏好設定
|
textValuePreferences | TextValuePreferences |
文字值的喜好設定。 |
|
網域值清單偏好設定
|
domainValueListPreferences | DomainValueListPreferences |
網域值清單的喜好設定。 |
|
網域值偏好設定
|
domainValuePreferences | DomainValuePreferences |
網域值的喜好設定。 |
建立屬性架構
與實體相關聯之屬性的詳細資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
屬性的唯一 ID。 |
|
名稱
|
name | string |
屬性的名稱。 |
|
值類型
|
valueType | integer |
屬性保留的值類型 1 表示文字類型等。 |
|
使用者定義
|
userDefined | boolean |
指出屬性是否為使用者定義。 |
|
可查詢
|
queryable | boolean |
指出屬性是否可查詢。 |
|
多值
|
multiValued | boolean |
指出屬性是否可以保留多個值。 |
|
修改等級
|
modificationLevel | integer |
屬性的修改層級。 |
|
建立日期
|
created | string |
建立屬性的日期。 |
|
上次修改日期
|
lastModified | string |
上次修改屬性的日期。 |
|
Creator
|
creator | integer |
建立屬性的使用者識別碼。 |
|
最後一個詞綴
|
lastModifier | integer |
上次修改屬性的使用者識別碼。 |
|
可顯示
|
displayable | boolean |
指出屬性是否可顯示。 |
|
有限存取
|
limitedAccess | boolean |
指出屬性是否具有有限的存取權。 |
|
有限訪問可更改
|
limitedAccessChangeable | boolean |
指出是否可以變更受限存取設定。 |
|
約束可變更
|
constraintsChangeable | boolean |
指出屬性的約束是否可以變更。 |
|
值偏好可更改
|
valuePreferencesChangeable | boolean |
指出是否可以變更值偏好設定。 |
|
布林值偏好設定
|
booleanValuePreferences | BooleanValuePreferences |
布林值的偏好設定。 |
|
數值偏好設定
|
numericValuePreferences | NumericValuePreferences |
數值的喜好設定。 |
|
日期值偏好設定
|
dateValuePreferences | DateValuePreferences |
日期值的偏好設定。 |
|
日期時間值偏好設定
|
dateTimeValuePreferences | DateTimeValuePreferences |
DateTime 值的偏好設定。 |
|
時間值偏好設定
|
timeValuePreferences | TimeValuePreferences |
時間值的喜好設定。 |
|
測量值偏好設定
|
measurementValuePreferences | MeasurementValuePreferences |
測量值的偏好設定。 |
|
文字值偏好設定
|
textValuePreferences | TextValuePreferences |
文字值的喜好設定。 |
|
網域值清單偏好設定
|
domainValueListPreferences | DomainValueListPreferences |
網域值清單的喜好設定。 |
|
網域值偏好設定
|
domainValuePreferences | DomainValuePreferences |
網域值的喜好設定。 |
內容類型資訊
內容類型的詳細資料。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
內容類型的唯一識別碼。 |
|
名稱
|
name | string |
內容類型的名稱。 |
|
網域 ID
|
domainId | integer |
與內容類型相關聯的網域識別碼。 |
|
來源參考
|
sourceReference | string |
內容類型來源的參考。 |
|
子網域值
|
childDomainValues | array of DomainValue |
與內容類型相關聯的子網域值清單。 |
|
有孩子
|
hasChildren | boolean |
指出內容類型是否有子項。 |
|
已刪除
|
isDeleted | boolean |
指出內容類型是否已刪除。 |
|
系統定義
|
systemDefined | boolean |
指出內容類型是否為系統定義。 |
|
提供兒童
|
childrenAvailable | boolean |
指出子項是否可用於內容類型。 |
|
可延伸
|
extensible | boolean |
指出內容類型是否可延伸。 |
布林值偏好設定
布林值的偏好設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
布林值
|
defaultValue | BooleanValue |
布林值。 |
布林值
布林值。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | boolean |
布林值。 |
數值偏好設定
數值的喜好設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
數值
|
minimumPossibleValue | NumericValue |
數值。 |
|
數值
|
maximumPossibleValue | NumericValue |
數值。 |
|
數值
|
defaultValue | NumericValue |
數值。 |
數值
數值。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | integer |
數值。 |
DateValue
日期值。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | string |
日期值。 |
DateValue偏好設定
日期值的偏好設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
日期值
|
minimumPossibleValue | DateValue |
日期值。 |
|
日期值
|
maximumPossibleValue | DateValue |
日期值。 |
|
日期值
|
defaultValue | DateValue |
日期值。 |
DateTimeValue
DateTime 值。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | string |
DateTime 值。 |
DateTimeValue偏好設定
DateTime 值的偏好設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
日期時間值
|
minimumPossibleValue | DateTimeValue |
DateTime 值。 |
|
日期時間值
|
maximumPossibleValue | DateTimeValue |
DateTime 值。 |
|
日期時間值
|
defaultValue | DateTimeValue |
DateTime 值。 |
TimeValue
時間值。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | string |
時間值。 |
時間值偏好設定
時間值的喜好設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
時間價值
|
minimumPossibleValue | TimeValue |
時間值。 |
|
時間價值
|
maximumPossibleValue | TimeValue |
時間值。 |
|
時間價值
|
defaultValue | TimeValue |
時間值。 |
測量值
測量值。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | double |
測量值。 |
測量值偏好設定
測量值的偏好設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
測量單位
|
measurementUnit | integer |
測量單位。 |
|
只有可更換的測量單位
|
onlyMeasurementUnitChangeable | boolean |
指示是否只有測量單位可變更。 |
|
測量值
|
minimumPossibleValue | MeasurementValue |
測量值。 |
|
測量值
|
maximumPossibleValue | MeasurementValue |
測量值。 |
|
測量值
|
defaultValue | MeasurementValue |
測量值。 |
文字值
文字值
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
價值觀
|
value | string |
文字值。 |
文字值偏好設定
文字值的喜好設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
文字值
|
defaultValue | TextValue |
文字值 |
|
可能的最大長度
|
maxLengthPossible | integer |
文字值的可能長度上限。 |
|
已啟用文字搜尋
|
textSearchEnabled | boolean |
指出是否啟用文字搜尋。 |
網域值清單
網域值清單。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
網域值
|
domainValues | array of DomainValue |
網域值清單。 |
網域值清單偏好設定
網域值清單的喜好設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
網域值清單
|
defaultValue | DomainValueList |
網域值清單。 |
|
網域 ID
|
domainId | integer |
與網域值清單相關聯的網域 ID。 |
網域值偏好設定
網域值的喜好設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
defaultValue
|
defaultValue | DomainValue | |
|
網域 ID
|
domainId | integer |
與網域值相關聯的網域 ID。 |
查詢定義
查詢的定義。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
查詢標識碼
|
queryId | integer |
查詢的唯一識別碼。 |
|
查詢名稱
|
queryName | string |
查詢的名稱。 |
|
負責人識別碼
|
ownerId | integer |
查詢擁有者的識別碼。 |
|
參數化
|
parameterized | boolean |
指出查詢是否已參數化。 |
|
查詢顯示
|
queryDisplay | QueryDisplay |
顯示查詢的設定。 |
|
查詢條件
|
queryConditions | array of QueryCondition |
查詢條件清單。 |
|
查詢內容
|
queryContext | QueryContext |
查詢的內容設定。 |
|
查詢結果
|
queryResults |
查詢顯示
顯示查詢的設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
顯示欄
|
displayColumns | array of DisplayColumn |
顯示欄清單。 |
|
排序
|
sorting | array of SortInfo |
排序設定清單。 |
|
顯示模式
|
displayMode | integer |
顯示模式設定。 |
|
分組屬性
|
groupingAttributes | array of GroupingInfo |
分組屬性清單。 |
|
探索模式
|
exploreMode | integer |
探索模式設定。 |
查詢條件
查詢的條件。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
邏輯運算子
|
logicalOperator | integer |
條件的邏輯運算子。 |
|
比較運算子
|
comparisonOperator | integer |
條件的比較運算子。 |
|
否定
|
negated | boolean |
指出條件是否被否定。 |
|
參數化
|
parameterized | boolean |
指出條件是否已參數化。 |
|
類型
|
type | integer |
條件的類型。 |
|
屬性識別碼
|
attributeId | integer |
搜尋的屬性 ID。 |
|
搜尋的值
|
value | string |
值來搜尋。 |
查詢內容
查詢的內容設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
內容類型
|
contentType | integer |
查詢內容內容類型的識別碼。 |
|
Collections
|
collections | array of integer |
查詢內容的集合識別碼清單。 |
|
遞迴
|
recursive | boolean |
指出查詢內容是否為遞迴。 |
|
包括所有版本
|
includeAllVersions | boolean |
指出查詢內容中是否包含所有版本。 |
|
包括分支
|
includeBranches | boolean |
指出分支是否包含在查詢內容中。 |
顯示欄
查詢中顯示的資料行。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
數據行標識碼
|
columnId | integer |
顯示欄的識別碼。 |
|
寬度
|
width | integer |
顯示欄的寬度。 |
|
屬性欄
|
attributeColumn | boolean |
指出資料行是否為屬性資料行。 |
排序資訊
查詢的排序設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
數據行標識碼
|
columnId | integer |
用於排序的資料行的識別碼。 |
|
Descending
|
descending | boolean |
指出排序是否為遞減順序。 |
|
屬性欄
|
attributeColumn | boolean |
指出排序的直欄是否為屬性直欄。 |
分組資訊
查詢的群組設定。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
屬性 ID
|
attributeId | integer |
分組屬性的 ID。 |
|
Descending
|
descending | boolean |
指出分組是否以遞減順序排列。 |
ListResponseQueryResult元素
Response 元素，用於列出查詢結果。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
get_count | integer |
清單回應中的結果數。 |
|
下一個連結
|
get_nextLink | string |
鏈接到下一頁結果。 |
|
價值觀
|
get_value | array of QueryResultElement |
查詢結果元素的陣列。 |
QueryResult元素
查詢結果中的元素。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
ID
|
id | integer |
元素的唯一識別碼。 |
|
兒童可用
|
childAvailable | boolean |
指出子元素是否可用。 |
|
元素類型
|
elementType | integer |
元素的類型。 |
清單回應使用者
列出使用者的回應元素。
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
Count
|
get_count | integer |
清單回應中的使用者數目。 |
|
下一個連結
|
get_nextLink | string |
鏈接到下一頁結果。 |
|
價值觀
|
get_value | array of User |
使用者元素陣列。 |
發佈狀態資訊
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
PublishingFailedException
|
publishingFailedException | PublishingFailedException |
發佈失敗時擲回的例外狀況 |
|
publishingOutputDownloadInfo
|
publishingOutputDownloadInfo | array of PublishingOutputDownloadInfo | |
|
發佈狀態
|
publishingStatus | string |
資產發佈狀態，可能的傳回值為PUBLISHING_IN_PROGESS、PUBLISHING_FAILED PUBLISHING_COMPLETED |
PublishingFailedException
發佈失敗時擲回的例外狀況
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
其他資訊
|
additionalInfo | array of string |
與例外狀況相關的其他資訊 |
|
投擲
|
cause | Throwable |
例外狀況和錯誤的基類 |
|
例外狀況程式碼
|
exceptionCode | string |
與例外相關聯的程式碼 |
|
本地化訊息
|
localizedMessage | string |
描述例外狀況的當地語系化訊息 |
|
Message
|
message | string |
描述例外狀況的訊息 |
|
堆疊追蹤
|
stackTrace | array of StackTraceElement | |
|
壓制
|
suppressed | array of Throwable |
投擲
例外狀況和錯誤的基類
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
原因
|
cause | string |
投擲的原因 |
|
本地化訊息
|
localizedMessage | string |
描述 throwable 的當地語系化訊息 |
|
Message
|
message | string |
描述 throwable 的訊息 |
|
堆疊追蹤
|
stackTrace | array of StackTraceElement | |
|
已隱藏
|
suppressed | array of string |
其他被該投擲物壓制的投擲物 |
堆疊追蹤元素
代表單一堆疊框架的元素
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
類別名稱
|
className | string |
包含執行點的類別名稱 |
|
檔案名稱
|
fileName | string |
包含執行點的檔案名稱 |
|
行號
|
lineNumber | integer |
包含執行點的檔案中的行號 |
|
方法名稱
|
methodName | string |
包含執行點的方法名稱 |
|
原生方法
|
nativeMethod | boolean |
指出方法是否為原生方法 |
群體
| 名稱 | 路徑 | 類型 | Description |
|---|---|---|---|
|
childDomain值
|
childDomainValues | array of DomainValue | |
|
預設使用者類別識別碼
|
defaultUserClassId | integer |
群組的預設使用者類別 ID。 |
|
已刪除
|
deleted | boolean |
指出是否刪除群組。 |
|
網域 ID
|
domainId | integer |
群組所屬網域的 ID。 |
|
電子郵件地址
|
emailAddress | string |
與群組相關聯的電子郵件地址。 |
|
有孩子
|
hasChildren | boolean |
指出群組是否有子項。 |
|
ID
|
id | integer |
群組的識別碼。 |
|
已刪除
|
isDeleted | boolean |
指出是否刪除群組。 |
|
LDAP 識別名稱
|
ldapDistinguishedName | string |
群組的 LDAP 中識別名稱。 |
|
LDAP 設定檔 ID
|
ldapProfileId | integer |
群組的 LDAP 設定檔 ID。 |
|
會員編號
|
memberIds | array of integer |
與群組相關聯的成員識別碼陣列。 |
|
名稱
|
name | string |
群組的名稱。 |
|
原住民受託人
|
nativeTrustee | boolean |
指出群組是否為原生受託人。 |
|
來源參考
|
sourceReference | string |
群組的來源參考。 |
|
User
|
user | boolean |
指出群組是否為使用者。 |
整數
這是基本資料類型「整數」。
字串
這是基本資料類型「string」。