通过

塞洛尼斯 （预览版）

Celonis 平台 API 用于处理知识模型元素，例如记录、KPI、筛选器、触发器及其相关数据。

此连接器在以下产品和区域中可用：

服务 Class 区域
Copilot Studio 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
逻辑应用程序 标准 除以下各项外的所有 逻辑应用区域 ：
     - Azure 政府区域
     - Azure 中国区域
     - 美国国防部（DoD）
Power Apps 高级 除以下各项外的所有 Power Apps 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
Power Automate 高级 除以下各项外的所有 Power Automate 区域 ：
     - 美国政府 （GCC）
     - 美国政府 （GCC High）
     - 由世纪互联运营的中国云
     - 美国国防部（DoD）
联系人​​
Name Celonis 支持
URL https://developer.celonis.com/
Email intelligence-api-feedback-sc@celonis.de
连接器元数据
发布者 Celonis
网站 https://www.celonis.com
隐私策略 https://www.celonis.com/privacy-policy/
类别 人工智能;业务管理

Title

Celonis Intelligence API 允许 Celonis 客户将可作的进程智能嵌入第三方平台，最终用户可以从 Celonis 进程见解中受益。 通过这种方式，它将使 Celonis 的智能（如进程 KPI 或进程效率低下）更接近最终用户，并使运营用户受益，而无需目前访问 Celonis，从而提供有价值的见解，以便在执行日常活动的同时更好地做出决策。 除了数据查询功能外，智能 API 还支持通过允许数据订阅业务触发器将数据推送到第三方平台。

发布者：发布者的名称

Celonis

先决条件

  1. Celonis 平台中的一个团队。
  2. 客户端团队中可用的 知识模型 。
  3. 基于进程的 Celonis 订阅（请联系你的帐户团队进行验证）。

支持的作

当前的 API 方法允许使用者通过提供以下功能与 Celonis 平台中定义的知识模型进行交互：

知识模型发现方法

获取知识模型列表（KM）

获取 KM 记录列表

获取 KM 记录架构详细信息

获取 KM 筛选器列表

知识模型数据检索方法

获取 KM 记录数据的列表

订阅生命周期管理方法

获取订阅列表

获取 KM 触发器列表

创建 KM 触发器的订阅

更新订阅

暂停订阅

恢复订阅

终止订阅

获取凭据

Authentication

对 API 的每个请求都必须使用 Celonis API 密钥进行身份验证。 有两种方法可以执行此作：

使用用户 API 密钥

可以按照我们的 用户 API 密钥指南了解如何创建用户 API 密钥 。 Celonis API 使用持有者令牌身份验证来验证使用者访问权限。 凭据必须在 HTTP 请求的授权标头中发送。 将忽略在请求的 URL 或正文中发送的凭据。 若要使用持有者令牌身份验证进行身份验证，请执行以下作：

  1. 在 Celonis 中创建令牌： MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
  2. 将字符串包含在格式如下的 HTTP 授权标头中：
    Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM

使用应用程序 API 密钥

可以按照 应用程序 API 密钥 指南了解如何创建 AppKey。 若要使用 AppKey 身份验证进行身份验证，请执行以下作：

  1. 在 Celonis 中创建 AppKey：
    MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
  2. 将字符串包含在格式如下的 HTTP 授权标头中：
    Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr

Authorization

必须 设置正确的权限 ，并确保出于授权目的而利用 的用户 API 密钥或应用程序 API 密钥 有权访问包含想要通过智能 API 访问的知识模型（s）的 Celonis 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 平台中定义的知识模型进行交互：

  • 可用知识模型及其详细信息列表
  • 记录列表及其详细信息
  • 筛选器列表
  • 特定记录的数据。 有关 Celonis 开发人员门户的 Celonis 智能 API 功能 的详细信息。

已知问题和限制

速率限制

智能 API 不是为了批量导出 RAW 数据而构建的，而是使来自进程挖掘的计算结果和见解可用于第三方平台和应用程序。 这就是为什么 Celonis API 强制实施速率限制的原因。 这意味着每天只允许一定数量的请求，并且每个调用中可以检索一定数量的记录。 Celonis 保留随时调整速率限制的权利，以确保为所有客户端提供高质量的服务。 如果客户端反复超过速率限制或从事被视为可疑的行为，则 Celonis 保留暂时或永久限制或暂停对该客户端 API 的访问的权利。 当客户端超过每天的请求数时，Celonis API 将返回 429 响应（请求过多），包括 HTTP 标头（），这指示客户端在处理新请求之前需要等待的时间（x-ratelimit-reset以秒为单位）。 以下 HTTP 标头也作为每个调用的一部分返回：

  • x-ratelimit-limit ：表示客户端可在当前时间范围内执行的最大请求数。
  • x-ratelimit-remaining ：当前时间范围内剩余的请求数。 目前，API 具有以下默认限制：

表 1. 默认请求速率限制

| 限制 | 默认值 | |--|--| |最大请求数/天 | 6000 requests/day | |最大请求数/秒 | 20 requests/second | |知识模型中每个请求允许的最大字段数 | 200 fields/request | |调用 /data 终结点时返回的每个请求的最大记录数 | 50 记录/请求 | |可通过终结点检索 /data 的记录总数 |每个筛选/排序表的第一 5.000 条记录 |对触发器的订阅还会强制实施速率限制。 这意味着对于团队，只能创建一定数量的订阅。 此外，无论创建多少个订阅，都可以从 API 向第三方使用者发出的最大事件数。 如果客户端达到最大订阅数，则需要删除现有订阅才能创建新的订阅。 如果客户端达到从 API 发出的最大事件数，则 Celonis Platform 生成的其余数据将被丢弃。 如果客户端正在接近其每日配额，则会通过电子邮件将他们通知给管理员帐户。 超过配额的 80% 时，将发送第一封电子邮件，让管理员帐户知道你超过该百分比。 第二封电子邮件将在配额超过 100% 后立即发送。 目前，API 具有以下默认限制：

表 2. 默认事件速率限制

| 限制 | 默认值 | |--|--| |最大订阅数/团队 | 10 | | |最大事件数/天 | 100,000 |请咨询你的帐户团队，以验证团队的限制。

常见问题解答

请参阅 Celonis 开发人员门户中 的“常见问题 ”部分。

部署说明

必填。 添加有关如何将此连接器部署为自定义连接器的说明。

正在创建连接

连接器支持以下身份验证类型：
默认 用于创建连接的参数。 所有区域 不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。 如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name 类型 Description 必选
团队 字符串 请指定 Celonis 团队。 True
集群 字符串 请指定 Celonis 群集。 True
Authorization securestring 此 API 的授权 True

限制

名称 调用 续订期
每个连接的 API 调用数 100 60 秒

操作

为触发器创建订阅

为触发器创建订阅
取消订阅触发器，删除订阅的所有数据

取消订阅触发器，删除订阅的所有数据
恢复暂停的订阅以再次开始接收事件

恢复暂停的订阅以再次开始接收事件
恢复订阅以开始接收新事件，放弃历史记录事件

恢复暂停的订阅，开始再次接收新事件，放弃历史记录事件
暂停订阅以停止接收事件

暂停订阅以停止接收事件
更新订阅

更新订阅
检索由于订阅失败而未转发下一页的事件

如果由于订阅失败而未转发事件，则检索下一页事件
获取 KM 列表

EMS 团队中定义的知识模型列表
获取 KM 筛选器列表

知识模型的筛选器列表
获取 KM 触发器列表

知识模型的触发器列表
获取 KM 记录数据的列表

知识模型中记录的数据
获取 KM 记录架构的列表

记录架构列表
获取订阅列表

创建的所有订阅的列表
获取顶级 KM 记录架构详细信息

顶级记录架构详细信息
获取顶级 KM 详细信息

EMS 团队中定义的知识模型

为触发器创建订阅

操作 ID:
createSubscription

为触发器创建订阅

参数

名称 密钥 必需 类型 说明
Km Id
 km_id True string

知识模型 ID
触发器 ID
 trigger_id True string

触发器 ID
标题
 headers object

回调标头可能包含身份验证令牌、内容类型等。
协议
 protocol True string

实际可能的唯一值是 HTTPS，这意味着回调 URI 必须是有效的 https
uri
 uri True string

触发触发器后，从智能 API 执行回调的 URI
配置
 configurations array of string

订阅的配置
姓名
 name True string

订阅的名称

返回

response
string

取消订阅触发器，删除订阅的所有数据

操作 ID:
unsubscribe

取消订阅触发器，删除订阅的所有数据

参数

名称 密钥 必需 类型 说明
订阅 ID
 subscription_id True string

将删除订阅 ID

恢复暂停的订阅以再次开始接收事件

操作 ID:
resumeSubscription

恢复暂停的订阅以再次开始接收事件

参数

名称 密钥 必需 类型 说明
订阅 ID
 subscription_id True string

订阅 ID 将恢复并开始再次接收事件

恢复订阅以开始接收新事件，放弃历史记录事件

操作 ID:
resumeSubscriptionNoHistory

恢复暂停的订阅，开始再次接收新事件，放弃历史记录事件

参数

名称 密钥 必需 类型 说明
订阅 ID
 subscription_id True string

订阅 ID 将恢复而不接收传递的事件

暂停订阅以停止接收事件

操作 ID:
pauseSubscription

暂停订阅以停止接收事件

参数

名称 密钥 必需 类型 说明
订阅 ID
 subscription_id True string

订阅 ID 将暂停

更新订阅

操作 ID:
updateSubscription

更新订阅

参数

名称 密钥 必需 类型 说明
订阅 ID
 subscription_id True string

将完全更新的订阅 ID
标题
 headers object

回调标头可能包含身份验证令牌、内容类型等。
协议
 protocol True string

实际可能的唯一值是 HTTPS，这意味着回调 URI 必须是有效的 https
uri
 uri True string

触发触发器后，从智能 API 执行回调的 URI
配置
 configurations array of string

订阅的配置
姓名
 name True string

订阅的名称

检索由于订阅失败而未转发下一页的事件

操作 ID:
nextPageFromRemainingData

如果由于订阅失败而未转发事件，则检索下一页事件

参数

名称 密钥 必需 类型 说明
订阅 ID
 subscription_id True string

将检索发送的失败事件的订阅 ID，最多包含 50 个项目

返回

信号结果页
SignalResultPage

获取 KM 列表

操作 ID:
getKnowledgeModel

EMS 团队中定义的知识模型列表

参数

名称 密钥 必需 类型 说明
页
 page integer

结果的页码，从 0 开始（第一页）
页面大小
 pageSize integer

页中返回的项数。
排序
 sort string

定义要继续执行不区分大小写的排序的策略。 它必须是一个字段，并且应从“+”开始应用 ASC 订单或“-”应用 DESC 顺序。 非前缀将排序为 ASC。 标头中的非现有字段将引发错误

返回

KnowledgeModel 结果页
knowledgeModelResultPage

获取 KM 筛选器列表

操作 ID:
getFilters

知识模型的筛选器列表

参数

名称 密钥 必需 类型 说明
页
 page integer

结果的页码，从 0 开始（第一页）
页面大小
 pageSize integer

页中返回的项数。
排序
 sort string

定义要继续执行不区分大小写的排序的策略。 它必须是一个字段，并且应从“+”开始应用 ASC 订单或“-”应用 DESC 顺序。 非前缀将排序为 ASC。 标头中的非现有字段将引发错误
知识模型 ID
 km_id True string

知识模型 ID

返回

筛选器架构结果页
filterResultPage

获取 KM 触发器列表

操作 ID:
getTriggers

知识模型的触发器列表

参数

名称 密钥 必需 类型 说明
页
 page integer

结果的页码，从 0 开始（第一页）
页面大小
 pageSize integer

页中返回的项数。
排序
 sort string

定义要继续执行不区分大小写的排序的策略。 它必须是一个字段，并且应从“+”开始应用 ASC 订单或“-”应用 DESC 顺序。 非前缀将排序为 ASC。 标头中的非现有字段将引发错误
Km Id
 km_id True string

知识模型 ID

返回

触发器架构结果页
triggerResultPage

获取 KM 记录数据的列表

操作 ID:
getRecordDataResult

知识模型中记录的数据

参数

名称 密钥 必需 类型 说明
知识模型 ID
 km_id True string

知识模型 ID
记录 ID
 record_id True string

记录 ID
过滤 器
 filters array

预定义的筛选器 ID
字段 ID
 fields True array

预定义的筛选器 ID
页
 page integer

结果的页码，从 0 开始（第一页）
页面大小
 pageSize integer

页中返回的项数。
排序
 sort array

定义要继续排序的策略。 它必须是逗号分隔的字段列表，它们应以“+”开头，以应用 ASC 顺序或“-”来应用 DESC 顺序。 没有前缀的字段将排序为 ASC。 标头中的非现有字段将引发错误
筛选表达式
 filterExpr array

动态筛选器表达式

返回

记录数据结果页
recordResultPageDTO

获取 KM 记录架构的列表

操作 ID:
getRecords

记录架构列表

参数

名称 密钥 必需 类型 说明
页
 page integer

结果的页码，从 0 开始（第一页）
页面大小
 pageSize integer

页中返回的项数。
排序
 sort string

定义要继续执行不区分大小写的排序的策略。 它必须是一个字段，并且应从“+”开始应用 ASC 订单或“-”应用 DESC 顺序。 非前缀将排序为 ASC。 标头中的非现有字段将引发错误
知识模型 ID
 km_id True string

知识模型 ID

返回

记录架构结果页
recordSchemaResultPage

获取订阅列表

操作 ID:
getSubscriptions

创建的所有订阅的列表

参数

名称 密钥 必需 类型 说明
页
 page integer

结果的页码，从 0 开始（第一页）
页面大小
 pageSize integer

页中返回的项数。
排序
 sort string

定义要继续执行不区分大小写的排序的策略。 它必须是一个字段，并且应从“+”开始应用 ASC 订单或“-”应用 DESC 顺序。 非前缀将排序为 ASC。 标头中的非现有字段将引发错误

返回

“订阅架构结果”页
subscriptionResultPage

获取顶级 KM 记录架构详细信息

操作 ID:
getRecordDetails

顶级记录架构详细信息

参数

名称 密钥 必需 类型 说明
知识模型 ID
 km_id True string

知识模型 ID
记录 ID
 record_id True string

记录 ID

返回

记录表示知识模型内的概念

记录类型
recordDTO

获取顶级 KM 详细信息

操作 ID:
getKnowledgeModelDetails

EMS 团队中定义的知识模型

参数

名称 密钥 必需 类型 说明
知识模型 ID
 km_id True string

知识模型 ID

返回

知识模型数据的结构

知识模型
knowledgeModelDetailedDTO

定义

SignalResultPage

名称 路径 类型 说明
内容
 content array of signalDTO
pageSize
 pageSize integer

页面大小，由系统定义

filterDTO

在 KM 中应用的筛选器

名称 路径 类型 说明
描述
 description string

人工可理解的筛选器说明
id
 id string

筛选器的唯一标识符
姓名
 name string

人工可理解的筛选器显示名称

filterResultPage

名称 路径 类型 说明
页面
 page integer

页
pageSize
 pageSize integer

页面大小，由 pageSize 参数定义
排序
 sort string

用于对请求的数据应用排序的字段， + 或无符号表示 ASC， - 表示 DESC
总
 total integer

页面中返回的总元素数
内容
 content array of filterDTO

knowledgeModelDetailedDTO

知识模型数据的结构

名称 路径 类型 说明
id
 id string

知识模型的唯一标识符
姓名
 name string

人类可理解的文本
extendedKMId
 extendedKMId string

用作参考的知识库 KM 基础知识模型。

knowledgeModelResultPage

名称 路径 类型 说明
页面
 page integer

页
pageSize
 pageSize integer

页面大小，由 pageSize 参数定义
排序
 sort string

用于对请求的数据应用排序的字段， + 或无符号表示 ASC， - 表示 DESC
总
 total integer

页面中返回的总元素数
内容
 content array of knowledgeModelSimplifiedDTO

knowledgeModelSimplifiedDTO

知识模型数据的结构

名称 路径 类型 说明
id
 id string

知识模型的唯一标识符
姓名
 name string

人类可理解的文本
发表
 published string

最新发布日期

recordDTO

记录表示知识模型内的概念

名称 路径 类型 说明
描述
 description string

记录说明
id
 id string

记录的唯一标识符
姓名
 name string

记录显示名称，人类可理解的名称
fields
 fields array of recordFieldDTO

recordFieldDTO

记录的字段

名称 路径 类型 说明
格式
 format string

要应用的格式
id
 id string

待付款金额
姓名
 name string

人类可理解的名称
类型
 type string
单位
 unit string

添加到字段值的单位

recordIdDTO

记录类型的 ID 和名称

名称 路径 类型 说明
描述
 description string

记录说明
id
 id string

记录的唯一标识符
姓名
 name string

记录显示名称，人类可理解的名称

recordItemDTO

名称 路径 类型 说明
数据
 data array of

记录项列表，具有名称和值的复合
标题
 headers array of recordItemHeaderDTO

recordItemHeaderDTO

名称 路径 类型 说明
聚合
 aggregation boolean

指示字段是否为聚合/计算信息（KPI）。
可过滤的
 filterable boolean

指示是否可以筛选字段。
格式
 format string

格式表达式
id
 id string

字段列表参数和 filterExpression 参数中使用的字段标识
姓名
 name string

人类可理解的文本
可排序
 sortable boolean

指示是否可以对字段进行排序。
类型
 type string

可能的数据类型。
单位
 unit string

格式值视图的互补符号

recordResultPageDTO

名称 路径 类型 说明
页面
 page integer

页
pageSize
 pageSize integer

页面大小，由 pageSize 参数定义
排序
 sort array of string
总
 total integer

页面中返回的总元素数
记录项
 content recordItemDTO

recordSchemaResultPage

名称 路径 类型 说明
页面
 page integer

页
pageSize
 pageSize integer

页面大小，由 pageSize 参数定义
排序
 sort string

用于对请求的数据应用排序的字段， + 或无符号表示 ASC， - 表示 DESC
总
 total integer

页面中返回的总元素数
内容
 content array of recordIdDTO

signalDTO

订阅中存储的信号

名称 路径 类型 说明
signal
 signal string

信号的原始 json
订阅编号
 subscriptionId string

订阅服务器的唯一标识符作为 SUID
triggerId
 triggerId string

触发器的唯一标识符作为 SUID
创建日期
 creationDate date-time

信号创建日期

subscriptionDTO

订阅架构

名称 路径 类型 说明
配置
 configurations array of string

订阅的配置
id
 id string

订阅服务器的唯一标识符作为 SUID
knowledgeModelId
 knowledgeModelId string

知识模型的唯一标识符
latestSucceedEvent
 latestSucceedEvent date-time

上次成功事件的日期
姓名
 name string

人工可理解的订阅名称
状态
 status string
triggerId
 triggerId string

触发器的唯一标识符作为 SUID

subscriptionResultPage

名称 路径 类型 说明
页面
 page integer

页
pageSize
 pageSize integer

页面大小，由 pageSize 参数定义
排序
 sort string

用于对请求的数据应用排序的字段， + 或无符号表示 ASC， - 表示 DESC
总
 total integer

页面中返回的总元素数
内容
 content array of subscriptionDTO

triggerDTO

在 KM 中定义的触发器

名称 路径 类型 说明
id
 id string

触发器的唯一标识符作为 SUID
姓名
 name string

人工可理解的触发器名称
记录
 record string

记录的唯一标识符作为 SUID

triggerResultPage

名称 路径 类型 说明
页面
 page integer

页
pageSize
 pageSize integer

页面大小，由 pageSize 参数定义
排序
 sort string

用于对请求的数据应用排序的字段， + 或无符号表示 ASC， - 表示 DESC
总
 total integer

页面中返回的总元素数
内容
 content array of triggerDTO

字符串

这是基本数据类型“string”。