Celonis （預覽版）

Celonis 平台 API 可處理知識模型元素，例如記錄、KPI、篩選器、觸發器及其相關資料。

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

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

連絡人
名稱	Celonis 支持
URL	https://developer.celonis.com/
Email	intelligence-api-feedback-sc@celonis.de

連接器中繼資料
Publisher	塞洛尼斯
網站	https://www.celonis.com
隱私策略	https://www.celonis.com/privacy-policy/
類別	人工智慧;企業管理

Title

Celonis Intelligence API 允許 Celonis 客戶將可操作的流程智慧嵌入到第三方平台中，最終用戶可以從 Celonis 流程洞察中受益。通過這種方式，它將使流程 KPI 或流程效率低下等 Celonis 情報更接近最終用戶，並通過提供有價值的見解以在執行日常活動時做出更好的決策，使當前無法訪問 Celonis 的運營用戶受益。除了資料查詢功能外，Intelligence API 還支援透過允許第三方平台訂閱業務觸發器，將資料推送到第三方平台。

發行商：出版商名稱

塞洛尼斯

先決條件

Celonis 平台的一個團隊。
客戶團隊中可用的知識模型。
基於流程的 Celonis 訂閱（請聯絡您的客戶團隊進行驗證）。

支援的作業

目前的API方法允許消費者透過提供以下功能與Celonis Platform中定義的知識模型進行互動：

知識模型發現方法

取得知識模型（KM）清單

獲取知識管理記錄列表

取得 KM 記錄結構描述詳細資料

獲取 KM 過濾器列表

知識模型資料檢索方法

獲取 KM 記錄數據列表

訂閱生命週期管理方法

取得訂閱清單

取得知識管理觸發器清單

建立 KM 觸發程式的訂閱

更新訂閱

暫停訂閱

繼續訂閱

終止訂閱

取得憑證

Authentication

對 API 的每個請求都必須使用 Celonis API 金鑰進行身份驗證。有兩種方法可以做到這一點：

使用使用者 API 金鑰

您可以按照我們的使用者 API 金鑰指南瞭解如何建立使用者 API 金鑰。 Celonis API 使用持有人令牌身份驗證來驗證消費者訪問。認證必須在 HTTP 要求的 Authorization 標頭中傳送。在請求的 URL 或本文中發送的認證將被忽略。若要使用持有人權杖驗證進行驗證：

在 Celonis 中創建代幣： MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
在 HTTP 授權標頭中包含字串，格式如下：
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM

使用應用程式 API 金鑰

您可以按照我們的應用程式 API 金鑰指南了解如何建立 AppKey。若要使用 AppKey 驗證進行驗證：

在 Celonis 中建立 AppKey：
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
在 HTTP 授權標頭中包含字串，格式如下：
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr

Authorization

您必須設定正確的權限，並確保用於授權目的的使用者 API 金鑰或應用程式 API 金鑰可以存取包含您想要透過 Intelligence API 存取的知識模型的 Celonis Studio 套件。您可以按照以下步驟授予存取權限：

轉到 Studio 包。
單擊三個點並從彈出菜單中選擇 Permissions 。
搜索用戶（如果您使用的是持有者令牌）或 AppKey（如果您使用的是 AppKey ）並至少 USE PACKAGE 授予權限。

使用者入門

Celonis API 的基本 URL 是要 https://<team>.<cluster>.celonis.cloud/intelligence/api 查找團隊和集群，請檢查您用於訪問 Celonis 平台的 URL，並從中檢索團隊和集群。 Celonis Intelligence API 是一個 JSON API，無論請求是否成功，其端點都將始終返回 JSON 回應。目前的API方法允許消費者透過提供以下功能與Celonis Platform中定義的知識模型進行互動：

可用知識模型及其詳細資料清單
記錄清單及其詳細資料
篩選清單
特定記錄的資料。有關 Celonis Intelligence API 功能的詳細信息，請訪問 Celonis 開發人員門戶。

已知問題和限制

速率限制

Intelligence API 並非為大量匯出原始資料而建置，而是為了將流程採礦的計算結果和見解提供給第三方平台和應用程式。這就是 Celonis API 強制執行速率限制的原因。這表示每天只允許一定數量的請求，並且每次呼叫中可以檢索一定數量的記錄。 Celonis 保留隨時調整費率限制的權利，以確保為所有客戶提供高品質的服務。如果客戶多次超過速率限制或從事被視為可疑的行為，Celonis 保留暫時或永久限制或暫停該客戶對 API 的訪問的權利。當客戶端超過每天的請求數量時，Celonis API 將返回 429 響應（請求過多），包括一個 HTTP 標頭（x-ratelimit-reset），該標頭指示客戶端在處理新請求之前需要等待的時間（以秒為單位）。下列 HTTP 標頭也會在每個呼叫中傳回：

x-ratelimit-limit ：代表用戶端在目前時間範圍內可以執行的要求數目上限。
x-ratelimit-remaining ：目前時間範圍內的剩餘請求數。目前，API 具有下列預設限制：

資料表 1。預設要求速率限制

表 2. 預設事件速率限制

| 限 | 預設值 | |--|--| |每個團隊的訂閱數量上限 | 10 | |每天最多活動數 | 100,000 |請諮詢您的客戶團隊以驗證您團隊的限額。

常見問題

請參閱 Celonis 開發者入口網站中的常見問題部分。

部署指示

必須的。新增如何將此連接器部署為自訂連接器的指示。

正在建立連線

連接器支援下列驗證類型：


預設值	建立連線的參數。	所有區域	不可共享

預設

適用：所有地區

建立連線的參數。

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

名稱	類型	Description	為必填項目
球隊	字串	請註明 Celonis 團隊。	對
Cluster	字串	請指定 Celonis 集群。	對
Authorization	securestring	此 API 的授權	對

節流限制

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

動作

取得 KM 記錄結構描述的清單	記錄結構描述清單
取得最上層 KM 記錄結構描述詳細資料	最上層記錄結構描述詳細資料
取得最上層知識管理詳細資料	在 EMS 小組中定義的知識模型
取得知識管理清單	EMS 小組中定義的知識模型清單
取得知識管理觸發器清單	知識模型的觸發器清單
取得訂閱清單	建立的所有訂閱清單
取消訂閱觸發程序，移除訂閱的所有資料	取消訂閱觸發程序，移除訂閱的所有資料
建立觸發程式的訂用帳戶	建立觸發程式的訂用帳戶
恢復訂閱以開始接收新事件，丟棄歷史記錄事件	恢復暫停的訂閱以再次開始接收新事件，並捨棄歷史記錄事件
擷取由於訂閱失敗而未轉送的下一頁事件	擷取下一頁事件（如果由於訂閱失敗而未轉送事件）
暫停訂閱以停止接收事件	暫停訂閱以停止接收事件
更新訂閱	更新訂閱
獲取 KM 記錄數據列表	知識模型中記錄的資料
獲取 KM 過濾器列表	知識模型的篩選清單
繼續暫停的訂閱，以再次開始接收事件	繼續暫停的訂閱，以再次開始接收事件

取得 KM 記錄結構描述的清單

作業識別碼：: getRecords

記錄結構描述清單

參數

名稱	機碼	必要	類型	Description
頁面	page		integer	結果的頁碼，從 0 開始（第一頁）
頁面大小	pageSize		integer	頁面中傳回的項目數。
排序	sort		string	定義不區分大小寫排序的策略。它必須只是一個欄位，而且應該以「+」開頭以套用 ASC 順序，或以「-」開頭以套用 DESC 順序。非前置詞將排序為 ASC。標頭中不存在的欄位會擲回錯誤
知識模型識別碼	km_id	True	string	知識模型識別碼

傳回

記錄結構描述結果頁面: recordSchemaResultPage

取得最上層 KM 記錄結構描述詳細資料

作業識別碼：: getRecordDetails

最上層記錄結構描述詳細資料

參數

名稱	機碼	必要	類型	Description
知識模型識別碼	km_id	True	string	知識模型識別碼
記錄識別碼	record_id	True	string	記錄識別碼

傳回

記錄代表知識模型內的概念

記錄類型: recordDTO

取得最上層知識管理詳細資料

作業識別碼：: getKnowledgeModelDetails

在 EMS 小組中定義的知識模型

參數

名稱	機碼	必要	類型	Description
知識模型識別碼	km_id	True	string	知識模型識別碼

傳回

知識模型資料的結構

知識模型: knowledgeModelDetailedDTO

取得知識管理清單

作業識別碼：: getKnowledgeModel

EMS 小組中定義的知識模型清單

參數

名稱	機碼	類型	Description
頁面	page	integer	結果的頁碼，從 0 開始（第一頁）
頁面大小	pageSize	integer	頁面中傳回的項目數。
排序	sort	string	定義不區分大小寫排序的策略。它必須只是一個欄位，而且應該以「+」開頭以套用 ASC 順序，或以「-」開頭以套用 DESC 順序。非前置詞將排序為 ASC。標頭中不存在的欄位會擲回錯誤

傳回

KnowledgeModel 結果頁面: knowledgeModelResultPage

取得知識管理觸發器清單

作業識別碼：: getTriggers

知識模型的觸發器清單

參數

名稱	機碼	必要	類型	Description
頁面	page		integer	結果的頁碼，從 0 開始（第一頁）
頁面大小	pageSize		integer	頁面中傳回的項目數。
排序	sort		string	定義不區分大小寫排序的策略。它必須只是一個欄位，而且應該以「+」開頭以套用 ASC 順序，或以「-」開頭以套用 DESC 順序。非前置詞將排序為 ASC。標頭中不存在的欄位會擲回錯誤
公里編號	km_id	True	string	知識模型識別碼

傳回

觸發結構描述結果頁面: triggerResultPage

取得訂閱清單

作業識別碼：: getSubscriptions

建立的所有訂閱清單

參數

名稱	機碼	類型	Description
頁面	page	integer	結果的頁碼，從 0 開始（第一頁）
頁面大小	pageSize	integer	頁面中傳回的項目數。
排序	sort	string	定義不區分大小寫排序的策略。它必須只是一個欄位，而且應該以「+」開頭以套用 ASC 順序，或以「-」開頭以套用 DESC 順序。非前置詞將排序為 ASC。標頭中不存在的欄位會擲回錯誤

傳回

訂閱結構描述結果頁面: subscriptionResultPage

取消訂閱觸發程序，移除訂閱的所有資料

作業識別碼：: unsubscribe

取消訂閱觸發程序，移除訂閱的所有資料

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscription_id	True	string	訂閱標識碼將會被刪除

建立觸發程式的訂用帳戶

作業識別碼：: createSubscription

建立觸發程式的訂用帳戶

參數

名稱	機碼	必要	類型	Description
公里編號	km_id	True	string	知識模型識別碼
觸發程式識別碼	trigger_id	True	string	觸發器 ID
headers	headers		object	回呼標頭可能包含身份驗證令牌、內容類型等。
通訊協定	protocol	True	string	實際上唯一可能的值是 HTTPS，這意味著回調 URI 必須是有效的 https
統一資源識別碼 (URI)	uri	True	string	觸發程式觸發程式後，從 Intelligence API 執行回呼的 Uri
組態	configurations		array of string	訂閱的設定
名稱	name	True	string	訂用帳戶的名稱

傳回

response: string

恢復訂閱以開始接收新事件，丟棄歷史記錄事件

作業識別碼：: resumeSubscriptionNoHistory

恢復暫停的訂閱以再次開始接收新事件，並捨棄歷史記錄事件

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscription_id	True	string	訂用帳戶識別碼將會繼續，而不會收到傳遞的事件

擷取由於訂閱失敗而未轉送的下一頁事件

作業識別碼：: nextPageFromRemainingData

擷取下一頁事件（如果由於訂閱失敗而未轉送事件）

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscription_id	True	string	將擷取傳送的失敗事件的訂用帳戶識別碼，最多 50 個項目

傳回

訊號結果頁面: SignalResultPage

暫停訂閱以停止接收事件

作業識別碼：: pauseSubscription

暫停訂閱以停止接收事件

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscription_id	True	string	訂閱標識碼將會暫停

更新訂閱

作業識別碼：: updateSubscription

更新訂閱

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscription_id	True	string	將完全更新的訂閱標識碼
headers	headers		object	回呼標頭可能包含身份驗證令牌、內容類型等。
通訊協定	protocol	True	string	實際上唯一可能的值是 HTTPS，這意味著回調 URI 必須是有效的 https
統一資源識別碼 (URI)	uri	True	string	觸發程式觸發程式後，從 Intelligence API 執行回呼的 Uri
組態	configurations		array of string	訂閱的設定
名稱	name	True	string	訂用帳戶的名稱

獲取 KM 記錄數據列表

作業識別碼：: getRecordDataResult

知識模型中記錄的資料

參數

名稱	機碼	必要	類型	Description
知識模型識別碼	km_id	True	string	知識模型識別碼
記錄識別碼	record_id	True	string	記錄識別碼
篩選	filters		array	預先定義的篩選器識別碼
欄位識別碼	fields	True	array	預先定義的篩選器識別碼
頁面	page		integer	結果的頁碼，從 0 開始（第一頁）
頁面大小	pageSize		integer	頁面中傳回的項目數。
排序	sort		array	定義繼續排序的策略。它必須是逗號分隔的欄位清單，且應以「+」開頭以套用 ASC 順序，或以「-」開頭以套用 DESC 順序。沒有前綴的欄位將排序為 ASC。標頭中不存在的欄位會擲回錯誤
篩選運算式	filterExpr		array	動態篩選運算式

傳回

記錄資料結果頁面: recordResultPageDTO

獲取 KM 過濾器列表

作業識別碼：: getFilters

知識模型的篩選清單

參數

名稱	機碼	必要	類型	Description
頁面	page		integer	結果的頁碼，從 0 開始（第一頁）
頁面大小	pageSize		integer	頁面中傳回的項目數。
排序	sort		string	定義不區分大小寫排序的策略。它必須只是一個欄位，而且應該以「+」開頭以套用 ASC 順序，或以「-」開頭以套用 DESC 順序。非前置詞將排序為 ASC。標頭中不存在的欄位會擲回錯誤
知識模型識別碼	km_id	True	string	知識模型識別碼

傳回

篩選結構描述結果頁面: filterResultPage

繼續暫停的訂閱，以再次開始接收事件

作業識別碼：: resumeSubscription

繼續暫停的訂閱，以再次開始接收事件

參數

名稱	機碼	必要	類型	Description
訂用帳戶識別碼	subscription_id	True	string	訂用帳戶識別碼將會繼續，並再次開始接收事件

定義

訊號結果頁面

名稱	路徑	類型	Description
內容	content	array of signalDTO
pageSize	pageSize	integer	頁面大小，由系統定義

過濾DTO

在知識管理中應用的篩選器

名稱	路徑	類型	Description
描述	description	string	人類可理解的過濾器描述
識別碼	id	string	篩選器的唯一識別碼
名稱	name	string	人類可理解的篩選器顯示名稱

filterResultPage

名稱	路徑	類型	Description
頁面	page	integer	頁面
pageSize	pageSize	integer	頁面大小，由 pageSize 參數定義
排序	sort	string	用於對請求資料套用排序的欄位，+ 或無符號表示 ASC，- 表示 DESC
總計	total	integer	頁面中傳回的元素總數
內容	content	array of filterDTO

knowledgeModelDetailedDTO

知識模型資料的結構

名稱	路徑	類型	Description
識別碼	id	string	知識模型的唯一標識符
名稱	name	string	人類可理解的文字
extendedKMId	extendedKMId	string	知識模型作為參考，知識管理基礎。

knowledgeModel結果頁面

名稱	路徑	類型	Description
頁面	page	integer	頁面
pageSize	pageSize	integer	頁面大小，由 pageSize 參數定義
排序	sort	string	用於對請求資料套用排序的欄位，+ 或無符號表示 ASC，- 表示 DESC
總計	total	integer	頁面中傳回的元素總數
內容	content	array of knowledgeModelSimplifiedDTO

knowledgeModelSimplifiedDTO

知識模型資料的結構

名稱	路徑	類型	Description
識別碼	id	string	知識模型的唯一標識符
名稱	name	string	人類可理解的文字
發表	published	string	最新發布日期

記錄DTO

記錄代表知識模型內的概念

名稱	路徑	類型	Description
描述	description	string	記錄說明
識別碼	id	string	記錄的唯一識別碼
名稱	name	string	記錄顯示名稱，人類可理解的名稱
fields	fields	array of recordFieldDTO

記錄欄位DTO

記錄的欄位

名稱	路徑	類型	Description
format	format	string	要套用的格式
識別碼	id	string	待支付金額
名稱	name	string	人類可理解的名稱
型別	type	string
單位	unit	string	新增至欄位值的單位

recordIdDTO

記錄類型的識別碼和名稱

名稱	路徑	類型	Description
描述	description	string	記錄說明
識別碼	id	string	記錄的唯一識別碼
名稱	name	string	記錄顯示名稱，人類可理解的名稱

recordItemDTO

名稱	路徑	類型	Description
資料	data	array of	記錄項目清單，具有名稱和值的複合
headers	headers	array of recordItemHeaderDTO

recordItemHeaderDTO

名稱	路徑	類型	Description
彙總	aggregation	boolean	指出欄位是否為彙總/計算資訊（KPI）。
filterable	filterable	boolean	指出是否可以篩選欄位。
format	format	string	格式運算式
識別碼	id	string	要在欄位清單 param 和 filterExpression param 中使用的欄位身分識別
名稱	name	string	人類可理解的文字
sortable	sortable	boolean	指出欄位是否可以排序。
型別	type	string	可能的資料類型。
單位	unit	string	格式值檢視的互補符號

recordResultPageDTO

名稱	路徑	類型	Description
頁面	page	integer	頁面
pageSize	pageSize	integer	頁面大小，由 pageSize 參數定義
排序	sort	array of string
總計	total	integer	頁面中傳回的元素總數
記錄項目	content	recordItemDTO

recordSchemaResultPage

名稱	路徑	類型	Description
頁面	page	integer	頁面
pageSize	pageSize	integer	頁面大小，由 pageSize 參數定義
排序	sort	string	用於對請求資料套用排序的欄位，+ 或無符號表示 ASC，- 表示 DESC
總計	total	integer	頁面中傳回的元素總數
內容	content	array of recordIdDTO

信號DTO

訂閱時儲存的訊號

名稱	路徑	類型	Description
signal	signal	string	訊號的原始json
subscriptionId	subscriptionId	string	訂閱者的唯一識別碼作為 SUID
觸發標識	triggerId	string	觸發器的唯一識別碼作為 SUID
創建日期	creationDate	date-time	信號創建日期

訂閱DTO

訂用帳戶結構描述

名稱	路徑	類型	Description
組態	configurations	array of string	訂閱的設定
識別碼	id	string	訂閱者的唯一識別碼作為 SUID
knowledgeModelId	knowledgeModelId	string	知識模型的唯一標識符
latestSucceedEvent	latestSucceedEvent	date-time	上次成功事件的日期
名稱	name	string	人類可理解的訂閱名稱
狀態	status	string
觸發標識	triggerId	string	觸發器的唯一識別碼作為 SUID

訂閱結果頁面

名稱	路徑	類型	Description
頁面	page	integer	頁面
pageSize	pageSize	integer	頁面大小，由 pageSize 參數定義
排序	sort	string	用於對請求資料套用排序的欄位，+ 或無符號表示 ASC，- 表示 DESC
總計	total	integer	頁面中傳回的元素總數
內容	content	array of subscriptionDTO

觸發DTO

在 KM 定義的觸發程序

名稱	路徑	類型	Description
識別碼	id	string	觸發器的唯一識別碼作為 SUID
名稱	name	string	人類可理解的觸發器名稱
資料列	record	string	記錄的唯一識別碼作為 SUID

觸發結果頁面

名稱	路徑	類型	Description
頁面	page	integer	頁面
pageSize	pageSize	integer	頁面大小，由 pageSize 參數定義
排序	sort	string	用於對請求資料套用排序的欄位，+ 或無符號表示 ASC，- 表示 DESC
總計	total	integer	頁面中傳回的元素總數
內容	content	array of triggerDTO

字串

這是基本資料類型「string」。

共用方式為

Celonis （預覽版）

Title

發行商：出版商名稱

先決條件

支援的作業

知識模型發現方法

知識模型資料檢索方法

訂閱生命週期管理方法

取得憑證

Authentication

使用使用者 API 金鑰

使用應用程式 API 金鑰

Authorization

使用者入門

已知問題和限制

速率限制

資料表 1。 預設要求速率限制

表 2. 預設事件速率限制

常見問題

部署指示

正在建立連線

預設

節流限制

動作

取得 KM 記錄結構描述的清單

參數

傳回

取得最上層 KM 記錄結構描述詳細資料

參數

傳回

取得最上層知識管理詳細資料

參數

傳回

取得知識管理清單

參數

傳回

取得知識管理觸發器清單

參數

傳回

取得訂閱清單

參數

傳回

取消訂閱觸發程序，移除訂閱的所有資料

參數

建立觸發程式的訂用帳戶

參數

傳回

恢復訂閱以開始接收新事件，丟棄歷史記錄事件

參數

擷取由於訂閱失敗而未轉送的下一頁事件

參數

傳回

暫停訂閱以停止接收事件

參數

更新訂閱

參數

獲取 KM 記錄數據列表

參數

傳回

獲取 KM 過濾器列表

參數

傳回

繼續暫停的訂閱，以再次開始接收事件

參數

定義

訊號結果頁面

過濾DTO

filterResultPage

knowledgeModelDetailedDTO

knowledgeModel結果頁面

knowledgeModelSimplifiedDTO

記錄DTO

記錄欄位DTO

recordIdDTO

recordItemDTO

recordItemHeaderDTO

recordResultPageDTO

recordSchemaResultPage

信號DTO

資料表 1。預設要求速率限制