Celonis (Vorschau)
Celonis-Plattform-API zum Arbeiten mit Wissensmodellelementen wie Datensätzen, KPIs, Filtern, Triggern und ihren zugehörigen Daten.
Dieser Connector ist in den folgenden Produkten und Regionen verfügbar:
| Dienstleistung | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Logik-Apps | Norm | Alle Logik-Apps-Regionen mit Ausnahme der folgenden Bereiche: – Azure Government-Regionen - Azure China-Regionen - US Department of Defense (DoD) |
| Power Apps | Premium | Alle Power Apps-Regionen mit Ausnahme der folgenden: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | Alle Power Automate-Regionen mit Ausnahme der folgenden Bereiche: - US Government (GCC) - US Government (GCC High) - China Cloud betrieben von 21Vianet - US Department of Defense (DoD) |
| Kontakt | |
|---|---|
| Name | Celonis Support |
| URL | https://developer.celonis.com/ |
| intelligence-api-feedback-sc@celonis.de |
| Connectormetadaten | |
|---|---|
| Herausgeber | Celonis |
| Webseite | https://www.celonis.com |
| Datenschutzrichtlinie | https://www.celonis.com/privacy-policy/ |
| Kategorien | Künstliche Intelligenz; Unternehmensführung |
Title
Die Celonis Intelligence-API ermöglicht Es Celonis-Kunden, umsetzbare Prozessintelligenz in Drittanbieterplattformen einzubetten, auf denen Endbenutzer von Celonis Prozesserkenntnissen profitieren können. Auf diese Weise würde Celonis Intelligence wie Prozess-KPIs oder Prozessineffizienzen näher an die Endbenutzer heranbringen und operative Benutzer ohne aktuellen Zugriff auf Celonis nutzen, indem sie wertvolle Einblicke für eine bessere Entscheidungsfindung bieten und gleichzeitig ihre täglichen Aktivitäten ausführen. Neben der Datenabfragefunktion unterstützt die Intelligence-API auch das Pushen von Daten an Drittanbieterplattformen, indem sie es ihnen ermöglichen, Geschäftstrigger zu abonnieren.
Herausgeber: Name des Herausgebers
Voraussetzungen
- Ein Team in celonis Platform.
- Ein Wissensmodell , das im Team eines Kunden verfügbar ist.
- Prozessbasiertes Celonis-Abonnement (wenden Sie sich an Ihr Kontoteam, um dies zu überprüfen).
Unterstützte Vorgänge
Mit den aktuellen API-Methoden können Verbraucher mit Wissensmodellen interagieren, die in der Celonis-Plattform definiert sind, indem folgende Funktionen bereitgestellt werden:
Knowledge Model Discovery-Methoden
Abrufen einer Liste von Wissensmodellen (KM)
Abrufen einer Liste von KM-Datensätzen
Abrufen von KM-Datensatzschemadetails
Abrufen einer Liste von KM-Filtern
Methoden zum Abrufen von Daten im Wissensmodell
Abrufen einer Liste von KM-Datensatzdaten
Methoden für die Abonnementlebenszyklusverwaltung
Abrufen einer Liste von Abonnements
Abrufen einer Liste von KM-Triggern
Erstellen eines Abonnements für einen KM-Trigger
Aktualisieren eines Abonnements
Anhalten eines Abonnements
Fortsetzen eines Abonnements
Kündigen eines Abonnements
Abrufen von Anmeldeinformationen
Authentifizierung
Jede Anforderung an die API muss mit einem Celonis-API-Schlüssel authentifiziert werden. Hierfür gibt es zwei Möglichkeiten:
Verwenden eines Benutzer-API-Schlüssels
Sie erfahren, wie Sie einen Benutzer-API-Schlüssel erstellen, indem Sie unserem Leitfaden für Benutzer-API-Schlüssel folgen. Die Celonis-API verwendet die Bearertokenauthentifizierung zur Überprüfung des Verbraucherzugriffs. Die Anmeldeinformationen müssen in einem Autorisierungsheader in der HTTP-Anforderung gesendet werden. Anmeldeinformationen, die in der URL oder im Textkörper der Anforderung gesendet werden, werden ignoriert. So authentifizieren Sie die Bearertokenauthentifizierung:
- Erstellen Sie das Token in Celonis:
MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM - Fügen Sie die Zeichenfolge in den HTTP-Autorisierungsheader ein, der wie folgt formatiert ist:
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
Verwenden eines Anwendungs-API-Schlüssels
Sie finden heraus, wie Sie einen AppKey erstellen, indem Sie unserem Leitfaden für Anwendungs-API-Schlüssel folgen. So authentifizieren Sie sich mithilfe der AppKey-Authentifizierung:
- Erstellen Sie den AppKey in Celonis:
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr - Fügen Sie die Zeichenfolge in den HTTP-Autorisierungsheader ein, der wie folgt formatiert ist:
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
Autorisierung
Sie müssen die richtigen Berechtigungen festlegen und sicherstellen, dass der Benutzer-API-Schlüssel oder der für Autorisierungszwecke genutzte Anwendungs-API-Schlüssel Zugriff auf das Celonis Studio-Paket hat, das die Wissensmodelle enthält, auf die Sie über Intelligence-APIs zugreifen möchten. Sie können Zugriffsberechtigungen erteilen, indem Sie die folgenden Schritte ausführen:
- Wechseln Sie zum Studio-Paket.
- Klicken Sie auf die drei Punkte, und wählen Sie
Permissionsim Popupmenü aus. - Suchen Sie nach dem Benutzer (falls Sie ein Bearer-Token verwenden) oder AppKey (falls Sie einen AppKey verwenden), und gewähren Sie mindestens
USE PACKAGERechte.
Erste Schritte
Die Basis-URL für die Celonis-API lautet https://<team>.<cluster>.celonis.cloud/intelligence/api : Um das Team und den Cluster zu finden, überprüfen Sie bitte die URL, die Sie für den Zugriff auf die Celonis-Plattform verwenden, und rufen Sie das Team und den Cluster daraus ab.
Die Celonis Intelligence-API ist eine JSON-API, und ihre Endpunkte geben immer eine JSON-Antwort zurück, unabhängig vom Erfolg der Anforderung.
Mit den aktuellen API-Methoden können Verbraucher mit Wissensmodellen interagieren, die in der Celonis-Plattform definiert sind, indem folgende Funktionen bereitgestellt werden:
- Liste der verfügbaren Wissensmodelle und deren Details
- Liste der Datensätze und deren Details
- Liste der Filter
- Daten für einen bestimmten Datensatz. Details zu den Celonis Intelligence-API-Features im Celonis-Entwicklerportal.
Bekannte Probleme und Einschränkungen
Ratenbegrenzung
Die Intelligence-API wurde nicht für den Massenexport von RAW-Daten entwickelt, sondern um die berechneten Ergebnisse und Erkenntnisse aus dem Process Mining für Drittanbieterplattformen und -anwendungen zur Verfügung zu stellen. Aus diesem Grund erzwingt die Celonis-API die Ratelimitierung. Dies bedeutet, dass pro Tag nur eine bestimmte Anzahl von Anforderungen zulässig ist und eine bestimmte Anzahl von Datensätzen in jedem Anruf abgerufen werden kann. Celonis behält sich das Recht vor, die Tariflimits jederzeit anzupassen, um qualitativ hochwertigen Service für alle Kunden zu gewährleisten.
Falls ein Kunde wiederholt die Ratenlimits überschreitet oder verhaltensweisen, die als verdächtig eingestuft werden, behält sich Celonis das Recht vor, den Zugriff auf die API für diesen Client vorübergehend oder dauerhaft einzuschränken oder auszusetzen.
Wenn ein Client die Anzahl der Anforderungen pro Tag überschreitet, gibt die Celonis-API eine 429-Antwort (zu viele Anforderungen) einschließlich eines HTTP-Headers (x-ratelimit-reset) zurück, der die Zeit (in Sekunden) angibt, die der Client warten muss, bevor eine neue Anforderung verarbeitet werden kann.
Die folgenden HTTP-Header werden auch als Teil jedes Aufrufs zurückgegeben:
-
x-ratelimit-limit: Stellt die maximale Anzahl von Anforderungen dar, die der Client im aktuellen Zeitfenster ausführen kann. -
x-ratelimit-remaining: Anzahl der verbleibenden Anforderungen im aktuellen Zeitfenster. Derzeit weist die API die folgenden Standardgrenzwerte auf:
Tabelle 1: Standardanforderungsratenlimits
|
Grenze | Standardwerte | |--|--| | Maximale Anzahl von Anforderungen/Tag | 6000 Anfragen/Tag | | Maximale Anzahl von Anforderungen/Sekunde | 20 Anfragen/Sekunde | | Maximale Anzahl zulässiger Felder pro Anforderung im Wissensmodell | 200 fields/request | | Maximale Anzahl von Datensätzen pro Anforderung, die beim Aufrufen des /data Endpunkts 50 | Datensätze/Anforderung | | Maximale Anzahl von Datensätzen, die über den /data Endpunkt abgerufen werden können | Erste 5.000 Datensätze pro gefilterte/sortierte Tabelle | Das Abonnement für Trigger erzwingt auch die Begrenzung der Raten. Dies bedeutet für ein Team, dass nur eine bestimmte Anzahl von Abonnements erstellt werden kann. Darüber hinaus gibt es unabhängig davon, wie viele Abonnements erstellt werden, eine maximale Anzahl von Ereignissen, die von der API an die Consumer von Drittanbietern gesendet werden können.
Wenn ein Client die maximale Anzahl von Abonnements erreicht, muss er ein vorhandenes Abonnement löschen, um ein neues Abonnement zu erstellen.
Wenn ein Client die maximale Anzahl von Ereignissen erreicht, die von der API ausgegeben werden, werden die restlichen Daten, die von der Celonis-Plattform erzeugt werden, verworfen.
Wenn sich der Kunde dem täglichen Kontingent nähert, wird er per E-Mail an Ihr Administratorkonto informiert. Die erste E-Mail wird gesendet, wenn 80% des Kontingents überschritten werden, und Ihr Administratorkonto informiert, dass Sie diesen Prozentsatz überschreiten. Die zweite E-Mail wird gesendet, sobald Sie 100% des Kontingents überschreiten.
Derzeit weist die API die folgenden Standardgrenzwerte auf:
Tabelle 2: Standardgrenzwerte für Ereignisraten
|
Grenze | Standardwerte | |--|--| | Maximale Anzahl von Abonnements/Team | 10 | | Maximale Anzahl von Ereignissen/Tag | 100,000 | Wenden Sie sich an Ihr Kontoteam, um die Grenzwerte Ihres Teams zu überprüfen.
Häufig gestellte Fragen
Weitere Informationen finden Sie im Abschnitt "Häufig gestellte Fragen " im Celonis Developer Portal.
Bereitstellungsanweisungen
Erforderlich. Fügen Sie Anweisungen zum Bereitstellen dieses Connectors als benutzerdefinierter Connector hinzu.
Erstellen einer Verbindung
Der Connector unterstützt die folgenden Authentifizierungstypen:
| Vorgabe | Parameter zum Erstellen einer Verbindung. | Alle Regionen | Nicht teilbar |
Vorgabe
Anwendbar: Alle Regionen
Parameter zum Erstellen einer Verbindung.
Dies ist keine freigabefähige Verbindung. Wenn die Power-App für einen anderen Benutzer freigegeben wird, wird ein anderer Benutzer aufgefordert, eine neue Verbindung explizit zu erstellen.
| Name | Typ | Description | Erforderlich |
|---|---|---|---|
| Mannschaft | Schnur | Bitte geben Sie das Celonis-Team an. | Richtig |
| Cluster | Schnur | Geben Sie den Celonis-Cluster an. | Richtig |
| Autorisierung | securestring | Die Autorisierung für diese API | Richtig |
Drosselungsgrenzwerte
| Name | Aufrufe | Verlängerungszeitraum |
|---|---|---|
| API-Aufrufe pro Verbindung | 100 | 60 Sekunden |
Aktionen
| Abrufen der KM-Datensatzschemadetails der obersten Ebene |
Details zum Datensatzschema der obersten Ebene |
| Abrufen der KM-Details der obersten Ebene |
Wissensmodell, das in einem EMS-Team definiert ist |
| Abrufen einer Liste des KM Records-Schemas |
Liste des Datensatzschemas |
| Abrufen einer Liste von Abonnements |
Liste aller erstellten Abonnements |
| Abrufen einer Liste von KM-Datensatzdaten |
Daten für einen Datensatz im Wissensmodell |
| Abrufen einer Liste von KM-Filtern |
Liste der Filter für das Wissensmodell |
| Abrufen einer Liste von KM-Triggern |
Liste der Trigger für das Wissensmodell |
| Abrufen einer Liste von KMs |
Liste der in einem EMS-Team definierten Wissensmodelle |
| Aktualisiert ein Abonnement |
Aktualisiert ein Abonnement |
| Erstellt ein Abonnement für den Trigger. |
Erstellt ein Abonnement für den Trigger. |
| Hält das Abonnement an, um den Empfang von Ereignissen zu beenden. |
Hält das Abonnement an, um den Empfang von Ereignissen zu beenden. |
| Kündigen eines Auslöserabonnements zum Entfernen aller Daten für das Abonnement |
Kündigen eines Auslöserabonnements zum Entfernen aller Daten für das Abonnement |
| Ruft die nächste Seite mit Ereignissen ab, die aufgrund eines fehlgeschlagenen Abonnements nicht weitergeleitet wurden |
Ruft die nächste Seite von Ereignissen ab, wenn sie aufgrund eines fehlgeschlagenen Abonnements nicht weitergeleitet wurden |
| Setzt das Abonnement fort, um mit dem Empfang neuer Ereignisse zu beginnen, verlaufsbezogene Ereignisse zu verwerfen |
Setzt das angehaltene Abonnement fort, um mit dem Empfang neuer Ereignisse erneut zu beginnen, das Verwerfen von Verlaufsereignissen |
| Setzt das angehaltene Abonnement fort, um wieder Ereignisse zu empfangen |
Setzt das angehaltene Abonnement fort, um wieder Ereignisse zu empfangen |
Abrufen der KM-Datensatzschemadetails der obersten Ebene
Details zum Datensatzschema der obersten Ebene
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Wissensmodell-ID
|
km_id | True | string |
Wissensmodell-ID |
|
Datensatzkennung
|
record_id | True | string |
Datensatzkennung |
Gibt zurück
Datensatz stellt ein Konzept innerhalb eines Wissensmodells dar.
- Datensatztyp
- recordDTO
Abrufen der KM-Details der obersten Ebene
Wissensmodell, das in einem EMS-Team definiert ist
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Wissensmodell-ID
|
km_id | True | string |
Wissensmodell-ID |
Gibt zurück
Struktur der Wissensmodelldaten
- Wissensmodell
- knowledgeModelDetailedDTO
Abrufen einer Liste des KM Records-Schemas
Liste des Datensatzschemas
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Die Seitenzahl des Ergebnisses beginnend mit 0 (erste Seite) |
|
|
Seitenformat
|
pageSize | integer |
Die Anzahl der in einer Seite zurückgegebenen Elemente. |
|
|
Sortieren
|
sort | string |
Definiert die Strategie, um bei der Sortierung ohne Groß-/Kleinschreibung fortzufahren. Es muss nur ein Feld sein, und es sollte mit "+" beginnen, um die ASC-Reihenfolge oder "-" anzuwenden, um DIE DESC-Reihenfolge anzuwenden. Kein Präfix wird als ASC sortiert. Nicht vorhandenes Feld in der Kopfzeile löst einen Fehler aus. |
|
|
Wissensmodell-ID
|
km_id | True | string |
Wissensmodell-ID |
Gibt zurück
- Datensatzschemaergebnisseite
- recordSchemaResultPage
Abrufen einer Liste von Abonnements
Liste aller erstellten Abonnements
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Die Seitenzahl des Ergebnisses beginnend mit 0 (erste Seite) |
|
|
Seitenformat
|
pageSize | integer |
Die Anzahl der in einer Seite zurückgegebenen Elemente. |
|
|
Sortieren
|
sort | string |
Definiert die Strategie, um bei der Sortierung ohne Groß-/Kleinschreibung fortzufahren. Es muss nur ein Feld sein, und es sollte mit "+" beginnen, um die ASC-Reihenfolge oder "-" anzuwenden, um DIE DESC-Reihenfolge anzuwenden. Kein Präfix wird als ASC sortiert. Nicht vorhandenes Feld in der Kopfzeile löst einen Fehler aus. |
Gibt zurück
- Ergebnisseite des Abonnementschemas
- subscriptionResultPage
Abrufen einer Liste von KM-Datensatzdaten
Daten für einen Datensatz im Wissensmodell
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Wissensmodell-ID
|
km_id | True | string |
Wissensmodell-ID |
|
Datensatzkennung
|
record_id | True | string |
Datensatzkennung |
|
Filter
|
filters | array |
Eine vordefinierte Filter-ID |
|
|
Feld-IDs
|
fields | True | array |
Eine vordefinierte Filter-ID |
|
Seite
|
page | integer |
Die Seitenzahl des Ergebnisses beginnend mit 0 (erste Seite) |
|
|
Seitenformat
|
pageSize | integer |
Die Anzahl der in einer Seite zurückgegebenen Elemente. |
|
|
Sortieren
|
sort | array |
Definiert die Strategie, die für die Sortierung fortgesetzt werden soll. Es muss sich um eine durch Trennzeichen getrennte Liste von Feldern sein, und sie sollten mit "+" beginnen, um die ASC-Reihenfolge oder "-" anzuwenden, um die DESC-Reihenfolge anzuwenden. Felder ohne Präfix werden als ASC sortiert. Nicht vorhandene Felder in der Kopfzeile lösen einen Fehler aus. |
|
|
Filterausdruck
|
filterExpr | array |
Dynamische Filterausdrücke |
Gibt zurück
- Datensatzdatenergebnisseite
- recordResultPageDTO
Abrufen einer Liste von KM-Filtern
Liste der Filter für das Wissensmodell
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Die Seitenzahl des Ergebnisses beginnend mit 0 (erste Seite) |
|
|
Seitenformat
|
pageSize | integer |
Die Anzahl der in einer Seite zurückgegebenen Elemente. |
|
|
Sortieren
|
sort | string |
Definiert die Strategie, um bei der Sortierung ohne Groß-/Kleinschreibung fortzufahren. Es muss nur ein Feld sein, und es sollte mit "+" beginnen, um die ASC-Reihenfolge oder "-" anzuwenden, um DIE DESC-Reihenfolge anzuwenden. Kein Präfix wird als ASC sortiert. Nicht vorhandenes Feld in der Kopfzeile löst einen Fehler aus. |
|
|
Wissensmodell-ID
|
km_id | True | string |
Wissensmodell-ID |
Gibt zurück
- Filterschemaergebnisseite
- filterResultPage
Abrufen einer Liste von KM-Triggern
Liste der Trigger für das Wissensmodell
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Die Seitenzahl des Ergebnisses beginnend mit 0 (erste Seite) |
|
|
Seitenformat
|
pageSize | integer |
Die Anzahl der in einer Seite zurückgegebenen Elemente. |
|
|
Sortieren
|
sort | string |
Definiert die Strategie, um bei der Sortierung ohne Groß-/Kleinschreibung fortzufahren. Es muss nur ein Feld sein, und es sollte mit "+" beginnen, um die ASC-Reihenfolge oder "-" anzuwenden, um DIE DESC-Reihenfolge anzuwenden. Kein Präfix wird als ASC sortiert. Nicht vorhandenes Feld in der Kopfzeile löst einen Fehler aus. |
|
|
Km-ID
|
km_id | True | string |
Die Wissensmodell-ID |
Gibt zurück
- Ergebnisseite des Triggerschemas
- triggerResultPage
Abrufen einer Liste von KMs
Liste der in einem EMS-Team definierten Wissensmodelle
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Seite
|
page | integer |
Die Seitenzahl des Ergebnisses beginnend mit 0 (erste Seite) |
|
|
Seitenformat
|
pageSize | integer |
Die Anzahl der in einer Seite zurückgegebenen Elemente. |
|
|
Sortieren
|
sort | string |
Definiert die Strategie, um bei der Sortierung ohne Groß-/Kleinschreibung fortzufahren. Es muss nur ein Feld sein, und es sollte mit "+" beginnen, um die ASC-Reihenfolge oder "-" anzuwenden, um DIE DESC-Reihenfolge anzuwenden. Kein Präfix wird als ASC sortiert. Nicht vorhandenes Feld in der Kopfzeile löst einen Fehler aus. |
Gibt zurück
- KnowledgeModel-Ergebnisseite
- knowledgeModelResultPage
Aktualisiert ein Abonnement
Aktualisiert ein Abonnement
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Subscription Id (Abonnement-ID)
|
subscription_id | True | string |
Die Abonnement-ID, die vollständig aktualisiert wird |
|
headers
|
headers | object |
Rückrufheader können Authentifizierungstoken, Inhaltstyp usw. enthalten. |
|
|
protocol
|
protocol | True | string |
Nur ein möglicher Wert ist HTTPS, was bedeutet, dass der Rückruf-URI ein gültiges https sein muss. |
|
URI
|
uri | True | string |
URI zum Ausführen des Rückrufs aus der Intelligence-API nach dem Auslösen des Triggers |
|
Konfigurationen
|
configurations | array of string |
Konfiguration für das Abonnement |
|
|
name
|
name | True | string |
Name für das Abonnement |
Erstellt ein Abonnement für den Trigger.
Erstellt ein Abonnement für den Trigger.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Km-ID
|
km_id | True | string |
Die Wissensmodell-ID |
|
Trigger-ID
|
trigger_id | True | string |
Die Trigger-ID |
|
headers
|
headers | object |
Rückrufheader können Authentifizierungstoken, Inhaltstyp usw. enthalten. |
|
|
protocol
|
protocol | True | string |
Nur ein möglicher Wert ist HTTPS, was bedeutet, dass der Rückruf-URI ein gültiges https sein muss. |
|
URI
|
uri | True | string |
URI zum Ausführen des Rückrufs aus der Intelligence-API nach dem Auslösen des Triggers |
|
Konfigurationen
|
configurations | array of string |
Konfiguration für das Abonnement |
|
|
name
|
name | True | string |
Name für das Abonnement |
Gibt zurück
- response
- string
Hält das Abonnement an, um den Empfang von Ereignissen zu beenden.
Hält das Abonnement an, um den Empfang von Ereignissen zu beenden.
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Subscription Id (Abonnement-ID)
|
subscription_id | True | string |
Die Abonnement-ID wird angehalten. |
Kündigen eines Auslöserabonnements zum Entfernen aller Daten für das Abonnement
Kündigen eines Auslöserabonnements zum Entfernen aller Daten für das Abonnement
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Subscription Id (Abonnement-ID)
|
subscription_id | True | string |
Die Abonnement-ID wird gelöscht. |
Ruft die nächste Seite mit Ereignissen ab, die aufgrund eines fehlgeschlagenen Abonnements nicht weitergeleitet wurden
Ruft die nächste Seite von Ereignissen ab, wenn sie aufgrund eines fehlgeschlagenen Abonnements nicht weitergeleitet wurden
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Subscription Id (Abonnement-ID)
|
subscription_id | True | string |
Die Abonnement-ID, die fehlgeschlagene Ereignisse abruft, in maximal 50 Elementen |
Gibt zurück
- Signalergebnisseite
- SignalResultPage
Setzt das Abonnement fort, um mit dem Empfang neuer Ereignisse zu beginnen, verlaufsbezogene Ereignisse zu verwerfen
Setzt das angehaltene Abonnement fort, um mit dem Empfang neuer Ereignisse erneut zu beginnen, das Verwerfen von Verlaufsereignissen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Subscription Id (Abonnement-ID)
|
subscription_id | True | string |
Die Abonnement-ID wird fortgesetzt, ohne dass übergebene Ereignisse empfangen werden |
Setzt das angehaltene Abonnement fort, um wieder Ereignisse zu empfangen
Setzt das angehaltene Abonnement fort, um wieder Ereignisse zu empfangen
Parameter
| Name | Schlüssel | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
Subscription Id (Abonnement-ID)
|
subscription_id | True | string |
Die Abonnement-ID wird fortgesetzt und beginnt erneut mit dem Empfang des Ereignisses. |
Definitionen
SignalResultPage
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Inhalt
|
content | array of signalDTO | |
|
pageSize
|
pageSize | integer |
Vom System definierte Seitengröße |
filterDTO
Filter, der in einem KM angewendet werden soll
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Beschreibung
|
description | string |
Beschreibung des menschlichen verständlichen Filters |
|
id
|
id | string |
Eindeutiger Bezeichner des Filters |
|
name
|
name | string |
Anzeigename des menschlichen verständlichen Filters |
filterResultPage
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seite
|
page | integer |
Seite |
|
pageSize
|
pageSize | integer |
Seitengröße, definiert durch pageSize-Parameter |
|
sort
|
sort | string |
Feld, das verwendet wird, um die Sortierung auf die angeforderten Daten anzuwenden, + oder kein Symbol bedeutet ASC, - bedeutet DESC |
|
gesamt
|
total | integer |
Auf der Seite zurückgegebene Gesamtelemente |
|
Inhalt
|
content | array of filterDTO |
knowledgeModelDetailedDTO
Struktur der Wissensmodelldaten
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Eindeutiger Bezeichner des Wissensmodells |
|
name
|
name | string |
Menschlichen verständlichen Text |
|
extendedKMId
|
extendedKMId | string |
Wissensmodell, das als Referenz, KM-Basis verwendet wird. |
knowledgeModelResultPage
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seite
|
page | integer |
Seite |
|
pageSize
|
pageSize | integer |
Seitengröße, definiert durch pageSize-Parameter |
|
sort
|
sort | string |
Feld, das verwendet wird, um die Sortierung auf die angeforderten Daten anzuwenden, + oder kein Symbol bedeutet ASC, - bedeutet DESC |
|
gesamt
|
total | integer |
Auf der Seite zurückgegebene Gesamtelemente |
|
Inhalt
|
content | array of knowledgeModelSimplifiedDTO |
knowledgeModelSimplifiedDTO
Struktur der Wissensmodelldaten
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Eindeutiger Bezeichner des Wissensmodells |
|
name
|
name | string |
Menschlichen verständlichen Text |
|
veröffentlicht
|
published | string |
Neuestes Veröffentlichungsdatum |
recordDTO
Datensatz stellt ein Konzept innerhalb eines Wissensmodells dar.
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Beschreibung
|
description | string |
Datensatzbeschreibung |
|
id
|
id | string |
Eindeutiger Bezeichner des Datensatzes |
|
name
|
name | string |
Datensatzanzeigename, ein menschlichen verständlicher Name |
|
fields
|
fields | array of recordFieldDTO |
recordFieldDTO
Felder für einen Datensatz
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
format
|
format | string |
Anzuwendendes Format |
|
id
|
id | string |
Betrag, der aussteht, um zu bezahlen |
|
name
|
name | string |
Mensch verständlicher Name |
|
type
|
type | string | |
|
Einheit
|
unit | string |
Zu Feldwert hinzugefügte Einheit |
recordIdDTO
ID und Name des Datensatztyps
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Beschreibung
|
description | string |
Datensatzbeschreibung |
|
id
|
id | string |
Eindeutiger Bezeichner des Datensatzes |
|
name
|
name | string |
Datensatzanzeigename, ein menschlichen verständlicher Name |
recordItemDTO
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Daten
|
data | array of |
Liste des Datensatzelements, zusammengesetzt mit Name und Wert |
|
headers
|
headers | array of recordItemHeaderDTO |
recordItemHeaderDTO
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Aggregation
|
aggregation | boolean |
Geben Sie an, ob ein Feld eine Aggregation/berechnete Information (KPI) ist. |
|
filterable
|
filterable | boolean |
Geben Sie an, ob das Feld gefiltert werden könnte. |
|
format
|
format | string |
Formatausdruck |
|
id
|
id | string |
Feldidentität, die in Feldlistenparametern und FilterExpression-Param verwendet werden soll |
|
name
|
name | string |
Menschlichen verständlichen Text |
|
sortable
|
sortable | boolean |
Geben Sie an, ob das Feld sortiert werden könnte. |
|
type
|
type | string |
Mögliche Datentypen. |
|
Einheit
|
unit | string |
Ein ergänzendes Zeichen für die Formatwertansicht |
recordResultPageDTO
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seite
|
page | integer |
Seite |
|
pageSize
|
pageSize | integer |
Seitengröße, definiert durch pageSize-Parameter |
|
sort
|
sort | array of string | |
|
gesamt
|
total | integer |
Auf der Seite zurückgegebene Gesamtelemente |
|
Datensatzelement
|
content | recordItemDTO |
recordSchemaResultPage
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seite
|
page | integer |
Seite |
|
pageSize
|
pageSize | integer |
Seitengröße, definiert durch pageSize-Parameter |
|
sort
|
sort | string |
Feld, das verwendet wird, um die Sortierung auf die angeforderten Daten anzuwenden, + oder kein Symbol bedeutet ASC, - bedeutet DESC |
|
gesamt
|
total | integer |
Auf der Seite zurückgegebene Gesamtelemente |
|
Inhalt
|
content | array of recordIdDTO |
signalDTO
Signal, das im Abonnement gespeichert ist
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
signal
|
signal | string |
Unformatierte JSON eines Signals |
|
subscriptionId
|
subscriptionId | string |
Eindeutiger Bezeichner des Abonnenten als SUID |
|
triggerId
|
triggerId | string |
Eindeutiger Bezeichner des Triggers als SUID |
|
Erstellungsdatum
|
creationDate | date-time |
Datum der Signalerstellung |
subscriptionDTO
Subscription-Schema
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Konfigurationen
|
configurations | array of string |
Konfiguration für das Abonnement |
|
id
|
id | string |
Eindeutiger Bezeichner des Abonnenten als SUID |
|
knowledgeModelId
|
knowledgeModelId | string |
Eindeutiger Bezeichner des Wissensmodells |
|
latestSucceedEvent
|
latestSucceedEvent | date-time |
Datum des letzten erfolgreichen Ereignisses |
|
name
|
name | string |
Name des menschlichen verständlichen Abonnements |
|
status
|
status | string | |
|
triggerId
|
triggerId | string |
Eindeutiger Bezeichner des Triggers als SUID |
subscriptionResultPage
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seite
|
page | integer |
Seite |
|
pageSize
|
pageSize | integer |
Seitengröße, definiert durch pageSize-Parameter |
|
sort
|
sort | string |
Feld, das verwendet wird, um die Sortierung auf die angeforderten Daten anzuwenden, + oder kein Symbol bedeutet ASC, - bedeutet DESC |
|
gesamt
|
total | integer |
Auf der Seite zurückgegebene Gesamtelemente |
|
Inhalt
|
content | array of subscriptionDTO |
triggerDTO
Trigger definiert bei KM
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
id
|
id | string |
Eindeutiger Bezeichner des Triggers als SUID |
|
name
|
name | string |
Name des menschlichen verständlichen Triggers |
|
Datensatz (record)
|
record | string |
Eindeutiger Bezeichner des Datensatzes als SUID |
triggerResultPage
| Name | Pfad | Typ | Beschreibung |
|---|---|---|---|
|
Seite
|
page | integer |
Seite |
|
pageSize
|
pageSize | integer |
Seitengröße, definiert durch pageSize-Parameter |
|
sort
|
sort | string |
Feld, das verwendet wird, um die Sortierung auf die angeforderten Daten anzuwenden, + oder kein Symbol bedeutet ASC, - bedeutet DESC |
|
gesamt
|
total | integer |
Auf der Seite zurückgegebene Gesamtelemente |
|
Inhalt
|
content | array of triggerDTO |
Schnur
Dies ist der grundlegende Datentyp "string".