Celonis (プレビュー)
Celonis Platform API を使用して、レコード、KPI、フィルター、トリガー、関連データなどのナレッジ モデル要素を操作します。
このコネクタは、次の製品とリージョンで使用できます。
| サービス | クラス | リージョン |
|---|---|---|
| コピロット スタジオ | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| ロジック アプリ | Standard | 次を除くすべての Logic Apps リージョン : - Azure Government リージョン - Azure China リージョン - 米国国防総省 (DoD) |
| Power Apps | Premium | 次を除くすべての Power Apps リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| Power Automate | Premium | 次を除くすべての Power Automate リージョン : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運営する China Cloud - 米国国防総省 (DoD) |
| お問い合わせ | |
|---|---|
| 名前 | Celonis のサポート |
| URL | https://developer.celonis.com/ |
| intelligence-api-feedback-sc@celonis.de |
| コネクタ メタデータ | |
|---|---|
| Publisher | Celonis |
| Website | https://www.celonis.com |
| プライバシー ポリシー | https://www.celonis.com/privacy-policy/ |
| カテゴリ | 人工知能;ビジネス管理 |
Title
Celonis Intelligence API を使用すると、Celonis のお客様は、エンド ユーザーが Celonis プロセスの分析情報を活用できるサードパーティのプラットフォームに、実用的なプロセス インテリジェンスを埋め込むことができます。 この方法では、プロセス KPI やプロセス非効率性などの Celonis インテリジェンスをエンド ユーザーに近づけ、日常のアクティビティを実行しながら意思決定を改善するための貴重な分析情報を提供することで、Celonis への現在のアクセスなしで運用ユーザーに利益をもたらします。 データ クエリ機能とは別に、Intelligence API では、ビジネス トリガーをサブスクライブできるようにすることで、サード パーティプラットフォームへのデータのプッシュもサポートしています。
発行元: パブリッシャーの名前
[前提条件]
- Celonis Platform のチーム。
- クライアントのチームで使用できる ナレッジ モデル 。
- プロセスベースの Celonis サブスクリプション (アカウント チームに問い合わせて確認してください)。
サポートされている操作
現在の API メソッドを使用すると、コンシューマーは次の機能を提供することで、Celonis Platform で定義されているナレッジ モデルと対話できます。
ナレッジ モデルの検出方法
ナレッジ モデル (KM) の一覧を取得する
KM レコードの一覧を取得する
KM レコード スキーマの詳細を取得する
KM フィルターの一覧を取得する
ナレッジ モデルのデータ取得方法
KM レコード データの一覧を取得する
サブスクリプション ライフサイクル管理方法
サブスクリプションの一覧を取得する
KM トリガーの一覧を取得する
KM トリガーへのサブスクリプションを作成する
サブスクリプションを更新する
サブスクリプションを一時停止する
サブスクリプションを再開する
サブスクリプションを終了する
資格情報の取得
Authentication
API に対する各要求は、Celonis API キーを使用して認証する必要があります。 これを行うには、次の 2 つの方法があります。
ユーザー API キーの使用
ユーザー API キーガイドに従って、ユーザー API キー を作成する方法を確認できます。 Celonis API は、コンシューマー アクセスの検証にベアラー トークン認証を使用します。 資格情報は、HTTP 要求の Authorization ヘッダーで送信する必要があります。 要求の URL または本文で送信された資格情報は無視されます。 ベアラー トークン認証を使用して認証するには:
- Celonis でトークンを作成します。
MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM - 次のように書式設定された HTTP Authorization ヘッダーに文字列を含めます。
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
アプリケーション API キーの使用
AppKey を作成する方法については、 アプリケーション API キー ガイドに従ってください。 AppKey 認証を使用して認証するには:
- Celonis で AppKey を作成します。
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr - 次のように書式設定された HTTP Authorization ヘッダーに文字列を含めます。
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
Authorization
適切なアクセス許可を設定し、承認目的で利用されるユーザー API キーまたはアプリケーション API キーが、Intelligence API を介してアクセスするナレッジ モデルを含む Celonis Studio パッケージにアクセスできることを確認する必要があります。 次の手順に従って、アクセス許可を付与できます。
- Studio パッケージに移動します。
- 3 つのドットをクリックし、ポップアップ メニューから
Permissionsを選択します。 - ユーザー ( ベアラー トークン を使用している場合) または AppKey ( AppKey を使用している場合) を検索し、少なくとも
USE PACKAGE権限を付与します。
はじめに
Celonis API のベース URL は https://<team>.<cluster>.celonis.cloud/intelligence/api チームとクラスターを見つけるには、Celonis Platform へのアクセスに使用する URL を確認し、そこからチームとクラスターを取得してください。
Celonis Intelligence API は JSON API であり、そのエンドポイントは要求の成功に関係なく、常に JSON 応答を返します。
現在の API メソッドを使用すると、コンシューマーは次の機能を提供することで、Celonis Platform で定義されているナレッジ モデルと対話できます。
- 使用可能なナレッジ モデルとその詳細の一覧
- レコードとその詳細の一覧
- フィルターの一覧
- 特定のレコードのデータ。 Celonis 開発者ポータルの Celonis Intelligence API 機能 の詳細。
既知の問題と制限事項
レート制限
Intelligence API は、RAW データを一括エクスポートするのではなく、プロセス マイニングから計算された結果と分析情報をサード パーティのプラットフォームやアプリケーションで使用できるように構築されました。 そのため、Celonis API ではレート制限が適用されます。 つまり、1 日あたり特定の数の要求のみが許可され、各呼び出しで特定の数のレコードを取得できます。 Celonisは、すべてのクライアントに高品質のサービスを保証するために、いつでもレート制限を調整する権利を留保します。
クライアントがレート制限を繰り返し超えたり、疑わしいと見なされる動作に関与したりする場合、Celonis は、そのクライアントの API へのアクセスを一時的または永続的に制限または中断する権利を留保します。
クライアントが 1 日あたりの要求数を超えると、Celonis API は HTTP ヘッダー (x-ratelimit-reset) を含む 429 応答 (要求が多すぎます) を返します。これは、クライアントが新しい要求を処理するまでに待機する必要がある時間 (秒単位) を示します。
次の HTTP ヘッダーも、各呼び出しの一部として返されます。
-
x-ratelimit-limit: クライアントが現在の時間枠で実行できる要求の最大数を表します。 -
x-ratelimit-remaining: 現在の時間枠内の残りの要求の数。 現時点では、API には次の既定の制限があります。
表 1. 既定の要求レート制限
|
制限 | 既定値 | |--|---| |最大要求数/日 | 6000 要求数/日 | |最大要求数/秒 | 20 要求/秒 |ナレッジ モデルの要求ごとに許可されるフィールドの最大数 |フィールド/要求の 200 | /data エンドポイントを呼び出すときに返される要求あたりのレコードの最大数 | 50 レコード/要求 | | /data エンドポイントを介して取得できるレコードの合計数 |フィルター処理/並べ替えられたテーブルごとの最初の 5.000 レコード |トリガーのサブスクリプションでもレート制限が適用されます。 つまり、チームの場合、特定の数のサブスクリプションのみを作成できます。 さらに、作成されたサブスクリプションの数に関係なく、API からサード パーティのコンシューマーに出力できるイベントの最大数があります。
クライアントがサブスクリプションの最大数に達した場合、新しいサブスクリプションを作成するには、既存のサブスクリプションを削除する必要があります。
クライアントが API から生成されたイベントの最大数に達すると、Celonis Platform によって生成された残りのデータは破棄されます。
クライアントが 1 日のクォータに近づいている場合は、管理者アカウントに電子メールで通知されます。 クォータの 80% を超えると、最初のメールが送信され、その割合を超えていると管理者アカウントに通知されます。 2 番目の電子メールは、クォータの 100% を超えるとすぐに送信されます。
現時点では、API には次の既定の制限があります。
表 2. 既定のイベント レート制限
|
制限 | 既定値 | |--|---| |サブスクリプション/チームの最大数 | 10 |イベント/日の最大数 | 100,000 |アカウント チームに問い合わせて、チームの制限を確認してください。
よく寄せられる質問
Celonis 開発者ポータルの「 よく寄せられる質問 」セクションを参照してください。
デプロイ手順
必須。 このコネクタをカスタム コネクタとしてデプロイする方法に関する手順を追加します。
接続を作成する
コネクタでは、次の認証の種類がサポートされています。
| デフォルト | 接続を作成するためのパラメーター。 | すべてのリージョン | 共有不可 |
デフォルト
適用対象: すべてのリージョン
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 電源アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名前 | タイプ | Description | 必須 |
|---|---|---|---|
| チーム | 文字列 | セロニス チームを指定してください。 | 正しい |
| クラスター | 文字列 | Celonis クラスターを指定してください。 | 正しい |
| Authorization | securestring | この API の承認 | 正しい |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| KM トリガーの一覧を取得する |
ナレッジ モデルのトリガーの一覧 |
| KM フィルターの一覧を取得する |
ナレッジ モデルのフィルターの一覧 |
| KM レコード スキーマの一覧を取得する |
レコード スキーマの一覧 |
| KM レコード データの一覧を取得する |
ナレッジ モデル内のレコードのデータ |
| VM の一覧を取得する |
EMS チームで定義されているナレッジ モデルの一覧 |
| サブスクリプションが失敗したために転送されなかったイベントの次のページを取得します |
サブスクリプションが失敗したために転送されなかった場合は、イベントの次のページを取得します。 |
| サブスクリプションのすべてのデータを削除するトリガーの登録を解除する |
サブスクリプションのすべてのデータを削除するトリガーの登録を解除する |
| サブスクリプションの一覧を取得する |
作成されたすべてのサブスクリプションの一覧 |
| サブスクリプションを一時停止してイベントの受信を停止します |
サブスクリプションを一時停止してイベントの受信を停止します |
| サブスクリプションを再開して新しいイベントの受信を開始し、履歴イベントを破棄します |
一時停止されたサブスクリプションを再開して新しいイベントの受信を再開し、履歴イベントを破棄します |
| サブスクリプションを更新する |
サブスクリプションを更新する |
| トリガーのサブスクリプションを作成します |
トリガーのサブスクリプションを作成します |
| 一時停止されたサブスクリプションを再開して、イベントの受信を再開します |
一時停止されたサブスクリプションを再開して、イベントの受信を再開します |
| 最上位レベルの KM の詳細を取得する |
EMS チームで定義されているナレッジ モデル |
| 最上位レベルの KM レコード スキーマの詳細を取得する |
最上位レベルのレコード スキーマの詳細 |
KM トリガーの一覧を取得する
ナレッジ モデルのトリガーの一覧
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
0 から始まる結果のページ番号 (最初のページ) |
|
|
ページ サイズ
|
pageSize | integer |
ページで返されるアイテムの数。 |
|
|
ソート
|
sort | string |
大文字と小文字を区別しない並べ替えを続行する方法を定義します。 フィールドは 1 つだけで、ASC 順序を適用するには "+" で始める必要があります。DESC 順序を適用するには "-" で始まる必要があります。 プレフィックス以外は ASC として並べ替えられます。 ヘッダーに存在しないフィールドがエラーをスローする |
|
|
Km Id
|
km_id | True | string |
ナレッジ モデル ID |
戻り値
- トリガー スキーマの結果ページ
- triggerResultPage
KM フィルターの一覧を取得する
ナレッジ モデルのフィルターの一覧
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
0 から始まる結果のページ番号 (最初のページ) |
|
|
ページ サイズ
|
pageSize | integer |
ページで返されるアイテムの数。 |
|
|
並べ替え
|
sort | string |
大文字と小文字を区別しない並べ替えを続行する方法を定義します。 フィールドは 1 つだけで、ASC 順序を適用するには "+" で始める必要があります。DESC 順序を適用するには "-" で始まる必要があります。 プレフィックス以外は ASC として並べ替えられます。 ヘッダーに存在しないフィールドがエラーをスローする |
|
|
ナレッジ モデル ID
|
km_id | True | string |
ナレッジ モデル ID |
戻り値
- フィルター スキーマの結果ページ
- filterResultPage
KM レコード スキーマの一覧を取得する
レコード スキーマの一覧
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
0 から始まる結果のページ番号 (最初のページ) |
|
|
ページ サイズ
|
pageSize | integer |
ページで返されるアイテムの数。 |
|
|
並べ替え
|
sort | string |
大文字と小文字を区別しない並べ替えを続行する方法を定義します。 フィールドは 1 つだけで、ASC 順序を適用するには "+" で始める必要があります。DESC 順序を適用するには "-" で始まる必要があります。 プレフィックス以外は ASC として並べ替えられます。 ヘッダーに存在しないフィールドがエラーをスローする |
|
|
ナレッジ モデル ID
|
km_id | True | string |
ナレッジ モデル ID |
戻り値
- レコード スキーマの結果ページ
- recordSchemaResultPage
KM レコード データの一覧を取得する
ナレッジ モデル内のレコードのデータ
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ナレッジ モデル 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
VM の一覧を取得する
EMS チームで定義されているナレッジ モデルの一覧
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
0 から始まる結果のページ番号 (最初のページ) |
|
|
ページ サイズ
|
pageSize | integer |
ページで返されるアイテムの数。 |
|
|
並べ替え
|
sort | string |
大文字と小文字を区別しない並べ替えを続行する方法を定義します。 フィールドは 1 つだけで、ASC 順序を適用するには "+" で始める必要があります。DESC 順序を適用するには "-" で始まる必要があります。 プレフィックス以外は ASC として並べ替えられます。 ヘッダーに存在しないフィールドがエラーをスローする |
戻り値
- KnowledgeModel の結果ページ
- knowledgeModelResultPage
サブスクリプションが失敗したために転送されなかったイベントの次のページを取得します
サブスクリプションが失敗したために転送されなかった場合は、イベントの次のページを取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サブスクリプション ID
|
subscription_id | True | string |
送信された失敗したイベントを取得するサブスクリプション ID (最大 50 項目) |
戻り値
- シグナル結果ページ
- SignalResultPage
サブスクリプションのすべてのデータを削除するトリガーの登録を解除する
サブスクリプションのすべてのデータを削除するトリガーの登録を解除する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サブスクリプション ID
|
subscription_id | True | string |
サブスクリプション ID が削除されます |
サブスクリプションの一覧を取得する
作成されたすべてのサブスクリプションの一覧
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ページ
|
page | integer |
0 から始まる結果のページ番号 (最初のページ) |
|
|
ページ サイズ
|
pageSize | integer |
ページで返されるアイテムの数。 |
|
|
ソート
|
sort | string |
大文字と小文字を区別しない並べ替えを続行する方法を定義します。 フィールドは 1 つだけで、ASC 順序を適用するには "+" で始める必要があります。DESC 順序を適用するには "-" で始まる必要があります。 プレフィックス以外は ASC として並べ替えられます。 ヘッダーに存在しないフィールドがエラーをスローする |
戻り値
- サブスクリプション スキーマの結果ページ
- subscriptionResultPage
サブスクリプションを一時停止してイベントの受信を停止します
サブスクリプションを一時停止してイベントの受信を停止します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サブスクリプション ID
|
subscription_id | True | string |
サブスクリプション ID が一時停止されます |
サブスクリプションを再開して新しいイベントの受信を開始し、履歴イベントを破棄します
一時停止されたサブスクリプションを再開して新しいイベントの受信を再開し、履歴イベントを破棄します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サブスクリプション ID
|
subscription_id | True | string |
サブスクリプション ID は、渡されたイベントを受信せずに再開されます |
サブスクリプションを更新する
サブスクリプションを更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サブスクリプション ID
|
subscription_id | True | string |
完全に更新されるサブスクリプション ID |
|
headers
|
headers | object |
コールバック ヘッダーには、認証トークン、コンテンツ タイプなどを含めることができます。 |
|
|
プロトコル
|
protocol | True | string |
実際に可能な値は HTTPS のみです。つまり、コールバック URI は有効な https である必要があります |
|
URI
|
uri | True | string |
トリガーが発生した後に Intelligence API からのコールバックを実行する URI |
|
configuration
|
configurations | array of string |
サブスクリプションの構成 |
|
|
名前
|
name | True | string |
サブスクリプションの名前 |
トリガーのサブスクリプションを作成します
トリガーのサブスクリプションを作成します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Km Id
|
km_id | True | string |
ナレッジ モデル ID |
|
トリガー ID
|
trigger_id | True | string |
トリガー ID |
|
headers
|
headers | object |
コールバック ヘッダーには、認証トークン、コンテンツ タイプなどを含めることができます。 |
|
|
プロトコル
|
protocol | True | string |
実際に可能な値は HTTPS のみです。つまり、コールバック URI は有効な https である必要があります |
|
URI
|
uri | True | string |
トリガーが発生した後に Intelligence API からのコールバックを実行する URI |
|
configuration
|
configurations | array of string |
サブスクリプションの構成 |
|
|
名前
|
name | True | string |
サブスクリプションの名前 |
戻り値
- response
- string
一時停止されたサブスクリプションを再開して、イベントの受信を再開します
一時停止されたサブスクリプションを再開して、イベントの受信を再開します
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
サブスクリプション ID
|
subscription_id | True | string |
サブスクリプション ID が再開され、イベントの受信が再開されます |
最上位レベルの KM の詳細を取得する
EMS チームで定義されているナレッジ モデル
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ナレッジ モデル ID
|
km_id | True | string |
ナレッジ モデル ID |
戻り値
ナレッジ モデル データの構造
- ナレッジ モデル
- knowledgeModelDetailedDTO
最上位レベルの KM レコード スキーマの詳細を取得する
最上位レベルのレコード スキーマの詳細
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ナレッジ モデル ID
|
km_id | True | string |
ナレッジ モデル ID |
|
レコード ID
|
record_id | True | string |
レコード ID |
戻り値
レコードはナレッジ モデル内の概念を表します
- レコードの種類
- recordDTO
定義
SignalResultPage
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
コンテンツ
|
content | array of signalDTO | |
|
pageSize
|
pageSize | integer |
システムによって定義されるページ サイズ |
filterDTO
KM で適用するフィルター
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
説明
|
description | string |
人間が理解できるフィルターの説明 |
|
id
|
id | string |
フィルターの一意識別子 |
|
名前
|
name | string |
人間が理解できるフィルターの表示名 |
filterResultPage
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
page
|
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
|
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
|
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
|
headers | array of recordItemHeaderDTO |
recordItemHeaderDTO
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
集計
|
aggregation | boolean |
フィールドが集計/計算情報 (KPI) であるかどうかを示します。 |
|
filterable
|
filterable | boolean |
フィールドをフィルター処理できるかどうかを示します。 |
|
format
|
format | string |
Format 式 |
|
id
|
id | string |
フィールド リストパラメーターと filterExpression パラメーターで使用するフィールド ID |
|
名前
|
name | string |
人間が理解できるテキスト |
|
ソート可能
|
sortable | boolean |
フィールドを並べ替えることができるかどうかを示します。 |
|
型
|
type | string |
使用できるデータ型。 |
|
ユニット
|
unit | string |
書式値ビューの補完的な記号 |
recordResultPageDTO
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
page
|
page | integer |
ページ |
|
pageSize
|
pageSize | integer |
pageSize パラメーターで定義されたページ サイズ |
|
並べ替え
|
sort | array of string | |
|
トータル
|
total | integer |
ページに返される要素の合計数 |
|
レコード アイテム
|
content | recordItemDTO |
recordSchemaResultPage
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
page
|
page | integer |
ページ |
|
pageSize
|
pageSize | integer |
pageSize パラメーターで定義されたページ サイズ |
|
並べ替え
|
sort | string |
要求されたデータに並べ替えを適用するために使用されるフィールド。+またはシンボルなしは ASC を意味し、- DESC を意味します |
|
トータル
|
total | integer |
ページに返される要素の合計数 |
|
コンテンツ
|
content | array of recordIdDTO |
signalDTO
サブスクリプションに格納されているシグナル
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
signal
|
signal | string |
シグナルの生 JSON |
|
subscriptionId
|
subscriptionId | string |
サブスクライバーの SUID としての一意識別子 |
|
triggerId
|
triggerId | string |
SUID としてのトリガーの一意識別子 |
|
作成日
|
creationDate | date-time |
シグナルの作成日 |
subscriptionDTO
Subscription スキーマ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
configuration
|
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
|
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
|
page | integer |
ページ |
|
pageSize
|
pageSize | integer |
pageSize パラメーターで定義されたページ サイズ |
|
並べ替え
|
sort | string |
要求されたデータに並べ替えを適用するために使用されるフィールド。+またはシンボルなしは ASC を意味し、- DESC を意味します |
|
トータル
|
total | integer |
ページに返される要素の合計数 |
|
コンテンツ
|
content | array of triggerDTO |
文字列
これは基本的なデータ型 'string' です。