Celonis (Preview)
Celonis Platform API pro práci s prvky modelu znalostí, jako jsou záznamy, klíčové ukazatele výkonu, filtry, triggery a související data.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Celonis Support |
| URL | https://developer.celonis.com/ |
| intelligence-api-feedback-sc@celonis.de |
| Metadata konektoru | |
|---|---|
| Vydavatel | Celonis |
| Internetová stránka | https://www.celonis.com |
| Zásady ochrany osobních údajů | https://www.celonis.com/privacy-policy/ |
| Kategorie | Umělá inteligence; Správa podniku |
Title
Celonis Intelligence API umožňuje zákazníkům celonisů vkládat užitečné procesní inteligentní funkce do platforem třetích stran, kde můžou koncoví uživatelé těžit z přehledů procesů Celonis. Tímto způsobem by celonisová inteligence, jako jsou klíčové ukazatele výkonu procesu nebo efektivita procesů, blíže koncovým uživatelům a využívala provozním uživatelům bez aktuálního přístupu k Celonisu tím, že poskytuje cenné přehledy pro lepší rozhodování při provádění každodenních aktivit. Kromě možnosti dotazování na data podporuje rozhraní API inteligentních funkcí také nabízení dat do platforem třetích stran tím, že je umožňuje přihlásit se k odběru obchodních triggerů.
Vydavatel: Název vydavatele
Požadavky
- Tým v celonis platformě.
- Znalostní model dostupný v týmu klienta.
- Celonisové předplatné na základě procesů (s žádostí o ověření se obraťte na tým účtu).
Podporované operace
Současné metody rozhraní API umožňují uživatelům pracovat s modely znalostí definovanými v celonis platformě tím, že poskytují následující funkce:
Metody zjišťování modelu znalostí
Získání seznamu modelů znalostí (KM)
Získání seznamu záznamů KM
Získání podrobností o schématu záznamu KM
Získání seznamu filtrů km
Metody načítání dat ve znalostním modelu
Získání seznamu dat záznamu KM
Metody správy životního cyklu předplatného
Získání seznamu předplatných
Získání seznamu aktivačních událostí km
Vytvoření předplatného triggeru KM
Aktualizace předplatného
Pozastavení předplatného
Obnovení předplatného
Ukončení předplatného
Získání přihlašovacích údajů
Autentizace
Každý požadavek na rozhraní API musí být ověřený pomocí klíče rozhraní Celonis API. Můžete to udělat dvěma způsoby:
Použití klíče uživatelského rozhraní API
Postup vytvoření klíče uživatelského rozhraní API najdete v průvodci klíči uživatelského rozhraní API . Rozhraní Celonis API používá ověřování nosné tokeny k ověření přístupu uživatele. Přihlašovací údaje musí být odeslány v autorizační hlavičce požadavku HTTP. Přihlašovací údaje odeslané v adrese URL nebo textu požadavku budou ignorovány. Ověření pomocí ověřování nosné tokeny:
- Vytvořte token v Celonisu:
MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM - Zahrňte řetězec do hlavičky HTTP Authorization formátované takto:
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
Použití klíče rozhraní API aplikace
Postup vytvoření klíče AppKey najdete v průvodci klíči rozhraní APPLICATION API . Ověřování pomocí AppKey Authentication:
- Vytvořte AppKey v Celonisu:
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr - Zahrňte řetězec do hlavičky HTTP Authorization formátované takto:
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
Authorization
Musíte nastavit správná oprávnění a zajistit, aby klíč uživatelského rozhraní API nebo klíč rozhraní API aplikace , které se využívají pro autorizační účely, měl přístup k balíčku Celonis Studio obsahujícího znalostní modely, ke které chcete získat přístup prostřednictvím rozhraní API inteligentních funkcí. Přístupová oprávnění můžete udělit pomocí následujícího postupu:
- Přejděte do balíčku Studio.
- Klikněte na tři tečky a vyberte
Permissionsz místní nabídky. - Vyhledejte uživatele (v případě, že používáte nosný token ) nebo AppKey (v případě, že používáte AppKey ) a udělte alespoň
USE PACKAGEpráva.
Začínáme
Základní adresou URL pro celonisové rozhraní API je https://<team>.<cluster>.celonis.cloud/intelligence/api Vyhledání týmu a clusteru. Zkontrolujte adresu URL, kterou používáte pro přístup k platformě Celonis, a načtěte z něj tým a cluster.
Celonis Intelligence API je rozhraní JSON API a jeho koncové body vždy vrátí odpověď JSON bez ohledu na úspěch požadavku.
Současné metody rozhraní API umožňují uživatelům pracovat s modely znalostí definovanými v celonis platformě tím, že poskytují následující funkce:
- Seznam dostupných modelů znalostí a jejich podrobností
- Seznam záznamů a jejich podrobností
- Seznam filtrů
- Data pro konkrétní záznam Podrobnosti o funkcích rozhraní API Celonis Intelligence na portálu pro vývojáře Celonis
Známé problémy a omezení
Omezování rychlosti
Rozhraní API inteligentních funkcí nebylo vytvořeno k hromadnému exportu dat RAW, ale k tomu, aby počítané výsledky a přehledy z dolování procesů byly dostupné pro platformy a aplikace třetích stran. Proto rozhraní Celonis API vynucuje omezení rychlosti. To znamená, že každý den je povolený jenom určitý počet požadavků a každý hovor může načíst určitý počet záznamů. Celonis si vyhrazuje právo kdykoli upravit limity sazeb tak, aby garantovaly vysoce kvalitní služby pro všechny klienty.
V případě, že klient opakovaně překročí limity rychlosti nebo se zapojí do chování, které se považuje za podezřelé, celonis si vyhrazuje právo na dočasné nebo trvalé omezení nebo pozastavení přístupu k rozhraní API pro daného klienta.
Když klient překročí počet požadavků za den, vrátí rozhraní Celonis API odpověď 429 (příliš mnoho požadavků), včetně hlavičky HTTP (x-ratelimit-reset), která označuje dobu (v sekundách), po kterou musí klient čekat, než bude možné zpracovat nový požadavek.
Následující hlavičky HTTP se také vrátí jako součást každého volání:
-
x-ratelimit-limit: Představuje maximální počet požadavků, které může klient provést v aktuálním časovém intervalu. -
x-ratelimit-remaining: Počet zbývajících požadavků v aktuálním časovém intervalu. V současné době má rozhraní API následující výchozí omezení:
Tabulka 1. Výchozí limity četnosti požadavků
|
Limit | Výchozí hodnoty | |--|---| | Maximální počet žádostí za den | 6000 žádosti za den | | Maximální počet požadavků za sekundu | 20 žádosti za sekundu | | Maximální počet povolených polí na požadavek v modelu znalostí | 200 pole/žádost | | Maximální počet záznamů na požadavek vrácený při volání koncového /data bodu | 50 records/request | | Celkový maximální počet záznamů, které lze načíst prostřednictvím koncového /data bodu | První 5.000 záznamy na filtrovanou/seřazenou tabulku | Předplatné triggeru také vynucuje omezování rychlosti. To znamená, že pro tým je možné vytvořit pouze určitý počet předplatných. Kromě toho bez ohledu na to, kolik odběrů se vytvoří, existuje maximální počet událostí, které je možné vygenerovat z rozhraní API pro uživatele třetích stran.
Pokud klient dosáhne maximálního počtu předplatných, bude muset odstranit existující předplatné, aby vytvořil nový.
Pokud klient dosáhne maximálního počtu událostí vygenerovaných z rozhraní API, zbývající data vytvořená platformou Celonis se zahodí.
Pokud klient přistupuje ke své denní kvótě, bude informován e-mailem na váš účet správce. První e-mail se odešle, když se překročí 80% kvóty a váš účet správce o tom informuje, že jste přes toto procento. Druhý e-mail se odešle, jakmile překročíte 100% kvóty.
V současné době má rozhraní API následující výchozí omezení:
Tabulka 2. Výchozí limity četnosti událostí
|
Limit | Výchozí hodnoty | |--|---| | Maximální počet předplatných/týmů | 10 | | Maximální počet událostí/den | 100,000 | Pokud chcete ověřit limity vašeho týmu, obraťte se na tým vašeho účtu.
Nejčastější dotazy
Projděte si část Nejčastější dotazy na portálu pro vývojáře Celonis.
Pokyny k nasazení
Povinné. Přidejte pokyny k nasazení tohoto konektoru jako vlastního konektoru.
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| výchozí | Parametry pro vytvoření připojení | Všechny oblasti | Nesdílitelné |
Výchozí
Použitelné: Všechny oblasti
Parametry pro vytvoření připojení
Toto připojení není možné sdílet. Pokud se power app sdílí s jiným uživatelem, zobrazí se výzva k explicitní vytvoření nového připojení.
| Název | Typ | Description | Povinné |
|---|---|---|---|
| Tým | řetězec | Zadejte celonisový tým. | Pravdivé |
| Cluster | řetězec | Zadejte cluster Celonis. | Pravdivé |
| Authorization | securestring | Autorizace pro toto rozhraní API | Pravdivé |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Aktualizuje předplatné. |
Aktualizuje předplatné. |
| Načte další stránku událostí, které se nepředaly kvůli neúspěšným odběrům. |
Načte další stránku událostí, pokud se nepředaly kvůli neúspěšným odběru. |
| Obnoví odběr a začne přijímat nové události, zahodí události historie. |
Obnoví pozastavené předplatné a začne znovu přijímat nové události a zahodí události historie. |
| Obnoví pozastavené předplatné, aby se začaly znovu přijímat události. |
Obnoví pozastavené předplatné, aby se začaly znovu přijímat události. |
| Odhlášení odběru triggeru odebráním všech dat předplatného |
Odhlášení odběru triggeru odebráním všech dat předplatného |
| Pozastaví odběr, aby přestal přijímat události. |
Pozastaví odběr, aby přestal přijímat události. |
| Vytvoří předplatné pro trigger. |
Vytvoří předplatné pro trigger. |
| Získání podrobností o km nejvyšší úrovně |
Model znalostí definovaný v týmu EMS |
| Získání podrobností o schématu záznamů KM nejvyšší úrovně |
Podrobnosti schématu záznamů nejvyšší úrovně |
| Získání seznamu aktivačních událostí km |
Seznam aktivačních událostí pro model znalostí |
| Získání seznamu dat záznamu KM |
Data záznamu v modelu znalostí |
| Získání seznamu filtrů km |
Seznam filtrů pro model znalostí |
| Získání seznamu KM |
Seznam modelů znalostí definovaných v týmu EMS |
| Získání seznamu předplatných |
Seznam všech vytvořených předplatných |
| Získání seznamu schématu záznamů KM |
Seznam schématu záznamů |
Aktualizuje předplatné.
Aktualizuje předplatné.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID předplatného
|
subscription_id | True | string |
ID předplatného, které bude zcela aktualizováno |
|
headers
|
headers | object |
Hlavičky zpětného volání mohou obsahovat ověřovací token, typ obsahu atd. |
|
|
protokol
|
protocol | True | string |
Pouze možná hodnota je HTTPS, což znamená, že identifikátor URI zpětného volání musí být platný https. |
|
URI
|
uri | True | string |
Identifikátor URI pro provedení zpětného volání z rozhraní API inteligentních funkcí po aktivaci triggeru |
|
konfigurace
|
configurations | array of string |
Konfigurace předplatného |
|
|
název
|
name | True | string |
Název předplatného |
Načte další stránku událostí, které se nepředaly kvůli neúspěšným odběrům.
Načte další stránku událostí, pokud se nepředaly kvůli neúspěšným odběru.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID předplatného
|
subscription_id | True | string |
ID předplatného, které načte neúspěšnou událost poslanou, maximálně 50 položek |
Návraty
- Stránka výsledku signálu
- SignalResultPage
Obnoví odběr a začne přijímat nové události, zahodí události historie.
Obnoví pozastavené předplatné a začne znovu přijímat nové události a zahodí události historie.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID předplatného
|
subscription_id | True | string |
ID předplatného se obnoví bez přijetí předaných událostí. |
Obnoví pozastavené předplatné, aby se začaly znovu přijímat události.
Obnoví pozastavené předplatné, aby se začaly znovu přijímat události.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID předplatného
|
subscription_id | True | string |
ID předplatného se obnoví a začne znovu přijímat událost. |
Odhlášení odběru triggeru odebráním všech dat předplatného
Odhlášení odběru triggeru odebráním všech dat předplatného
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID předplatného
|
subscription_id | True | string |
ID předplatného se odstraní. |
Pozastaví odběr, aby přestal přijímat události.
Pozastaví odběr, aby přestal přijímat události.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID předplatného
|
subscription_id | True | string |
ID předplatného se pozastaví. |
Vytvoří předplatné pro trigger.
Vytvoří předplatné pro trigger.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Km Id
|
km_id | True | string |
ID modelu znalostí |
|
ID triggeru
|
trigger_id | True | string |
ID triggeru |
|
headers
|
headers | object |
Hlavičky zpětného volání mohou obsahovat ověřovací token, typ obsahu atd. |
|
|
protokol
|
protocol | True | string |
Pouze možná hodnota je HTTPS, což znamená, že identifikátor URI zpětného volání musí být platný https. |
|
URI
|
uri | True | string |
Identifikátor URI pro provedení zpětného volání z rozhraní API inteligentních funkcí po aktivaci triggeru |
|
konfigurace
|
configurations | array of string |
Konfigurace předplatného |
|
|
název
|
name | True | string |
Název předplatného |
Návraty
- response
- string
Získání podrobností o km nejvyšší úrovně
Model znalostí definovaný v týmu EMS
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID modelu znalostí
|
km_id | True | string |
ID modelu znalostí |
Návraty
Struktura dat modelu znalostí
- Model znalostí
- knowledgeModelDetailedDTO
Získání podrobností o schématu záznamů KM nejvyšší úrovně
Podrobnosti schématu záznamů nejvyšší úrovně
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID modelu znalostí
|
km_id | True | string |
ID modelu znalostí |
|
ID záznamu
|
record_id | True | string |
ID záznamu |
Návraty
Záznam představuje koncept v rámci modelu znalostí.
- Typ záznamu
- recordDTO
Získání seznamu aktivačních událostí km
Seznam aktivačních událostí pro model znalostí
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledku počínaje 0 (první stránka) |
|
|
Velikost stránky
|
pageSize | integer |
Počet položek vrácených na stránce |
|
|
Seřadit
|
sort | string |
Definuje strategii, která má pokračovat pro řazení nerozlišující velká a malá písmena. Musí to být jenom jedno pole a mělo by začínat na +, aby se použilo pořadí ASC nebo -, aby se použilo pořadí DESC. Předpona se seřadí jako ASC. Ne existující pole v záhlaví vyvolá chybu. |
|
|
Km Id
|
km_id | True | string |
ID modelu znalostí |
Návraty
- Stránka s výsledky schématu aktivační události
- triggerResultPage
Získání seznamu dat záznamu KM
Data záznamu v modelu znalostí
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
ID modelu znalostí
|
km_id | True | string |
ID modelu znalostí |
|
ID záznamu
|
record_id | True | string |
ID záznamu |
|
Filtry
|
filters | array |
Předdefinované ID filtru |
|
|
ID polí
|
fields | True | array |
Předdefinované ID filtru |
|
Stránka
|
page | integer |
Číslo stránky výsledku počínaje 0 (první stránka) |
|
|
Velikost stránky
|
pageSize | integer |
Počet položek vrácených na stránce |
|
|
Řazení
|
sort | array |
Definuje strategii pro pokračování řazení. Musí se jednat o čárkami oddělený seznam polí. Pokud chcete použít pořadí DESC, musí začínat čárkou +. Pole bez předpony se seřadí jako ASC. Neexistující pole v hlavičce způsobí chybu. |
|
|
Výraz filtru
|
filterExpr | array |
Výrazy dynamického filtru |
Návraty
- Stránka výsledků záznamu dat
- recordResultPageDTO
Získání seznamu filtrů km
Seznam filtrů pro model znalostí
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledku počínaje 0 (první stránka) |
|
|
Velikost stránky
|
pageSize | integer |
Počet položek vrácených na stránce |
|
|
Řazení
|
sort | string |
Definuje strategii, která má pokračovat pro řazení nerozlišující velká a malá písmena. Musí to být jenom jedno pole a mělo by začínat na +, aby se použilo pořadí ASC nebo -, aby se použilo pořadí DESC. Předpona se seřadí jako ASC. Ne existující pole v záhlaví vyvolá chybu. |
|
|
ID modelu znalostí
|
km_id | True | string |
ID modelu znalostí |
Návraty
- Stránka s výsledky filtrování schématu
- filterResultPage
Získání seznamu KM
Seznam modelů znalostí definovaných v týmu EMS
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledku počínaje 0 (první stránka) |
|
|
Velikost stránky
|
pageSize | integer |
Počet položek vrácených na stránce |
|
|
Řazení
|
sort | string |
Definuje strategii, která má pokračovat pro řazení nerozlišující velká a malá písmena. Musí to být jenom jedno pole a mělo by začínat na +, aby se použilo pořadí ASC nebo -, aby se použilo pořadí DESC. Předpona se seřadí jako ASC. Ne existující pole v záhlaví vyvolá chybu. |
Návraty
- Stránka výsledků modelu KnowledgeModel
- knowledgeModelResultPage
Získání seznamu předplatných
Seznam všech vytvořených předplatných
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledku počínaje 0 (první stránka) |
|
|
Velikost stránky
|
pageSize | integer |
Počet položek vrácených na stránce |
|
|
Seřadit
|
sort | string |
Definuje strategii, která má pokračovat pro řazení nerozlišující velká a malá písmena. Musí to být jenom jedno pole a mělo by začínat na +, aby se použilo pořadí ASC nebo -, aby se použilo pořadí DESC. Předpona se seřadí jako ASC. Ne existující pole v záhlaví vyvolá chybu. |
Návraty
- Stránka s výsledky schématu předplatného
- subscriptionResultPage
Získání seznamu schématu záznamů KM
Seznam schématu záznamů
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Stránka
|
page | integer |
Číslo stránky výsledku počínaje 0 (první stránka) |
|
|
Velikost stránky
|
pageSize | integer |
Počet položek vrácených na stránce |
|
|
Řazení
|
sort | string |
Definuje strategii, která má pokračovat pro řazení nerozlišující velká a malá písmena. Musí to být jenom jedno pole a mělo by začínat na +, aby se použilo pořadí ASC nebo -, aby se použilo pořadí DESC. Předpona se seřadí jako ASC. Ne existující pole v záhlaví vyvolá chybu. |
|
|
ID modelu znalostí
|
km_id | True | string |
ID modelu znalostí |
Návraty
- Stránka výsledků záznamu schématu
- recordSchemaResultPage
Definice
SignalResultPage
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
obsah
|
content | array of signalDTO | |
|
pageSize
|
pageSize | integer |
Velikost stránky definovaná systémem |
filterDTO
Filtr, který se má použít v km
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
popis
|
description | string |
Popis filtru srozumitelný pro člověka |
|
identifikační číslo
|
id | string |
Jedinečný identifikátor filtru |
|
název
|
name | string |
Zobrazovaný název filtru srozumitelný pro člověka |
filterResultPage
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
page
|
page | integer |
Stránka |
|
pageSize
|
pageSize | integer |
Velikost stránky definovaná parametrem pageSize |
|
řadit
|
sort | string |
Pole použité k použití řazení na požadovaná data , + nebo žádný symbol znamená ASC, - znamená DESC |
|
totální
|
total | integer |
Celkový počet prvků vrácených na stránce |
|
obsah
|
content | array of filterDTO |
knowledgeModelDetailedDTO
Struktura dat modelu znalostí
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | string |
Jedinečný identifikátor modelu znalostí |
|
název
|
name | string |
Srozumitelný text člověka |
|
extendedKMId
|
extendedKMId | string |
Znalostní model, který se používá jako reference, základ KM. |
knowledgeModelResultPage
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
page
|
page | integer |
Stránka |
|
pageSize
|
pageSize | integer |
Velikost stránky definovaná parametrem pageSize |
|
řadit
|
sort | string |
Pole použité k použití řazení na požadovaná data , + nebo žádný symbol znamená ASC, - znamená DESC |
|
totální
|
total | integer |
Celkový počet prvků vrácených na stránce |
|
obsah
|
content | array of knowledgeModelSimplifiedDTO |
knowledgeModelSimplifiedDTO
Struktura dat modelu znalostí
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | string |
Jedinečný identifikátor modelu znalostí |
|
název
|
name | string |
Srozumitelný text člověka |
|
publikovaný
|
published | string |
Datum posledního publikování |
recordDTO
Záznam představuje koncept v rámci modelu znalostí.
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
popis
|
description | string |
Popis záznamu |
|
identifikační číslo
|
id | string |
Jedinečný identifikátor záznamu |
|
název
|
name | string |
Zobrazovaný název záznamu, srozumitelný název člověka |
|
pole
|
fields | array of recordFieldDTO |
recordFieldDTO
Pole pro záznam
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
format
|
format | string |
Formát, který se má použít |
|
identifikační číslo
|
id | string |
Částka čekající na zaplacení |
|
název
|
name | string |
lidsky srozumitelný název |
|
typ
|
type | string | |
|
jednotka
|
unit | string |
Jednotka přidaná k hodnotě pole |
recordIdDTO
ID a název typu záznamu
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
popis
|
description | string |
Popis záznamu |
|
identifikační číslo
|
id | string |
Jedinečný identifikátor záznamu |
|
název
|
name | string |
Zobrazovaný název záznamu, srozumitelný název člověka |
recordItemDTO
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
data
|
data | array of |
Seznam položek záznamu, složený s názvem a hodnotou |
|
headers
|
headers | array of recordItemHeaderDTO |
recordItemHeaderDTO
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
agregace
|
aggregation | boolean |
Označuje, jestli je pole agregací nebo počítanou informací(KPI). |
|
filtrovatelný
|
filterable | boolean |
Označuje, jestli je možné pole filtrovat. |
|
format
|
format | string |
Výraz formátu |
|
identifikační číslo
|
id | string |
Identita pole, která se má použít v parametru seznamu polí a parametru filterExpression |
|
název
|
name | string |
Srozumitelný text člověka |
|
setříditelný
|
sortable | boolean |
Označuje, jestli se pole dá seřadit. |
|
typ
|
type | string |
Možné datové typy. |
|
jednotka
|
unit | string |
Doplňkové znaménko pro zobrazení hodnot formátu |
recordResultPageDTO
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
page
|
page | integer |
Stránka |
|
pageSize
|
pageSize | integer |
Velikost stránky definovaná parametrem pageSize |
|
řadit
|
sort | array of string | |
|
totální
|
total | integer |
Celkový počet prvků vrácených na stránce |
|
Položka záznamu
|
content | recordItemDTO |
recordSchemaResultPage
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
page
|
page | integer |
Stránka |
|
pageSize
|
pageSize | integer |
Velikost stránky definovaná parametrem pageSize |
|
řadit
|
sort | string |
Pole použité k použití řazení na požadovaná data , + nebo žádný symbol znamená ASC, - znamená DESC |
|
totální
|
total | integer |
Celkový počet prvků vrácených na stránce |
|
obsah
|
content | array of recordIdDTO |
signalDTO
Signál uložený v předplatném
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
signal
|
signal | string |
Nezpracovaný kód JSON signálu |
|
subscriptionId
|
subscriptionId | string |
Jedinečný identifikátor odběratele jako SUID |
|
triggerId
|
triggerId | string |
Jedinečný identifikátor triggeru jako SUID |
|
datumVytvoření
|
creationDate | date-time |
Datum vytvoření signálu |
subscriptionDTO
Schéma předplatného
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
konfigurace
|
configurations | array of string |
Konfigurace předplatného |
|
identifikační číslo
|
id | string |
Jedinečný identifikátor odběratele jako SUID |
|
knowledgeModelId
|
knowledgeModelId | string |
Jedinečný identifikátor modelu znalostí |
|
latestSucceedEvent
|
latestSucceedEvent | date-time |
Datum poslední úspěšné události |
|
název
|
name | string |
Název předplatného, který je srozumitelný pro člověka |
|
stav
|
status | string | |
|
triggerId
|
triggerId | string |
Jedinečný identifikátor triggeru jako SUID |
subscriptionResultPage
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
page
|
page | integer |
Stránka |
|
pageSize
|
pageSize | integer |
Velikost stránky definovaná parametrem pageSize |
|
řadit
|
sort | string |
Pole použité k použití řazení na požadovaná data , + nebo žádný symbol znamená ASC, - znamená DESC |
|
totální
|
total | integer |
Celkový počet prvků vrácených na stránce |
|
obsah
|
content | array of subscriptionDTO |
triggerDTO
Aktivační událost definovaná v km
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
identifikační číslo
|
id | string |
Jedinečný identifikátor triggeru jako SUID |
|
název
|
name | string |
Název triggeru, který je srozumitelný pro člověka |
|
záznam
|
record | string |
Jedinečný identifikátor záznamu jako SUID |
triggerResultPage
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
page
|
page | integer |
Stránka |
|
pageSize
|
pageSize | integer |
Velikost stránky definovaná parametrem pageSize |
|
řadit
|
sort | string |
Pole použité k použití řazení na požadovaná data , + nebo žádný symbol znamená ASC, - znamená DESC |
|
totální
|
total | integer |
Celkový počet prvků vrácených na stránce |
|
obsah
|
content | array of triggerDTO |
řetězec
Toto je základní datový typ String.