Celonis (előzetes verzió)

A Celonis Platform API a tudásmodell elemeivel, például rekordokkal, KPI-kkel, szűrőkkel, eseményindítókkal és azok kapcsolódó adataival dolgozik.

Ez az összekötő a következő termékekben és régiókban érhető el:

Service	Class	Régiók
Copilot Studio	prémium	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Logikai alkalmazások	Standard	Az összes Logic Apps-régió , kivéve a következőket:      - Azure Government-régiók      - Azure China-régiók      - Amerikai Védelmi Minisztérium (DoD)
Power Alkalmazások	prémium	Az összes Power Apps-régió , kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)
Power Automate	prémium	Az összes Power Automate-régió, kivéve a következőket:      - USA kormánya (GCC)      - Amerikai kormány (GCC High)      - A 21Vianet által üzemeltetett China Cloud      - Amerikai Védelmi Minisztérium (DoD)

Érintkezés
Név	Celonis-támogatás
URL	https://developer.celonis.com/
Email	intelligence-api-feedback-sc@celonis.de

Összekötő metaadatai
Kiadó	Celonis
Webhely	https://www.celonis.com
Adatvédelmi irányelvek	https://www.celonis.com/privacy-policy/
Kategóriák	AI; Üzletvezetés

Cím

A Celonis Intelligence API lehetővé teszi a Celonis-ügyfelek számára, hogy végrehajtható folyamatintelligencia-adatokat ágyazhassanak be külső platformokra, ahol a végfelhasználók kihasználhatják a Celonis folyamatelemzéseit. Ily módon közelebb hozná a Celonis-intelligenciát, például a folyamat KPI-jét vagy a folyamat hatékonysági hiányosságait a végfelhasználókhoz, és kihasználná a Celonishoz való jelenlegi hozzáférés nélküli operatív felhasználókat azáltal, hogy értékes megállapításokat nyújt a jobb döntéshozatalhoz a mindennapi tevékenységeik végrehajtása során. Az adat-lekérdezési képességen kívül az Intelligence API támogatja az adatok külső platformokra való küldését is azáltal, hogy lehetővé teszi számukra az üzleti eseményindítókra való feliratkozást.

Közzétevő: Közzétevő neve

Celonis

Előfeltételek

1. Egy csapat a Celonis Platformon.
2. Egy ügyfél csapatában elérhető tudásmodell .
3. Folyamatalapú Celonis-előfizetés (az ellenőrzéshez lépjen kapcsolatba a fiókcsapattal).

Támogatott műveletek

A jelenlegi API-módszerek lehetővé teszik a felhasználók számára a Celonis Platformban meghatározott tudásmodellek használatát a következő funkciók biztosításával:

Tudásmodell felderítési módszerei

Tudásmodellek listájának lekérése (KM)

KM-rekordok listájának lekérése

KM-rekordséma részleteinek lekérése

KM-szűrők listájának lekérése

Tudásmodell adatlekérési módszerei

KM-rekordadatok listájának lekérése

Előfizetés életciklus-kezelési módszerei

Előfizetések listájának lekérése

KM-eseményindítók listájának lekérése

Előfizetés létrehozása KM-eseményindítóhoz

Előfizetés frissítése

Előfizetés szüneteltetése

Előfizetés folytatása

Előfizetés leállása

Hitelesítő adatok beszerzése

Authentication

Az API-nak küldött minden kérést Celonis API-kulccsal kell hitelesíteni. Ennek kétféle módja van:

Felhasználói API-kulcs használata

A felhasználói API-kulcsok létrehozásáról a Felhasználói API-kulcsok útmutatónkban tájékozódhat. A Celonis API a Bearer Token Authenticationt használja a fogyasztói hozzáférés ellenőrzéséhez. A hitelesítő adatokat a HTTP-kérelem engedélyezési fejlécében kell elküldeni. A kérés URL-címében vagy törzsében küldött hitelesítő adatokat a rendszer figyelmen kívül hagyja. Hitelesítés tulajdonosi jogkivonat-hitelesítéssel:

1. Hozza létre a jogkivonatot Celonisban: MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
2. Adja meg a sztringet a HTTP-engedélyezési fejlécben az alábbi módon:
   Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM

Alkalmazás API-kulcs használata

Az Application API-kulcsok útmutatóját követve megtudhatja, hogyan hozhat létre AppKey-et. Hitelesítés az AppKey-hitelesítéssel:

1. Az AppKey létrehozása Celonisban:
   MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
2. Adja meg a sztringet a HTTP-engedélyezési fejlécben az alábbi módon:
   Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr

Authorization

Meg kell adnia a megfelelő engedélyeket , és gondoskodnia kell arról, hogy a felhasználói API-kulcs vagy az engedélyezési célokra használt Application API-kulcs hozzáférhessen a Celonis Studio csomaghoz , amely tartalmazza a tudásmodell(ek)et, amelyet az Intelligence API-kon keresztül szeretne elérni. Hozzáférési engedélyeket az alábbi lépések végrehajtásával adhat meg:

• Nyissa meg a Studio csomagot.
• Kattintson a három pontra, és válasszon Permissions az előugró menüből.
• Keresse meg a felhasználót (ha tulajdonosi jogkivonatot használ) vagy AppKeyt (ha AppKey-t használ), és adjon meg legalább USE PACKAGE jogosultságokat.

Első lépések

A Celonis API https://<team>.<cluster>.celonis.cloud/intelligence/api alap URL-címe a csapat és a fürt megkeresése, ellenőrizze a Celonis platform eléréséhez használt URL-címet, és kérje le a csapatot és a fürtöt. A Celonis Intelligence API egy JSON API, és végpontjai mindig JSON-választ adnak vissza, függetlenül a kérés sikerességétől. A jelenlegi API-módszerek lehetővé teszik a felhasználók számára a Celonis Platformban meghatározott tudásmodellek használatát a következő funkciók biztosításával:

• Az elérhető tudásmodellek és azok részleteinek listája
• Rekordok és adataik listája
• Szűrők listája
• Adott rekord adatai. A Celonis Intelligence API funkcióinak részletei a Celonis fejlesztői portálján.

Ismert problémák és korlátozások

Sebességkorlátozás

Az Intelligence API nem nyers adatok tömeges exportálására készült, hanem azért, hogy a folyamatbányászatból származó számított eredményeket és megállapításokat elérhetővé tegye a külső platformok és alkalmazások számára. Ezért kényszeríti a Celonis API a sebességkorlátozást. Ez azt jelenti, hogy naponta csak bizonyos számú kérelem engedélyezett, és az egyes hívásokban bizonyos számú rekord kérhető le. A Celonis fenntartja a jogot, hogy bármikor módosítsa a díjkorlátokat, hogy minden ügyfél számára magas színvonalú szolgáltatást biztosítsunk. Ha egy ügyfél ismételten túllépi a sebességkorlátokat, vagy gyanúsnak ítélt viselkedést folytat, a Celonis fenntartja a jogot arra, hogy ideiglenesen vagy véglegesen korlátozza vagy felfüggesztse az API-hozzáférését az adott ügyfélhez. Ha egy ügyfél túllépi a kérelmek napi számát, a Celonis API egy 429-es választ (túl sok kérést) ad vissza, beleértve egy HTTP-fejlécet (), amely azt az időt (x-ratelimit-resetmásodpercben) jelzi, amikor az ügyfélnek várnia kell egy új kérés feldolgozása előtt. A rendszer a következő HTTP-fejléceket is visszaadja az egyes hívások részeként:

• x-ratelimit-limit : Az ügyfél által az aktuális időablakban teljesíthető kérelmek maximális számát jelöli.
• x-ratelimit-remaining : Az aktuális időablakban fennmaradó kérések száma. Az API jelenleg az alábbi alapértelmezett korlátokkal rendelkezik:

1. táblázat. Alapértelmezett kérelemdíjkorlátok

| Korlát | Alapértelmezett értékek | |--|-| | Kérelmek maximális száma/nap | 6000 kérelmek/nap | | Kérelmek maximális száma/másodperc | 20 kérelmek/másodperc | | Kérelemenkénti engedélyezett mezők maximális száma a tudásmodellben | 200 fields/request | | A végpont meghívásakor /data visszaadott kérésenkénti rekordok maximális száma | 50 rekordok/kérés | | A végponton keresztül /data lekérhető rekordok maximális száma | Első 5.000 rekordok szűrt/rendezett táblánként | Az eseményindító előfizetése is kényszeríti a sebességkorlátozást. Ez azt jelenti, hogy egy csapat számára csak bizonyos számú előfizetés hozható létre. Emellett függetlenül attól, hogy hány előfizetés jön létre, az API-ból a harmadik felek felhasználói számára maximális számú esemény bocsátható ki. Ha egy ügyfél eléri az előfizetések maximális számát, törölnie kell egy meglévő előfizetést egy új előfizetés létrehozásához. Ha egy ügyfél eléri az API-ból kibocsátott események maximális számát, a Celonis Platform által előállított többi adat elveszik. Ha az ügyfél eléri a napi kvótát, a rendszer e-mailben tájékoztatja őket a rendszergazdai fiókjába. Az első e-mailt a kvóta 80% túllépésekor küldi el a rendszer, és tudatja a rendszergazdai fiókkal, hogy túllépte ezt a százalékot. A második e-mailt a kvóta 100% túllépése után küldjük el. Az API jelenleg az alábbi alapértelmezett korlátokkal rendelkezik:

2. táblázat. Alapértelmezett eseménydíjkorlátok

| Korlát | Alapértelmezett értékek | |--|-| | Előfizetések/csapatok maximális száma | 10 | Események/nap maximális száma | 100,000 | A csoport korlátainak ellenőrzéséhez forduljon a fiókcsapatához.

Gyakori kérdések

Tekintse meg a Celonis fejlesztői portáljának gyakori kérdések szakaszát.

Üzembe helyezési utasítások

Szükséges. Útmutatás hozzáadása az összekötő egyéni összekötőként való üzembe helyezéséhez.

Kapcsolat létrehozása

Az összekötő a következő hitelesítési típusokat támogatja:

Alapértelmezett	A kapcsolat létrehozásának paraméterei.	Minden régió	Nem osztható meg

Alapértelmezett

Alkalmazható: Minden régió

A kapcsolat létrehozásának paraméterei.

Ez nem megosztható kapcsolat. Ha a power app meg van osztva egy másik felhasználóval, a rendszer kérni fogja, hogy hozzon létre új kapcsolatot.

Név	Típus	Description	Kötelező
Csoport	karakterlánc	Adja meg a Celonis-csapatot.	True
Klászter	karakterlánc	Adja meg a Celonis-fürtöt.	True
Authorization	securestring	Az api engedélyezése	True

Szabályozási korlátok

Name	Hívások	Megújítási időszak
API-hívások kapcsolatonként	100	60 másodperc

Műveletek

A KM-k listájának lekérése	EMS-csapatban definiált tudásmodellek listája
A legfelső szintű KM-rekordséma részleteinek lekérése	Legfelső szintű rekordséma részletei
A legfelső szintű KM részleteinek lekérése	EMS-csapatban definiált tudásmodell
Az előfizetés szüneteltetése az események fogadásának leállításához	Az előfizetés szüneteltetése az események fogadásának leállításához
Az események következő lapjának lekérése sikertelen előfizetés miatt nem lett továbbítva	Lekéri az események következő lapját, ha azokat nem sikerült előfizetés miatt továbbítani
Előfizetés frissítése	Előfizetés frissítése
Előfizetés létrehozása az eseményindítóhoz	Előfizetés létrehozása az eseményindítóhoz
Előfizetések listájának lekérése	Az összes létrehozott előfizetés listája
Folytatja a szüneteltetett előfizetést, hogy újra fogadhassa az eseményeket	Folytatja a szüneteltetett előfizetést, hogy újra fogadhassa az eseményeket
Folytatja az előfizetést, hogy új eseményeket fogadjon, és elvetje az előzményeseményeket	Folytatja a szüneteltetett előfizetést, hogy újra fogadjon új eseményeket, és elvetje az előzményeseményeket
KM-eseményindítók listájának lekérése	A tudásmodell eseményindítóinak listája
KM Records-séma listájának lekérése	Rekordok listája séma
KM-rekordadatok listájának lekérése	Rekord adatai a tudásmodellben
KM-szűrők listájának lekérése	A tudásmodell szűrőinek listája
Leiratkozás egy eseményindítóról, amely eltávolítja az előfizetés összes adatát	Leiratkozás egy eseményindítóról, amely eltávolítja az előfizetés összes adatát

A KM-k listájának lekérése

Műveletazonosító:

getKnowledgeModel

EMS-csapatban definiált tudásmodellek listája

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Oldal	page		integer	Az eredmény oldalszáma 0-tól kezdve (első oldal)
Oldalméret	pageSize		integer	A lapon visszaadott elemek száma.
Rendezés	sort		string	Meghatározza a kis- és nagybetűk érzéketlen rendezési stratégiáját. Csak egy mezőnek kell lennie, és a "+" betűvel kell kezdődnie, hogy ASC-rendelést vagy "-" értéket alkalmazzon a DESC-rendelés alkalmazásához. A nem előtag ASC-ként lesz rendezve. A fejléc nem létező mezője hibát jelez

Válaszok

A KnowledgeModel eredményoldala

knowledgeModelResultPage

A legfelső szintű KM-rekordséma részleteinek lekérése

Műveletazonosító:

getRecordDetails

Legfelső szintű rekordséma részletei

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Tudásmodell azonosítója	km_id	True	string	Tudásmodell azonosítója
Rekordazonosító	record_id	True	string	Rekordazonosító

Válaszok

A rekord egy tudásmodellen belüli fogalmat jelöl

Rekordtípus

recordDTO

A legfelső szintű KM részleteinek lekérése

Műveletazonosító:

getKnowledgeModelDetails

EMS-csapatban definiált tudásmodell

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Tudásmodell azonosítója	km_id	True	string	Tudásmodell azonosítója

Válaszok

A tudásmodell adatainak struktúrája

Tudásmodell

knowledgeModelDetailedDTO

Az előfizetés szüneteltetése az események fogadásának leállításához

Műveletazonosító:

pauseSubscription

Az előfizetés szüneteltetése az események fogadásának leállításához

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előfizetés azonosítója	subscription_id	True	string	Az előfizetés-azonosító szüneteltetve lesz

Az események következő lapjának lekérése sikertelen előfizetés miatt nem lett továbbítva

Műveletazonosító:

nextPageFromRemainingData

Lekéri az események következő lapját, ha azokat nem sikerült előfizetés miatt továbbítani

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előfizetés azonosítója	subscription_id	True	string	A sikertelen eseményt lekérő előfizetés-azonosító legfeljebb 50 elemben

Válaszok

Jel eredményoldala

SignalResultPage

Előfizetés frissítése

Műveletazonosító:

updateSubscription

Előfizetés frissítése

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előfizetés azonosítója	subscription_id	True	string	A teljes mértékben frissítendő előfizetés-azonosító
headers	headers		object	A visszahívási fejlécek tartalmazhatnak hitelesítési jogkivonatot, tartalomtípust stb.
protokoll	protocol	True	string	Csak a HTTPS érték lehetséges, ami azt jelenti, hogy a visszahívási URI-nak érvényes https-nek kell lennie
URL	uri	True	string	Uri a visszahívás végrehajtásához az Intelligence API-ból az eseményindító aktiválása után
configurations	configurations		array of string	Az előfizetés konfigurációja
név	name	True	string	Az előfizetés neve

Előfizetés létrehozása az eseményindítóhoz

Műveletazonosító:

createSubscription

Előfizetés létrehozása az eseményindítóhoz

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Km-azonosító	km_id	True	string	A tudásmodell azonosítója
Eseményindító azonosítója	trigger_id	True	string	Az eseményindító azonosítója
headers	headers		object	A visszahívási fejlécek tartalmazhatnak hitelesítési jogkivonatot, tartalomtípust stb.
protokoll	protocol	True	string	Csak a HTTPS érték lehetséges, ami azt jelenti, hogy a visszahívási URI-nak érvényes https-nek kell lennie
URL	uri	True	string	Uri a visszahívás végrehajtásához az Intelligence API-ból az eseményindító aktiválása után
configurations	configurations		array of string	Az előfizetés konfigurációja
név	name	True	string	Az előfizetés neve

Válaszok

response

string

Előfizetések listájának lekérése

Műveletazonosító:

getSubscriptions

Az összes létrehozott előfizetés listája

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Oldal	page		integer	Az eredmény oldalszáma 0-tól kezdve (első oldal)
Oldalméret	pageSize		integer	A lapon visszaadott elemek száma.
Fajta	sort		string	Meghatározza a kis- és nagybetűk érzéketlen rendezési stratégiáját. Csak egy mezőnek kell lennie, és a "+" betűvel kell kezdődnie, hogy ASC-rendelést vagy "-" értéket alkalmazzon a DESC-rendelés alkalmazásához. A nem előtag ASC-ként lesz rendezve. A fejléc nem létező mezője hibát jelez

Válaszok

Előfizetési séma eredményoldala

subscriptionResultPage

Folytatja a szüneteltetett előfizetést, hogy újra fogadhassa az eseményeket

Műveletazonosító:

resumeSubscription

Folytatja a szüneteltetett előfizetést, hogy újra fogadhassa az eseményeket

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előfizetés azonosítója	subscription_id	True	string	Az előfizetés-azonosító folytatódik, és újra megkezdődik az esemény fogadása

Folytatja az előfizetést, hogy új eseményeket fogadjon, és elvetje az előzményeseményeket

Műveletazonosító:

resumeSubscriptionNoHistory

Folytatja a szüneteltetett előfizetést, hogy újra fogadjon új eseményeket, és elvetje az előzményeseményeket

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előfizetés azonosítója	subscription_id	True	string	Az előfizetés-azonosító az átadott események fogadása nélkül folytatódik

KM-eseményindítók listájának lekérése

Műveletazonosító:

getTriggers

A tudásmodell eseményindítóinak listája

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Oldal	page		integer	Az eredmény oldalszáma 0-tól kezdve (első oldal)
Oldalméret	pageSize		integer	A lapon visszaadott elemek száma.
Fajta	sort		string	Meghatározza a kis- és nagybetűk érzéketlen rendezési stratégiáját. Csak egy mezőnek kell lennie, és a "+" betűvel kell kezdődnie, hogy ASC-rendelést vagy "-" értéket alkalmazzon a DESC-rendelés alkalmazásához. A nem előtag ASC-ként lesz rendezve. A fejléc nem létező mezője hibát jelez
Km-azonosító	km_id	True	string	A tudásmodell azonosítója

Válaszok

A séma eredményoldalának aktiválása

triggerResultPage

KM Records-séma listájának lekérése

Műveletazonosító:

getRecords

Rekordok listája séma

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Oldal	page		integer	Az eredmény oldalszáma 0-tól kezdve (első oldal)
Oldalméret	pageSize		integer	A lapon visszaadott elemek száma.
Rendezés	sort		string	Meghatározza a kis- és nagybetűk érzéketlen rendezési stratégiáját. Csak egy mezőnek kell lennie, és a "+" betűvel kell kezdődnie, hogy ASC-rendelést vagy "-" értéket alkalmazzon a DESC-rendelés alkalmazásához. A nem előtag ASC-ként lesz rendezve. A fejléc nem létező mezője hibát jelez
Tudásmodell azonosítója	km_id	True	string	Tudásmodell azonosítója

Válaszok

Rekordséma eredményoldala

recordSchemaResultPage

KM-rekordadatok listájának lekérése

Műveletazonosító:

getRecordDataResult

Rekord adatai a tudásmodellben

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Tudásmodell azonosítója	km_id	True	string	Tudásmodell azonosítója
Rekordazonosító	record_id	True	string	Rekordazonosító
Szűrők	filters		array	Előre definiált szűrőazonosító
Mezőazonosítók	fields	True	array	Előre definiált szűrőazonosító
Oldal	page		integer	Az eredmény oldalszáma 0-tól kezdve (első oldal)
Oldalméret	pageSize		integer	A lapon visszaadott elemek száma.
Rendezés	sort		array	Meghatározza a rendezés folytatásához szükséges stratégiát. A mezők vesszővel tagolt listájának kell lennie, és a "+" betűvel kell kezdődniük, hogy ASC-rendelést vagy "-" értéket alkalmazzanak a DESC-sorrend alkalmazásához. Az előtag nélküli mezők ASC-ként lesznek rendezve. A fejléc nem meglévő mezői hibát jeleznek
Kifejezés szűrése	filterExpr		array	Dinamikus szűrőkifejezések

Válaszok

Adateredmények rögzítése lap

recordResultPageDTO

KM-szűrők listájának lekérése

Műveletazonosító:

getFilters

A tudásmodell szűrőinek listája

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Oldal	page		integer	Az eredmény oldalszáma 0-tól kezdve (első oldal)
Oldalméret	pageSize		integer	A lapon visszaadott elemek száma.
Rendezés	sort		string	Meghatározza a kis- és nagybetűk érzéketlen rendezési stratégiáját. Csak egy mezőnek kell lennie, és a "+" betűvel kell kezdődnie, hogy ASC-rendelést vagy "-" értéket alkalmazzon a DESC-rendelés alkalmazásához. A nem előtag ASC-ként lesz rendezve. A fejléc nem létező mezője hibát jelez
Tudásmodell azonosítója	km_id	True	string	Tudásmodell azonosítója

Válaszok

Séma eredményoldalának szűrése

filterResultPage

Leiratkozás egy eseményindítóról, amely eltávolítja az előfizetés összes adatát

Műveletazonosító:

unsubscribe

Leiratkozás egy eseményindítóról, amely eltávolítja az előfizetés összes adatát

Paraméterek

Name	Kulcs	Kötelező	Típus	Description
Előfizetés azonosítója	subscription_id	True	string	Az előfizetés azonosítója törlődik

Definíciók

SignalResultPage

Name	Elérési út	Típus	Description
tartalom	content	array of signalDTO
pageSize	pageSize	integer	A rendszer által definiált oldalméret

filterDTO

Szűrés km-ben való alkalmazáshoz

Name	Elérési út	Típus	Description
leírás	description	string	Az emberi szűrő leírása
azonosító	id	string	Szűrő egyedi azonosítója
név	name	string	Emberi érthető szűrő megjelenítendő neve

filterResultPage

Name	Elérési út	Típus	Description
oldal	page	integer	Oldal
pageSize	pageSize	integer	PageSize paraméter által definiált oldalméret
rendez	sort	string	A kért adatok rendezésére használt mező, + vagy egyetlen szimbólum sem jelenti az ASC-t, - azt jelenti, HOGY DESC
teljes	total	integer	Az oldalon visszaadott összes elem
tartalom	content	array of filterDTO

knowledgeModelDetailedDTO

A tudásmodell adatainak struktúrája

Name	Elérési út	Típus	Description
azonosító	id	string	A tudásmodell egyedi azonosítója
név	name	string	Emberi érthető szöveg
extendedKMId	extendedKMId	string	Referenciaként használt tudásmodell, KM-alap.

knowledgeModelResultPage

Name	Elérési út	Típus	Description
oldal	page	integer	Oldal
pageSize	pageSize	integer	PageSize paraméter által definiált oldalméret
rendez	sort	string	A kért adatok rendezésére használt mező, + vagy egyetlen szimbólum sem jelenti az ASC-t, - azt jelenti, HOGY DESC
teljes	total	integer	Az oldalon visszaadott összes elem
tartalom	content	array of knowledgeModelSimplifiedDTO

knowledgeModelSimplifiedDTO

A tudásmodell adatainak struktúrája

Name	Elérési út	Típus	Description
azonosító	id	string	A tudásmodell egyedi azonosítója
név	name	string	Emberi érthető szöveg
Közzétett	published	string	Legutóbbi közzétett dátum

recordDTO

A rekord egy tudásmodellen belüli fogalmat jelöl

Name	Elérési út	Típus	Description
leírás	description	string	Rekord leírása
azonosító	id	string	Rekord egyedi azonosítója
név	name	string	Rekordmegjelenítési név, egy érthető emberi név
Mezők	fields	array of recordFieldDTO

recordFieldDTO

Rekordok mezői

Name	Elérési út	Típus	Description
format	format	string	Alkalmazandó formátum
azonosító	id	string	Kifizetésre váró összeg
név	name	string	emberi érthető név
típus	type	string
egység	unit	string	Mezőértékhez hozzáadott egység

recordIdDTO

Rekordtípus azonosítója és neve

Name	Elérési út	Típus	Description
leírás	description	string	Rekord leírása
azonosító	id	string	Rekord egyedi azonosítója
név	name	string	Rekordmegjelenítési név, egy érthető emberi név

recordItemDTO

Name	Elérési út	Típus	Description
adat	data	array of	Rekordelem, névvel és értékkel rendelkező összetett lista
headers	headers	array of recordItemHeaderDTO

recordItemHeaderDTO

Name	Elérési út	Típus	Description
aggregáció	aggregation	boolean	Annak jelzése, hogy egy mező aggregáció/számított információ(KPI) -e.
szűrhető	filterable	boolean	Adja meg, hogy a mező szűrhető-e.
format	format	string	Kifejezés formázása
azonosító	id	string	Mezőazonosító, amelyet a mezőlista param és filterExpression paramétere használ
név	name	string	Emberi érthető szöveg
rendezhető	sortable	boolean	Adja meg, hogy a mező rendezhető-e.
típus	type	string	Lehetséges adattípusok.
egység	unit	string	A formátumérték nézet kiegészítő jele

recordResultPageDTO

Name	Elérési út	Típus	Description
oldal	page	integer	Oldal
pageSize	pageSize	integer	PageSize paraméter által definiált oldalméret
rendez	sort	array of string
teljes	total	integer	Az oldalon visszaadott összes elem
Rekordelem	content	recordItemDTO

recordSchemaResultPage

Name	Elérési út	Típus	Description
oldal	page	integer	Oldal
pageSize	pageSize	integer	PageSize paraméter által definiált oldalméret
rendez	sort	string	A kért adatok rendezésére használt mező, + vagy egyetlen szimbólum sem jelenti az ASC-t, - azt jelenti, HOGY DESC
teljes	total	integer	Az oldalon visszaadott összes elem
tartalom	content	array of recordIdDTO

signalDTO

Előfizetésben tárolt jel

Name	Elérési út	Típus	Description
signal	signal	string	Egy jel nyers jsonja
subscriptionId	subscriptionId	string	Az előfizető egyedi azonosítója SUID-ként
triggerId	triggerId	string	Az eseményindító egyedi azonosítója SUID-ként
létrehozás dátuma	creationDate	date-time	A jel létrehozásának dátuma

subscriptionDTO

Előfizetési séma

Name	Elérési út	Típus	Description
configurations	configurations	array of string	Az előfizetés konfigurációja
azonosító	id	string	Az előfizető egyedi azonosítója SUID-ként
knowledgeModelId	knowledgeModelId	string	A tudásmodell egyedi azonosítója
latestSucceedEvent	latestSucceedEvent	date-time	Az utolsó sikeres esemény dátuma
név	name	string	Az ember számára érthető előfizetés neve
állapot	status	string
triggerId	triggerId	string	Az eseményindító egyedi azonosítója SUID-ként

subscriptionResultPage

Name	Elérési út	Típus	Description
oldal	page	integer	Oldal
pageSize	pageSize	integer	PageSize paraméter által definiált oldalméret
rendez	sort	string	A kért adatok rendezésére használt mező, + vagy egyetlen szimbólum sem jelenti az ASC-t, - azt jelenti, HOGY DESC
teljes	total	integer	Az oldalon visszaadott összes elem
tartalom	content	array of subscriptionDTO

triggerDTO

Km-ben definiált eseményindító

Name	Elérési út	Típus	Description
azonosító	id	string	Az eseményindító egyedi azonosítója SUID-ként
név	name	string	Az emberi eseményindító neve
rekord	record	string	Rekord egyedi azonosítója SUID-ként

triggerResultPage

Name	Elérési út	Típus	Description
oldal	page	integer	Oldal
pageSize	pageSize	integer	PageSize paraméter által definiált oldalméret
rendez	sort	string	A kért adatok rendezésére használt mező, + vagy egyetlen szimbólum sem jelenti az ASC-t, - azt jelenti, HOGY DESC
teljes	total	integer	Az oldalon visszaadott összes elem
tartalom	content	array of triggerDTO

karakterlánc

Ez a sztring alapszintű adattípusa.