Celonis (wersja zapoznawcza)
Interfejs API platformy Celonis do pracy z elementami modelu wiedzy, takimi jak rekordy, kluczowe wskaźniki wydajności, filtry, wyzwalacze i powiązane dane.
Ten łącznik jest dostępny w następujących produktach i regionach:
| Usługa | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Logic Apps | Standard | Wszystkie regiony usługi Logic Apps z wyjątkiem następujących: — Regiony platformy Azure Government — Regiony platformy Azure (Chiny) - Departament Obrony USA (DoD) |
| Power Apps | Premium | Wszystkie regiony usługi Power Apps z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Power Automate | Premium | Wszystkie regiony usługi Power Automate z wyjątkiem następujących: - Rząd USA (GCC) - Rząd USA (GCC High) - China Cloud obsługiwane przez firmę 21Vianet - Departament Obrony USA (DoD) |
| Kontakt | |
|---|---|
| Name | Obsługa celonis |
| adres URL | https://developer.celonis.com/ |
| intelligence-api-feedback-sc@celonis.de |
| Metadane łącznika | |
|---|---|
| Publisher | Celonis |
| Witryna internetowa | https://www.celonis.com |
| Zasady ochrony prywatności | https://www.celonis.com/privacy-policy/ |
| Kategorie | AI; Zarządzanie biznesem |
Title
Interfejs API analizy Celonis umożliwia klientom Celonis osadzanie analizy procesów z możliwością działania na platformach innych firm, na których użytkownicy końcowi mogą korzystać ze szczegółowych informacji o procesie Celonis. W ten sposób umożliwiłoby to celonisowi analizę, taką jak kluczowe wskaźniki wydajności procesów lub nieefektywność procesów, bliżej użytkowników końcowych i korzyści dla użytkowników operacyjnych bez bieżącego dostępu do Celonis, zapewniając cenne informacje na temat lepszego podejmowania decyzji podczas wykonywania codziennych działań. Oprócz możliwości zapytań dotyczących danych interfejs API analizy obsługuje również wypychanie danych na platformy innych firm, umożliwiając im subskrybowanie wyzwalaczy biznesowych.
Wydawca: Nazwa wydawcy
Wymagania wstępne
- Zespół w Celonis Platform.
- Model wiedzy dostępny w zespole klienta.
- Subskrypcja Celonis oparta na procesie (skontaktuj się z zespołem ds. kont, aby zweryfikować).
Obsługiwane operacje
Bieżące metody interfejsu API umożliwiają użytkownikom interakcję z modelami wiedzy zdefiniowanymi na platformie Celonis, zapewniając następujące funkcje:
Metody odnajdywania modelu wiedzy
Uzyskiwanie listy modeli wiedzy (KM)
Pobieranie listy rekordów km
Pobieranie szczegółów schematu rekordu km
Pobieranie listy filtrów km
Metody pobierania danych modelu wiedzy
Pobieranie listy danych rekordu km
Metody zarządzania cyklem życia subskrypcji
Pobieranie listy subskrypcji
Pobieranie listy wyzwalaczy km
Tworzenie subskrypcji do wyzwalacza KM
Aktualizowanie subskrypcji
Wstrzymywanie subskrypcji
Wznawianie subskrypcji
Kończenie subskrypcji
Uzyskiwanie poświadczeń
Authentication
Każde żądanie do interfejsu API musi być uwierzytelnione przy użyciu klucza interfejsu API Celonis. Istnieją dwa sposoby wykonania tego:
Używanie klucza interfejsu API użytkownika
Aby dowiedzieć się, jak utworzyć klucz interfejsu API użytkownika, zapoznaj się z naszym przewodnikiem Dotyczącym kluczy interfejsu API użytkownika . Interfejs API Celonis używa uwierzytelniania tokenu elementu nośnego do weryfikowania dostępu użytkowników. Poświadczenia muszą być wysyłane w nagłówku autoryzacji w żądaniu HTTP. Poświadczenia wysyłane w adresie URL lub treści żądania zostaną zignorowane. Aby uwierzytelnić się przy użyciu uwierzytelniania tokenu elementu nośnego:
- Utwórz token w usłudze Celonis:
MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM - Dołącz ciąg w nagłówku autoryzacji HTTP sformatowany w następujący sposób:
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
Używanie klucza interfejsu API aplikacji
Aby dowiedzieć się, jak utworzyć klucz aplikacji, zapoznaj się z naszym przewodnikiem Dotyczącym kluczy interfejsu API aplikacji . Aby uwierzytelnić się przy użyciu uwierzytelniania AppKey:
- Utwórz klucz aplikacji w usłudze Celonis:
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr - Dołącz ciąg w nagłówku autoryzacji HTTP sformatowany w następujący sposób:
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
Authorization
Musisz ustawić odpowiednie uprawnienia i upewnić się, że klucz interfejsu API użytkownika lub klucz interfejsu API aplikacji używany do celów autoryzacji ma dostęp do pakietu Celonis Studio zawierającego modele wiedzy, do których chcesz uzyskać dostęp za pośrednictwem interfejsów API analizy. Uprawnienia dostępu można udzielić, wykonując następujące kroki:
- Przejdź do pakietu Studio.
- Kliknij trzy kropki i wybierz z
Permissionsmenu podręcznego. - Wyszukaj użytkownika (jeśli używasz tokenu elementu nośnego ) lub AppKey (w przypadku korzystania z klucza AppKey ) i przyznaj co najmniej
USE PACKAGEprawa.
Wprowadzenie
Podstawowym adresem URL interfejsu API Celonis jest https://<team>.<cluster>.celonis.cloud/intelligence/api znalezienie zespołu i klastra. Sprawdź adres URL używany do uzyskiwania dostępu do platformy Celonis i pobierz z niego zespół i klaster.
Interfejs API analizy Celonis jest interfejsem API JSON, a jego punkty końcowe zawsze będą zwracać odpowiedź JSON, bez względu na powodzenie żądania.
Bieżące metody interfejsu API umożliwiają użytkownikom interakcję z modelami wiedzy zdefiniowanymi na platformie Celonis, zapewniając następujące funkcje:
- Lista dostępnych modeli wiedzy i ich szczegółów
- Lista rekordów i ich szczegółów
- Lista filtrów
- Dane dla określonego rekordu. Szczegółowe informacje o funkcjach interfejsu API analizy Celonis w portalu deweloperów Celonis.
Znane problemy i ograniczenia
Ograniczanie szybkości
Interfejs API analizy nie został skompilowany w celu zbiorczego eksportowania danych PIERWOTNYch, ale w celu udostępnienia obliczonych wyników i szczegółowych informacji z wyszukiwania procesów do platform i aplikacji innych firm. Dlatego interfejs API Celonis wymusza ograniczanie szybkości. Oznacza to, że w każdym wywołaniu może być dozwolona tylko określona liczba żądań, a w każdym wywołaniu można pobrać określoną liczbę rekordów. Celonis zastrzega sobie prawo do dostosowywania limitów szybkości w dowolnym momencie w celu zagwarantowania wysokiej jakości usług dla wszystkich klientów.
W przypadku, gdy klient wielokrotnie przekracza limity szybkości lub angażuje się w zachowanie, które jest uważane za podejrzane, Celonis zastrzega sobie prawo do tymczasowego lub trwałego ograniczenia lub zawieszenia dostępu do interfejsu API dla tego klienta.
Gdy klient przekroczy liczbę żądań dziennie, interfejs API Celonis zwróci odpowiedź 429 (zbyt wiele żądań), w tym nagłówek HTTP (x-ratelimit-reset), który wskazuje czas (w sekundach), który musi poczekać, zanim będzie można przetworzyć nowe żądanie.
Następujące nagłówki HTTP są również zwracane w ramach każdego wywołania:
-
x-ratelimit-limit: reprezentuje maksymalną liczbę żądań, które klient może wykonać w bieżącym przedziale czasu. -
x-ratelimit-remaining: liczba pozostałych żądań w bieżącym przedziale czasu. Obecnie interfejs API ma następujące limity domyślne:
Tabela 1. Domyślne limity szybkości żądań
|
Ograniczać | Wartości domyślne | |--|-| | Maksymalna liczba żądań/dni | 6000 żądania/dzień | | Maksymalna liczba żądań/sekund | 20 requests/second | | Maksymalna liczba dozwolonych pól na żądanie w modelu wiedzy | 200 fields/request | | Maksymalna liczba rekordów na żądanie zwróconych podczas wywoływania punktu końcowego /data | 50 rekordy/żądanie | | Całkowita maksymalna liczba rekordów, które można pobrać za pośrednictwem punktu końcowego /data | Pierwsze 5.000 rekordy na przefiltrowaną/posortowaną tabelę | Subskrypcja wyzwalacza wymusza również ograniczanie szybkości. Oznacza to, że dla zespołu można utworzyć tylko określoną liczbę subskrypcji. Ponadto niezależnie od liczby utworzonych subskrypcji istnieje maksymalna liczba zdarzeń, które mogą być emitowane z interfejsu API do użytkowników innych firm.
Jeśli klient osiągnie maksymalną liczbę subskrypcji, będzie musiał usunąć istniejącą subskrypcję, aby utworzyć nową.
Jeśli klient osiągnie maksymalną liczbę zdarzeń emitowanych z interfejsu API, pozostałe dane generowane przez platformę Celonis zostaną odrzucone.
Jeśli klient zbliża się do dziennego limitu przydziału, zostanie poinformowany za pośrednictwem wiadomości e-mail na koncie administratora. Pierwsza wiadomość e-mail zostanie wysłana po przekroczeniu 80% limitu przydziału, dzięki czemu konto administratora będzie wiedzieć, że przekraczasz ten procent. Druga wiadomość e-mail zostanie wysłana zaraz po przekroczeniu 100% limitu przydziału.
Obecnie interfejs API ma następujące limity domyślne:
Tabela 2. Domyślne limity szybkości zdarzeń
|
Ograniczać | Wartości domyślne | |--|-| | Maksymalna liczba subskrypcji/zespołu | 10 | | Maksymalna liczba zdarzeń/dzień | 100,000 | Skontaktuj się z zespołem ds. kont, aby zweryfikować limity twojego zespołu.
Często zadawane pytania
Zapoznaj się z sekcją Często zadawane pytania w portalu deweloperów Celonis.
Instrukcje dotyczące wdrażania
To jest wymagane. Dodaj instrukcje dotyczące wdrażania tego łącznika jako łącznika niestandardowego.
Tworzenie połączenia
Łącznik obsługuje następujące typy uwierzytelniania:
| Wartość domyślna | Parametry tworzenia połączenia. | Wszystkie regiony | Nie można udostępniać |
Domyślny
Dotyczy: wszystkie regiony
Parametry tworzenia połączenia.
Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.
| Name | Typ | Description | Wymagane |
|---|---|---|---|
| Zespół | ciąg | Określ zespół Celonis. | Prawda |
| Klaster | ciąg | Określ klaster Celonis. | Prawda |
| Authorization | securestring | Autoryzacja dla tego interfejsu API | Prawda |
Limity ograniczania
| Nazwa | Wywołania | Okres odnowienia |
|---|---|---|
| Wywołania interfejsu API na połączenie | 100 | 60 sekund |
Akcje
| Aktualizuje subskrypcję |
Aktualizuje subskrypcję |
| Anulowanie subskrypcji wyzwalacza usuwającego wszystkie dane dla subskrypcji |
Anulowanie subskrypcji wyzwalacza usuwającego wszystkie dane dla subskrypcji |
| Pobiera następną stronę zdarzeń, które nie zostały przekazane z powodu nieudanej subskrypcji |
Pobiera następną stronę zdarzeń, jeśli nie zostały przekazane z powodu nieudanej subskrypcji |
| Pobieranie listy danych rekordu km |
Dane rekordu w modelu wiedzy |
| Pobieranie listy filtrów km |
Lista filtrów dla modelu wiedzy |
| Pobieranie listy maszyn wirtualnych |
Lista modeli wiedzy zdefiniowanych w zespole pakietu EMS |
| Pobieranie listy schematu rekordów km |
Lista schematów rekordów |
| Pobieranie listy subskrypcji |
Lista wszystkich utworzonych subskrypcji |
| Pobieranie listy wyzwalaczy km |
Lista wyzwalaczy dla modelu wiedzy |
| Pobieranie szczegółów schematu rekordu km najwyższego poziomu |
Szczegóły schematu rekordu najwyższego poziomu |
| Tworzy subskrypcję wyzwalacza |
Tworzy subskrypcję wyzwalacza |
| Uzyskiwanie szczegółów km najwyższego poziomu |
Model wiedzy zdefiniowany w zespole pakietu EMS |
| Wstrzymuje subskrypcję, aby zatrzymać odbieranie zdarzeń |
Wstrzymuje subskrypcję, aby zatrzymać odbieranie zdarzeń |
| Wznawia subskrypcję, aby rozpocząć odbieranie nowych zdarzeń, odrzucanie zdarzeń historii |
Wznawia wstrzymaną subskrypcję, aby ponownie rozpocząć odbieranie nowych zdarzeń, odrzucając zdarzenia historii |
| Wznawia wstrzymaną subskrypcję, aby ponownie rozpocząć odbieranie zdarzeń |
Wznawia wstrzymaną subskrypcję, aby ponownie rozpocząć odbieranie zdarzeń |
Aktualizuje subskrypcję
Aktualizuje subskrypcję
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator subskrypcji
|
subscription_id | True | string |
Identyfikator subskrypcji, który zostanie całkowicie zaktualizowany |
|
headers
|
headers | object |
Nagłówki wywołania zwrotnego mogą zawierać token uwierzytelniania, typ zawartości itp. |
|
|
protokół
|
protocol | True | string |
Jedyną możliwą wartością jest protokół HTTPS, co oznacza, że identyfikator URI wywołania zwrotnego musi być prawidłowym https |
|
URI
|
uri | True | string |
Identyfikator URI do wykonania wywołania zwrotnego z interfejsu API analizy po wyzwoleniu wyzwalacza |
|
configurations
|
configurations | array of string |
Konfiguracja subskrypcji |
|
|
nazwa
|
name | True | string |
Nazwa subskrypcji |
Anulowanie subskrypcji wyzwalacza usuwającego wszystkie dane dla subskrypcji
Anulowanie subskrypcji wyzwalacza usuwającego wszystkie dane dla subskrypcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator subskrypcji
|
subscription_id | True | string |
Identyfikator subskrypcji zostanie usunięty |
Pobiera następną stronę zdarzeń, które nie zostały przekazane z powodu nieudanej subskrypcji
Pobiera następną stronę zdarzeń, jeśli nie zostały przekazane z powodu nieudanej subskrypcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator subskrypcji
|
subscription_id | True | string |
Identyfikator subskrypcji, który pobierze wysłane zdarzenie, które nie powiodło się, w maksymalnie 50 elementach |
Zwraca
- Strona wyników sygnału
- SignalResultPage
Pobieranie listy danych rekordu km
Dane rekordu w modelu wiedzy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator modelu wiedzy
|
km_id | True | string |
Identyfikator modelu wiedzy |
|
Identyfikator rekordu
|
record_id | True | string |
Identyfikator rekordu |
|
Filtry
|
filters | array |
Wstępnie zdefiniowany identyfikator filtru |
|
|
Identyfikatory pól
|
fields | True | array |
Wstępnie zdefiniowany identyfikator filtru |
|
Strona
|
page | integer |
Numer strony wyniku, zaczynając od 0 (pierwsza strona) |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba elementów zwróconych na stronie. |
|
|
Sortowanie
|
sort | array |
Definiuje strategię, aby kontynuować sortowanie. Musi to być rozdzielona przecinkami lista pól i powinna zaczynać się od ciągu "+", aby zastosować kolejność usługi ASC lub "-", aby zastosować kolejność DESC. Pola bez prefiksu zostaną posortowane jako usługa ASC. Nieistniene pola w nagłówku spowodują wystąpienie błędu |
|
|
Wyrażenie filtru
|
filterExpr | array |
Wyrażenia filtru dynamicznego |
Zwraca
- Strona wyników rekordów danych
- recordResultPageDTO
Pobieranie listy filtrów km
Lista filtrów dla modelu wiedzy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyniku, zaczynając od 0 (pierwsza strona) |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba elementów zwróconych na stronie. |
|
|
Sortowanie
|
sort | string |
Definiuje strategię kontynuowania sortowania bez uwzględniania wielkości liter. Musi to być tylko jedno pole i powinno zaczynać się od ciągu "+", aby zastosować kolejność usługi ASC lub "-", aby zastosować kolejność DESC. Prefiks nie będzie sortować jako ASC. Brak istniejącego pola w nagłówku spowoduje zgłoszenie błędu |
|
|
Identyfikator modelu wiedzy
|
km_id | True | string |
Identyfikator modelu wiedzy |
Zwraca
- Filtruj stronę wyników schematu
- filterResultPage
Pobieranie listy maszyn wirtualnych
Lista modeli wiedzy zdefiniowanych w zespole pakietu EMS
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyniku, zaczynając od 0 (pierwsza strona) |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba elementów zwróconych na stronie. |
|
|
Sortowanie
|
sort | string |
Definiuje strategię kontynuowania sortowania bez uwzględniania wielkości liter. Musi to być tylko jedno pole i powinno zaczynać się od ciągu "+", aby zastosować kolejność usługi ASC lub "-", aby zastosować kolejność DESC. Prefiks nie będzie sortować jako ASC. Brak istniejącego pola w nagłówku spowoduje zgłoszenie błędu |
Zwraca
- Strona wyników modelu KnowledgeModel
- knowledgeModelResultPage
Pobieranie listy schematu rekordów km
Lista schematów rekordów
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyniku, zaczynając od 0 (pierwsza strona) |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba elementów zwróconych na stronie. |
|
|
Sortowanie
|
sort | string |
Definiuje strategię kontynuowania sortowania bez uwzględniania wielkości liter. Musi to być tylko jedno pole i powinno zaczynać się od ciągu "+", aby zastosować kolejność usługi ASC lub "-", aby zastosować kolejność DESC. Prefiks nie będzie sortować jako ASC. Brak istniejącego pola w nagłówku spowoduje zgłoszenie błędu |
|
|
Identyfikator modelu wiedzy
|
km_id | True | string |
Identyfikator modelu wiedzy |
Zwraca
- Strona wyników schematu rekordu
- recordSchemaResultPage
Pobieranie listy subskrypcji
Lista wszystkich utworzonych subskrypcji
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyniku, zaczynając od 0 (pierwsza strona) |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba elementów zwróconych na stronie. |
|
|
Sortuj
|
sort | string |
Definiuje strategię kontynuowania sortowania bez uwzględniania wielkości liter. Musi to być tylko jedno pole i powinno zaczynać się od ciągu "+", aby zastosować kolejność usługi ASC lub "-", aby zastosować kolejność DESC. Prefiks nie będzie sortować jako ASC. Brak istniejącego pola w nagłówku spowoduje zgłoszenie błędu |
Zwraca
- Strona wyników schematu subskrypcji
- subscriptionResultPage
Pobieranie listy wyzwalaczy km
Lista wyzwalaczy dla modelu wiedzy
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Strona
|
page | integer |
Numer strony wyniku, zaczynając od 0 (pierwsza strona) |
|
|
Rozmiar strony
|
pageSize | integer |
Liczba elementów zwróconych na stronie. |
|
|
Sortuj
|
sort | string |
Definiuje strategię kontynuowania sortowania bez uwzględniania wielkości liter. Musi to być tylko jedno pole i powinno zaczynać się od ciągu "+", aby zastosować kolejność usługi ASC lub "-", aby zastosować kolejność DESC. Prefiks nie będzie sortować jako ASC. Brak istniejącego pola w nagłówku spowoduje zgłoszenie błędu |
|
|
Identyfikator km
|
km_id | True | string |
Identyfikator modelu wiedzy |
Zwraca
- Strona wyniku wyzwalania schematu
- triggerResultPage
Pobieranie szczegółów schematu rekordu km najwyższego poziomu
Szczegóły schematu rekordu najwyższego poziomu
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator modelu wiedzy
|
km_id | True | string |
Identyfikator modelu wiedzy |
|
Identyfikator rekordu
|
record_id | True | string |
Identyfikator rekordu |
Zwraca
Rekord reprezentuje koncepcję w modelu wiedzy
- Typ rekordu
- recordDTO
Tworzy subskrypcję wyzwalacza
Tworzy subskrypcję wyzwalacza
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator km
|
km_id | True | string |
Identyfikator modelu wiedzy |
|
Identyfikator wyzwalacza
|
trigger_id | True | string |
Identyfikator wyzwalacza |
|
headers
|
headers | object |
Nagłówki wywołania zwrotnego mogą zawierać token uwierzytelniania, typ zawartości itp. |
|
|
protokół
|
protocol | True | string |
Jedyną możliwą wartością jest protokół HTTPS, co oznacza, że identyfikator URI wywołania zwrotnego musi być prawidłowym https |
|
URI
|
uri | True | string |
Identyfikator URI do wykonania wywołania zwrotnego z interfejsu API analizy po wyzwoleniu wyzwalacza |
|
configurations
|
configurations | array of string |
Konfiguracja subskrypcji |
|
|
nazwa
|
name | True | string |
Nazwa subskrypcji |
Zwraca
- response
- string
Uzyskiwanie szczegółów km najwyższego poziomu
Model wiedzy zdefiniowany w zespole pakietu EMS
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator modelu wiedzy
|
km_id | True | string |
Identyfikator modelu wiedzy |
Zwraca
Struktura danych modelu wiedzy
- Model wiedzy
- knowledgeModelDetailedDTO
Wstrzymuje subskrypcję, aby zatrzymać odbieranie zdarzeń
Wstrzymuje subskrypcję, aby zatrzymać odbieranie zdarzeń
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator subskrypcji
|
subscription_id | True | string |
Identyfikator subskrypcji zostanie wstrzymany |
Wznawia subskrypcję, aby rozpocząć odbieranie nowych zdarzeń, odrzucanie zdarzeń historii
Wznawia wstrzymaną subskrypcję, aby ponownie rozpocząć odbieranie nowych zdarzeń, odrzucając zdarzenia historii
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator subskrypcji
|
subscription_id | True | string |
Identyfikator subskrypcji zostanie wznowiony bez odbierania przekazanych zdarzeń |
Wznawia wstrzymaną subskrypcję, aby ponownie rozpocząć odbieranie zdarzeń
Wznawia wstrzymaną subskrypcję, aby ponownie rozpocząć odbieranie zdarzeń
Parametry
| Nazwa | Klucz | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
Identyfikator subskrypcji
|
subscription_id | True | string |
Identyfikator subskrypcji zostanie wznowiony i ponownie rozpocznie się odbieranie zdarzenia |
Definicje
SignalResultPage
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
zawartość
|
content | array of signalDTO | |
|
pageSize
|
pageSize | integer |
Rozmiar strony zdefiniowany przez system |
filterDTO
Filtr do zastosowania w km
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
opis
|
description | string |
Opis filtru zrozumiałego dla człowieka |
|
id
|
id | string |
Unikatowy identyfikator filtru |
|
nazwa
|
name | string |
Zrozumiała dla człowieka nazwa wyświetlana filtru |
filterResultPage
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
page
|
page | integer |
Strona |
|
pageSize
|
pageSize | integer |
Rozmiar strony zdefiniowany przez parametr pageSize |
|
sortować
|
sort | string |
Pole używane do stosowania sortowania do żądanych danych, + lub bez symbolu oznacza ASC, — oznacza DESC |
|
łączny
|
total | integer |
Całkowita liczba elementów zwróconych na stronie |
|
zawartość
|
content | array of filterDTO |
knowledgeModelDetailedDTO
Struktura danych modelu wiedzy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator modelu wiedzy |
|
nazwa
|
name | string |
Zrozumiały dla człowieka tekst |
|
extendedKMId
|
extendedKMId | string |
Model wiedzy używany jako odwołanie, baza km. |
knowledgeModelResultPage
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
page
|
page | integer |
Strona |
|
pageSize
|
pageSize | integer |
Rozmiar strony zdefiniowany przez parametr pageSize |
|
sortować
|
sort | string |
Pole używane do stosowania sortowania do żądanych danych, + lub bez symbolu oznacza ASC, — oznacza DESC |
|
łączny
|
total | integer |
Całkowita liczba elementów zwróconych na stronie |
|
zawartość
|
content | array of knowledgeModelSimplifiedDTO |
knowledgeModelSimplifiedDTO
Struktura danych modelu wiedzy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator modelu wiedzy |
|
nazwa
|
name | string |
Zrozumiały dla człowieka tekst |
|
Opublikowany
|
published | string |
Data najnowszej publikacji |
recordDTO
Rekord reprezentuje koncepcję w modelu wiedzy
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
opis
|
description | string |
Opis rekordu |
|
id
|
id | string |
Unikatowy identyfikator rekordu |
|
nazwa
|
name | string |
Nazwa wyświetlana rekordu, zrozumiała dla człowieka nazwa |
|
pola
|
fields | array of recordFieldDTO |
recordFieldDTO
Pola dla rekordu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
format
|
format | string |
Format do zastosowania |
|
id
|
id | string |
Kwota oczekująca na zapłatę |
|
nazwa
|
name | string |
zrozumiała dla człowieka nazwa |
|
typ
|
type | string | |
|
jednostka
|
unit | string |
Jednostka dodana do wartości pola |
recordIdDTO
Identyfikator i nazwa typu rekordu
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
opis
|
description | string |
Opis rekordu |
|
id
|
id | string |
Unikatowy identyfikator rekordu |
|
nazwa
|
name | string |
Nazwa wyświetlana rekordu, zrozumiała dla człowieka nazwa |
recordItemDTO
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
dane
|
data | array of |
Lista elementu rekordu, złożone z nazwą i wartością |
|
headers
|
headers | array of recordItemHeaderDTO |
recordItemHeaderDTO
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
agregacja
|
aggregation | boolean |
Określ, czy pole jest agregacją/informacjami obliczeniowym (KPI). |
|
Filtrowanie
|
filterable | boolean |
Określ, czy pole może być filtrowane. |
|
format
|
format | string |
Wyrażenie formatu |
|
id
|
id | string |
Tożsamość pola do użycia w parametrach listy pól i parametrach filterExpression |
|
nazwa
|
name | string |
Zrozumiały dla człowieka tekst |
|
Sortowanie
|
sortable | boolean |
Wskaż, czy pole może być posortowane. |
|
typ
|
type | string |
Możliwe typy danych. |
|
jednostka
|
unit | string |
Znak uzupełniający dla widoku wartości formatu |
recordResultPageDTO
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
page
|
page | integer |
Strona |
|
pageSize
|
pageSize | integer |
Rozmiar strony zdefiniowany przez parametr pageSize |
|
sortować
|
sort | array of string | |
|
łączny
|
total | integer |
Całkowita liczba elementów zwróconych na stronie |
|
Element rekordu
|
content | recordItemDTO |
recordSchemaResultPage
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
page
|
page | integer |
Strona |
|
pageSize
|
pageSize | integer |
Rozmiar strony zdefiniowany przez parametr pageSize |
|
sortować
|
sort | string |
Pole używane do stosowania sortowania do żądanych danych, + lub bez symbolu oznacza ASC, — oznacza DESC |
|
łączny
|
total | integer |
Całkowita liczba elementów zwróconych na stronie |
|
zawartość
|
content | array of recordIdDTO |
signalDTO
Sygnał przechowywany w subskrypcji
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
signal
|
signal | string |
Nieprzetworzone dane json sygnału |
|
Identyfikator subskrypcji
|
subscriptionId | string |
Unikatowy identyfikator subskrybenta jako identyfikator SUID |
|
triggerId
|
triggerId | string |
Unikatowy identyfikator wyzwalacza jako identyfikator SUID |
|
creationDate (data utworzenia)
|
creationDate | date-time |
Data utworzenia sygnału |
subscriptionDTO
Schemat subskrypcji
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
configurations
|
configurations | array of string |
Konfiguracja subskrypcji |
|
id
|
id | string |
Unikatowy identyfikator subskrybenta jako identyfikator SUID |
|
knowledgeModelId
|
knowledgeModelId | string |
Unikatowy identyfikator modelu wiedzy |
|
latestSucceedEvent
|
latestSucceedEvent | date-time |
Data ostatniego zdarzenia zakończonego powodzeniem |
|
nazwa
|
name | string |
Zrozumiała dla człowieka nazwa subskrypcji |
|
stan
|
status | string | |
|
triggerId
|
triggerId | string |
Unikatowy identyfikator wyzwalacza jako identyfikator SUID |
subscriptionResultPage
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
page
|
page | integer |
Strona |
|
pageSize
|
pageSize | integer |
Rozmiar strony zdefiniowany przez parametr pageSize |
|
sortować
|
sort | string |
Pole używane do stosowania sortowania do żądanych danych, + lub bez symbolu oznacza ASC, — oznacza DESC |
|
łączny
|
total | integer |
Całkowita liczba elementów zwróconych na stronie |
|
zawartość
|
content | array of subscriptionDTO |
triggerDTO
Wyzwalacz zdefiniowany w km
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
id
|
id | string |
Unikatowy identyfikator wyzwalacza jako identyfikator SUID |
|
nazwa
|
name | string |
Zrozumiała dla człowieka nazwa wyzwalacza |
|
rekord
|
record | string |
Unikatowy identyfikator rekordu jako identyfikator SUID |
triggerResultPage
| Nazwa | Ścieżka | Typ | Opis |
|---|---|---|---|
|
page
|
page | integer |
Strona |
|
pageSize
|
pageSize | integer |
Rozmiar strony zdefiniowany przez parametr pageSize |
|
sortować
|
sort | string |
Pole używane do stosowania sortowania do żądanych danych, + lub bez symbolu oznacza ASC, — oznacza DESC |
|
łączny
|
total | integer |
Całkowita liczba elementów zwróconych na stronie |
|
zawartość
|
content | array of triggerDTO |
ciąg
Jest to podstawowy typ danych "string".