Celonis (Önizleme)
Kayıtlar, KPI'ler, filtreler, tetikleyiciler ve bunların ilgili verileri gibi Bilgi Modeli öğeleriyle çalışmak için Celonis Platform API'si.
Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:
| Hizmet | Class | Bölgeler |
|---|---|---|
| Copilot Studio | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Logic Apps | Standart | Aşağıdakiler dışında tüm Logic Apps bölgeleri : - Azure Kamu bölgeleri - Azure Çin bölgeleri - ABD Savunma Bakanlığı (DoD) |
| Power Apps | Premium | Aşağıdakiler dışında tüm Power Apps bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| Power Automate | Premium | Aşağıdakiler dışında tüm Power Automate bölgeleri : - ABD Kamu (GCC) - US Government (GCC High) - 21Vianet tarafından işletilen Çin Bulutu - ABD Savunma Bakanlığı (DoD) |
| İletişim | |
|---|---|
| İsim | Celonis Desteği |
| URL | https://developer.celonis.com/ |
| E-posta | intelligence-api-feedback-sc@celonis.de |
| Bağlayıcı Meta Verileri | |
|---|---|
| Publisher | Celonis |
| Web sitesi | https://www.celonis.com |
| Gizlilik ilkesi | https://www.celonis.com/privacy-policy/ |
| Kategoriler | AI; İş Yönetimi |
Başlık
Celonis Intelligence API,Celonis müşterilerinin son kullanıcıların Celonis süreç içgörülerinden yararlanabileceği üçüncü taraf platformlara eyleme dönüştürülebilir işlem zekası eklemesine olanak sağlar. Bu şekilde, süreç KPI'leri veya süreç verimsizlikleri gibi Celonis zekasını son kullanıcılara yaklaştıracak ve günlük etkinliklerini yürütürken daha iyi karar almaları için değerli içgörüler sağlayarak Celonis'e güncel erişimi olmayan operasyonel kullanıcılara fayda sağlayacaktır. Veri sorgusu özelliğinin dışında, Zeka API'si iş tetikleyicilerine abone olmalarını sağlayarak verileri üçüncü taraf platformlara göndermeyi de destekler.
Yayımcı: Publisher'ın Adı
Önkoşullar
- Celonis Platformu'nda bir ekip.
- İstemcinin ekibinde kullanılabilen bilgi modeli .
- İşlem tabanlı Celonis Aboneliği (doğrulamak için hesap ekibinize başvurun).
Desteklenen İşlemler
Geçerli API yöntemleri, tüketicilerin aşağıdaki işlevleri sağlayarak Celonis Platformu'nda tanımlanan Bilgi Modelleri ile etkileşim kurmasına olanak tanır:
Bilgi Modeli Bulma Yöntemleri
Bilgi Modellerinin (KM) listesini alma
KM Kayıtlarının listesini alma
KM Kayıt Şeması Ayrıntılarını Alma
KM Filtrelerinin listesini alma
Bilgi Modeli Veri Alma Yöntemleri
KM Kaydı verilerinin listesini alma
Abonelik Yaşam Döngüsü Yönetim Yöntemleri
Aboneliklerin listesini alma
KM Tetikleyicilerinin listesini alma
KM Tetikleyicisine Abonelik Oluşturma
Aboneliği Güncelleştirme
Aboneliği Duraklatma
Aboneliği Sürdürme
Aboneliği Sonlandırma
Kimlik Bilgilerini Alma
Authentication
API'ye yapılan her isteğin kimliği bir Celonis API anahtarıyla doğrulanmalıdır. Bunu yapmanın iki yolu vardır:
Kullanıcı API'si anahtarı kullanma
Kullanıcı API Anahtarları kılavuzumuzu izleyerek kullanıcı API'si anahtarı oluşturmayı öğrenebilirsiniz. Celonis API'sinde tüketici erişimini doğrulamak için Taşıyıcı Belirteci Kimlik Doğrulaması kullanılır. Kimlik bilgileri HTTP isteğinde bir Yetkilendirme üst bilgisinde gönderilmelidir. İsteğin URL'sinde veya gövdesinde gönderilen kimlik bilgileri yoksayılır. Taşıyıcı Belirteci Kimlik Doğrulaması kullanarak kimlik doğrulaması yapmak için:
- Celonis'te belirteci oluşturun:
MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM - Dizeyi HTTP Yetkilendirmesi üst bilgisine şu şekilde biçimlendirilmiş şekilde ekleyin:
Authorization: **Bearer** MDg5MGVkNDktNjMwZC00ODdiLTkyNGItMjNmMzMxNjRmM2IwOkhNUVRMUis4SGh6NHhBY21Vck9GaWdkem5rYzBrb3p0N056WUM0bGlqczMM
Uygulama API anahtarı kullanma
Uygulama API Anahtarları kılavuzumuzu izleyerek AppKey oluşturmayı öğrenebilirsiniz. AppKey Kimlik Doğrulaması kullanarak kimlik doğrulaması yapmak için:
- Celonis'te AppKey'i oluşturun:
MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr - Dizeyi HTTP Yetkilendirmesi üst bilgisine şu şekilde biçimlendirilmiş şekilde ekleyin:
Authorization: **AppKey** MzgyZDEzYjItNjI1MS00NTIwLTk1YTItY2ZjYzMzZTllOTNmOkE3a1dvYnpYQ0c3aUtUdTNRNC9UNzFLUXZmY0E2ZjVXUUROajFoN1R5UzIr
Authorization
Doğru izinleri ayarlamanız ve Yetkilendirme amacıyla yararlanılan Kullanıcı API Anahtarının veya Uygulama API Anahtarı'nın Akıllı API'ler aracılığıyla erişmek istediğiniz Bilgi Modellerini içeren Celonis Studio paketine erişimi olduğundan emin olmanız gerekir. Şu adımları izleyerek erişim izinleri verilmektedir:
- Studio paketine gidin.
- Üç noktaya tıklayın ve açılır menüden seçin
Permissions. - Kullanıcı ( Taşıyıcı belirteci kullanıyorsanız) veya AppKey ( AppKey kullanıyorsanız) için arama yapıp en az
USE PACKAGEhak verin.
Başlangıç Yapmak
Celonis API'sinin https://<team>.<cluster>.celonis.cloud/intelligence/api temel URL'si ekibi ve kümeyi bulmak için lütfen Celonis Platformu'na erişmek ve ekibi ve kümeyi buradan almak için kullandığınız URL'yi denetleyin.
Celonis Intelligence API bir JSON API'dir ve isteğin başarısı ne olursa olsun uç noktaları her zaman bir JSON yanıtı döndürür.
Geçerli API yöntemleri, tüketicilerin aşağıdaki işlevleri sağlayarak Celonis Platformu'nda tanımlanan Bilgi Modelleri ile etkileşim kurmasına olanak tanır:
- Kullanılabilir Bilgi Modelleri ve bunların ayrıntıları listesi
- Kayıtların listesi ve bunların ayrıntıları
- Filtre listesi
- Belirli bir kaydın verileri. Celonis geliştirici portalında Celonis Intelligence API Özellikleri hakkında ayrıntılar.
Bilinen Sorunlar ve Sınırlamalar
Hız sınırlaması
Akıllı Zeka API'si, RAW verilerini toplu olarak dışarı aktarmak için değil, işlem madenciliğinde elde edilen hesaplanan sonuçları ve içgörüleri üçüncü taraf platformlar ve uygulamalar için kullanılabilir hale getirmek için oluşturulmuştu. Bu nedenle Celonis API'sinde hız sınırlaması uygulanır. Bu, günde yalnızca belirli sayıda isteğe izin verileceği ve her çağrıda belirli sayıda kaydın alınabileceği anlamına gelir. Celonis, tüm müşteriler için yüksek kaliteli hizmeti garanti etmek için herhangi bir zamanda hız sınırlarını ayarlama hakkını saklıdır.
Bir istemcinin hız sınırlarını art arda aşması veya şüpheli olduğu kabul edilen davranışlarda bulunması durumunda Celonis, söz konusu istemci için API'ye erişimi geçici veya kalıcı olarak sınırlama veya askıya alma hakkını saklı tutmektedir.
bir istemci günlük istek sayısını aştığında, Celonis API'si yeni bir isteğin işlenebilmesi için istemcinin beklemesi gereken süreyi (saniye cinsinden) belirten bir HTTP üst bilgisi (x-ratelimit-reset) içeren 429 yanıt (çok fazla istek) döndürür.
Aşağıdaki HTTP üst bilgileri de her çağrının bir parçası olarak döndürülür:
-
x-ratelimit-limit: İstemcinin geçerli zaman penceresinde gerçekleştirebileceği en fazla istek sayısını temsil eder. -
x-ratelimit-remaining: Geçerli zaman penceresinde kalan isteklerin sayısı. Şu anda API aşağıdaki varsayılan sınırlara sahiptir:
Tablo 1. Varsayılan istek oranı sınırları
|
Sınırlamak | Varsayılan Değerler | |--|--| | En fazla istek/gün sayısı | 6000 istekler/gün | | En fazla istek/saniye sayısı | 20 istekler/saniye | | Bilgi Modeli'nde istek başına izin verilen en fazla alan sayısı | 200 fields/request | | Uç nokta çağrılırken /data döndürülen istek başına en fazla kayıt sayısı | 50 kayıtlar/istek | | | uç noktası üzerinden /data alınabilecek toplam kayıt sayısı üst sınırı Filtrelenmiş/sıralanmış tablo başına ilk 5.000 kayıtlar | Tetikleyici aboneliği de hız sınırlamasını zorunluyor. Bu, bir ekip için yalnızca belirli sayıda abonelik oluşturulabileceği anlamına gelir. Ayrıca, kaç abonelik oluşturulursa oluşturulsın, API'den üçüncü taraf tüketicilere yayılabilir en fazla olay sayısı vardır.
bir istemci en fazla abonelik sayısına ulaşırsa, yeni bir abonelik oluşturmak için mevcut bir aboneliği silmesi gerekir.
bir istemci API'den yayılan en fazla olay sayısına ulaşırsa, Celonis Platformu tarafından üretilen verilerin geri kalanı atılır.
İstemci günlük kotasına yaklaşıyorsa, yönetici hesabınıza e-posta yoluyla bilgilendirilir. İlk e-posta, kotanın 80% aşıldığında gönderilir ve yönetici hesabınız bu yüzdeyi aştığınızı bildirir. kotanın 100% aştığınızda ikinci e-posta gönderilir.
Şu anda API aşağıdaki varsayılan sınırlara sahiptir:
Tablo 2. Varsayılan olay hızı sınırları
|
Sınırlamak | Varsayılan Değerler | |--|--| | En fazla abonelik/ekip sayısı | 10 | | En fazla olay/gün sayısı | 100,000 | Ekibinizin sınırlarını doğrulamak için lütfen hesap ekibinize başvurun.
Sık Sorulan Sorular
Lütfen Celonis Geliştirici Portalı'ndaki Sık Sorulan Sorular bölümüne bakın.
Dağıtım Yönergeleri
Gerekli. Bu bağlayıcıyı özel bağlayıcı olarak dağıtma yönergelerini ekleyin.
Bağlantı oluşturma
Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:
| Varsayılan | Bağlantı oluşturmak için parametreler. | Tüm bölgeler | Paylaşılamaz |
Temerrüt
Geçerli: Tüm bölgeler
Bağlantı oluşturmak için parametreler.
Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.
| İsim | Türü | Description | Gerekli |
|---|---|---|---|
| Takım | String | Lütfen Celonis ekibini belirtin. | Doğru |
| Küme | String | Lütfen Celonis kümesini belirtin. | Doğru |
| Authorization | securestring | Bu API için Yetkilendirme | Doğru |
Azaltma Sınırları
| Name | Çağrılar | Yenileme Dönemi |
|---|---|---|
| Bağlantı başına API çağrıları | 100 | 60 saniye |
Eylemler
| Aboneliklerin listesini alma |
Oluşturulan tüm Aboneliklerin listesi |
| Aboneliği güncelleştirir |
Aboneliği güncelleştirir |
| Aboneliğin tüm verilerini kaldıran bir tetikleyici aboneliğinden çıkma |
Aboneliğin tüm verilerini kaldıran bir tetikleyici aboneliğinden çıkma |
| Başarısız bir abonelik nedeniyle iletilmeyen olayların sonraki sayfasını alır |
Başarısız bir abonelik nedeniyle iletilmediyse olayların sonraki sayfasını alır |
| KM'lerin listesini alma |
EMS ekibinde tanımlanan Bilgi Modelleri listesi |
| KM Filtrelerinin listesini alma |
Bilgi Modeli filtreleri listesi |
| KM Kaydı verilerinin listesini alma |
Bilgi Modelinde Bir Kaydın Verileri |
| KM Kayıtları şemasının listesini alma |
Kayıt Listesi şeması |
| KM Tetikleyicilerinin listesini alma |
Bilgi Modeli tetikleyicilerinin listesi |
| Olayları almayı durdurmak için aboneliği duraklatır |
Olayları almayı durdurmak için aboneliği duraklatır |
| Olayları yeniden almaya başlamak için duraklatılmış aboneliği sürdürür |
Olayları yeniden almaya başlamak için duraklatılmış aboneliği sürdürür |
| Tetikleyici için bir abonelik oluşturur |
Tetikleyici için bir abonelik oluşturur |
| Yeni olayları almaya başlamak için aboneliği sürdürür ve geçmiş olaylarını atar |
Yeni olayları yeniden almaya başlamak için duraklatılan aboneliği sürdürür ve geçmiş olaylarını atar |
| Üst düzey KM ayrıntılarını alma |
EMS ekibinde tanımlanan Bilgi Modeli |
| Üst düzey KM Kayıt Şeması ayrıntılarını alma |
En üst düzey Kayıt Şeması ayrıntıları |
Aboneliklerin listesini alma
Oluşturulan tüm Aboneliklerin listesi
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sayfa
|
page | integer |
0 ile başlayan sonucun sayfa numarası (ilk sayfa) |
|
|
Sayfa Boyutu
|
pageSize | integer |
Sayfada döndürülen öğe sayısı. |
|
|
Sırala
|
sort | string |
Büyük/küçük harfe duyarsız sıralamaya devam etmek için stratejiyi tanımlar. Yalnızca bir alan olmalıdır ve ASC siparişi uygulamak için "+" ile veya DESC siparişi uygulamak için "-" ile başlamalıdır. Ön ek olmayanlar ASC olarak sıralanır. Üst bilgide var olmayan alan hata oluşturur |
Döndürülenler
- Abonelik şeması sonuç sayfası
- subscriptionResultPage
Aboneliği güncelleştirir
Aboneliği güncelleştirir
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Abonelik Kimliği
|
subscription_id | True | string |
Tamamen güncelleştirilecek abonelik kimliği |
|
headers
|
headers | object |
Geri arama üst bilgileri kimlik doğrulama belirteci, içerik türü vb. içerebilir. |
|
|
protocol
|
protocol | True | string |
Aslında mümkün olan tek değer HTTPS'dir; bu da geri çağırma URI'sinin geçerli bir https olması gerektiği anlamına gelir |
|
URI
|
uri | True | string |
Tetikleyici tetiklendiğinde Akıllı API'den geri çağırma gerçekleştirmek için Uri |
|
configurations
|
configurations | array of string |
Abonelik yapılandırması |
|
|
name
|
name | True | string |
Aboneliğin adı |
Aboneliğin tüm verilerini kaldıran bir tetikleyici aboneliğinden çıkma
Aboneliğin tüm verilerini kaldıran bir tetikleyici aboneliğinden çıkma
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Abonelik Kimliği
|
subscription_id | True | string |
Abonelik kimliği silinecek |
Başarısız bir abonelik nedeniyle iletilmeyen olayların sonraki sayfasını alır
Başarısız bir abonelik nedeniyle iletilmediyse olayların sonraki sayfasını alır
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Abonelik Kimliği
|
subscription_id | True | string |
En fazla 50 öğede gönderilen başarısız olayı alacak abonelik kimliği |
Döndürülenler
- Sinyal sonuç sayfası
- SignalResultPage
KM'lerin listesini alma
EMS ekibinde tanımlanan Bilgi Modelleri listesi
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sayfa
|
page | integer |
0 ile başlayan sonucun sayfa numarası (ilk sayfa) |
|
|
Sayfa Boyutu
|
pageSize | integer |
Sayfada döndürülen öğe sayısı. |
|
|
Sıralama
|
sort | string |
Büyük/küçük harfe duyarsız sıralamaya devam etmek için stratejiyi tanımlar. Yalnızca bir alan olmalıdır ve ASC siparişi uygulamak için "+" ile veya DESC siparişi uygulamak için "-" ile başlamalıdır. Ön ek olmayanlar ASC olarak sıralanır. Üst bilgide var olmayan alan hata oluşturur |
Döndürülenler
- KnowledgeModel sonuç sayfası
- knowledgeModelResultPage
KM Filtrelerinin listesini alma
Bilgi Modeli filtreleri listesi
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sayfa
|
page | integer |
0 ile başlayan sonucun sayfa numarası (ilk sayfa) |
|
|
Sayfa Boyutu
|
pageSize | integer |
Sayfada döndürülen öğe sayısı. |
|
|
Sıralama
|
sort | string |
Büyük/küçük harfe duyarsız sıralamaya devam etmek için stratejiyi tanımlar. Yalnızca bir alan olmalıdır ve ASC siparişi uygulamak için "+" ile veya DESC siparişi uygulamak için "-" ile başlamalıdır. Ön ek olmayanlar ASC olarak sıralanır. Üst bilgide var olmayan alan hata oluşturur |
|
|
Bilgi Modeli Kimliği
|
km_id | True | string |
Bilgi Modeli Kimliği |
Döndürülenler
- Şema sonuç sayfasını filtrele
- filterResultPage
KM Kaydı verilerinin listesini alma
Bilgi Modelinde Bir Kaydın Verileri
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Bilgi Modeli Kimliği
|
km_id | True | string |
Bilgi Modeli Kimliği |
|
Kayıt Kimliği
|
record_id | True | string |
Kayıt Kimliği |
|
Filtreler
|
filters | array |
Önceden tanımlanmış filtre kimliği |
|
|
Alan Kimlikleri
|
fields | True | array |
Önceden tanımlanmış filtre kimliği |
|
Sayfa
|
page | integer |
0 ile başlayan sonucun sayfa numarası (ilk sayfa) |
|
|
Sayfa Boyutu
|
pageSize | integer |
Sayfada döndürülen öğe sayısı. |
|
|
Sıralama
|
sort | array |
Sıralamaya devam etmek için stratejiyi tanımlar. Alanların virgülle ayrılmış bir listesi olmalıdır ve ASC sırasını uygulamak için "+" veya DESC sırasını uygulamak için "-" ile başlamalıdır. Ön eki olmayan alanlar ASC olarak sıralanır. Üst bilgide var olmayan alanlar hata oluşturur |
|
|
Filtre İfadesi
|
filterExpr | array |
Dinamik filtre ifadeleri |
Döndürülenler
- Veri sonuç sayfasını kaydetme
- recordResultPageDTO
KM Kayıtları şemasının listesini alma
Kayıt Listesi şeması
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sayfa
|
page | integer |
0 ile başlayan sonucun sayfa numarası (ilk sayfa) |
|
|
Sayfa Boyutu
|
pageSize | integer |
Sayfada döndürülen öğe sayısı. |
|
|
Sıralama
|
sort | string |
Büyük/küçük harfe duyarsız sıralamaya devam etmek için stratejiyi tanımlar. Yalnızca bir alan olmalıdır ve ASC siparişi uygulamak için "+" ile veya DESC siparişi uygulamak için "-" ile başlamalıdır. Ön ek olmayanlar ASC olarak sıralanır. Üst bilgide var olmayan alan hata oluşturur |
|
|
Bilgi Modeli Kimliği
|
km_id | True | string |
Bilgi Modeli Kimliği |
Döndürülenler
- Kayıt şeması sonuç sayfası
- recordSchemaResultPage
KM Tetikleyicilerinin listesini alma
Bilgi Modeli tetikleyicilerinin listesi
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Sayfa
|
page | integer |
0 ile başlayan sonucun sayfa numarası (ilk sayfa) |
|
|
Sayfa Boyutu
|
pageSize | integer |
Sayfada döndürülen öğe sayısı. |
|
|
Sırala
|
sort | string |
Büyük/küçük harfe duyarsız sıralamaya devam etmek için stratejiyi tanımlar. Yalnızca bir alan olmalıdır ve ASC siparişi uygulamak için "+" ile veya DESC siparişi uygulamak için "-" ile başlamalıdır. Ön ek olmayanlar ASC olarak sıralanır. Üst bilgide var olmayan alan hata oluşturur |
|
|
Km Kimliği
|
km_id | True | string |
Bilgi Modeli Kimliği |
Döndürülenler
- Şema sonuç sayfasını tetikleme
- triggerResultPage
Olayları almayı durdurmak için aboneliği duraklatır
Olayları almayı durdurmak için aboneliği duraklatır
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Abonelik Kimliği
|
subscription_id | True | string |
Abonelik kimliği duraklatılacak |
Olayları yeniden almaya başlamak için duraklatılmış aboneliği sürdürür
Olayları yeniden almaya başlamak için duraklatılmış aboneliği sürdürür
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Abonelik Kimliği
|
subscription_id | True | string |
Abonelik kimliği sürdürülür ve olay yeniden alınmaya başlar |
Tetikleyici için bir abonelik oluşturur
Tetikleyici için bir abonelik oluşturur
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Km Kimliği
|
km_id | True | string |
Bilgi Modeli Kimliği |
|
Tetikleyici Kimliği
|
trigger_id | True | string |
Tetikleyici Kimliği |
|
headers
|
headers | object |
Geri arama üst bilgileri kimlik doğrulama belirteci, içerik türü vb. içerebilir. |
|
|
protocol
|
protocol | True | string |
Aslında mümkün olan tek değer HTTPS'dir; bu da geri çağırma URI'sinin geçerli bir https olması gerektiği anlamına gelir |
|
URI
|
uri | True | string |
Tetikleyici tetiklendiğinde Akıllı API'den geri çağırma gerçekleştirmek için Uri |
|
configurations
|
configurations | array of string |
Abonelik yapılandırması |
|
|
name
|
name | True | string |
Aboneliğin adı |
Döndürülenler
- response
- string
Yeni olayları almaya başlamak için aboneliği sürdürür ve geçmiş olaylarını atar
Yeni olayları yeniden almaya başlamak için duraklatılan aboneliği sürdürür ve geçmiş olaylarını atar
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Abonelik Kimliği
|
subscription_id | True | string |
Abonelik kimliği, geçirilen olaylar alınmadan sürdürülür |
Üst düzey KM ayrıntılarını alma
EMS ekibinde tanımlanan Bilgi Modeli
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Bilgi Modeli Kimliği
|
km_id | True | string |
Bilgi Modeli Kimliği |
Döndürülenler
Bilgi Modeli verilerinin yapısı
- Bilgi Modeli
- knowledgeModelDetailedDTO
Üst düzey KM Kayıt Şeması ayrıntılarını alma
En üst düzey Kayıt Şeması ayrıntıları
Parametreler
| Name | Anahtar | Gerekli | Tür | Description |
|---|---|---|---|---|
|
Bilgi Modeli Kimliği
|
km_id | True | string |
Bilgi Modeli Kimliği |
|
Kayıt Kimliği
|
record_id | True | string |
Kayıt Kimliği |
Döndürülenler
Kayıt, Bilgi Modeli içindeki bir kavramı temsil eder
- Kayıt Türü
- recordDTO
Tanımlar
SignalResultPage
| Name | Yol | Tür | Description |
|---|---|---|---|
|
içerik
|
content | array of signalDTO | |
|
pageSize
|
pageSize | integer |
Sistem tarafından tanımlanan sayfa boyutu |
filterDTO
KM'ye uygulanacak filtre
| Name | Yol | Tür | Description |
|---|---|---|---|
|
açıklama
|
description | string |
İnsan tarafından anlaşılabilir Filtre açıklaması |
|
kimlik
|
id | string |
Filtrenin Benzersiz tanımlayıcısı |
|
name
|
name | string |
İnsan tarafından anlaşılabilen Filtre görünen adı |
filterResultPage
| Name | Yol | Tür | Description |
|---|---|---|---|
|
page
|
page | integer |
Sayfa |
|
pageSize
|
pageSize | integer |
Sayfa boyutu, pageSize parametresiyle tanımlanır |
|
sort
|
sort | string |
İstenen verilere sıralama uygulamak için kullanılan alan, + veya simge yok, ASC, - DESC anlamına gelir |
|
toplam
|
total | integer |
Sayfada döndürülen toplam öğe sayısı |
|
içerik
|
content | array of filterDTO |
knowledgeModelDetailedDTO
Bilgi Modeli verilerinin yapısı
| Name | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | string |
Bilgi Modelinin Benzersiz Tanımlayıcısı |
|
name
|
name | string |
İnsan tarafından anlaşılabilen metin |
|
extendedKMId
|
extendedKMId | string |
Başvuru olarak kullanılan bilgi modeli, KM tabanı. |
knowledgeModelResultPage
| Name | Yol | Tür | Description |
|---|---|---|---|
|
page
|
page | integer |
Sayfa |
|
pageSize
|
pageSize | integer |
Sayfa boyutu, pageSize parametresiyle tanımlanır |
|
sort
|
sort | string |
İstenen verilere sıralama uygulamak için kullanılan alan, + veya simge yok, ASC, - DESC anlamına gelir |
|
toplam
|
total | integer |
Sayfada döndürülen toplam öğe sayısı |
|
içerik
|
content | array of knowledgeModelSimplifiedDTO |
knowledgeModelSimplifiedDTO
Bilgi Modeli verilerinin yapısı
| Name | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | string |
Bilgi Modelinin Benzersiz Tanımlayıcısı |
|
name
|
name | string |
İnsan tarafından anlaşılabilen metin |
|
Yayımlanmış
|
published | string |
En son yayımlanma tarihi |
recordDTO
Kayıt, Bilgi Modeli içindeki bir kavramı temsil eder
| Name | Yol | Tür | Description |
|---|---|---|---|
|
açıklama
|
description | string |
Kayıt açıklaması |
|
kimlik
|
id | string |
Kaydın Benzersiz tanımlayıcısı |
|
name
|
name | string |
Kayıt görünen adı, insan tarafından anlaşılabilen bir ad |
|
Alanları
|
fields | array of recordFieldDTO |
recordFieldDTO
Bir Kaydın Alanları
| Name | Yol | Tür | Description |
|---|---|---|---|
|
format
|
format | string |
Uygulanacak biçim |
|
kimlik
|
id | string |
Ödenmek üzere bekleyen tutar |
|
name
|
name | string |
insan tarafından anlaşılabilen ad |
|
type
|
type | string | |
|
birim
|
unit | string |
Alan değerine eklenen birim |
recordIdDTO
Kayıt Türünün kimliği ve adı
| Name | Yol | Tür | Description |
|---|---|---|---|
|
açıklama
|
description | string |
Kayıt açıklaması |
|
kimlik
|
id | string |
Kaydın Benzersiz tanımlayıcısı |
|
name
|
name | string |
Kayıt görünen adı, insan tarafından anlaşılabilen bir ad |
recordItemDTO
| Name | Yol | Tür | Description |
|---|---|---|---|
|
veriler
|
data | array of |
Kayıt öğesi listesi, ad ve değer içeren bileşik |
|
headers
|
headers | array of recordItemHeaderDTO |
recordItemHeaderDTO
| Name | Yol | Tür | Description |
|---|---|---|---|
|
Toplama
|
aggregation | boolean |
Alanın toplama/hesaplanan bilgi (KPI) olup olmadığını belirtin. |
|
filtrelenebilir
|
filterable | boolean |
Alanın filtrelenip filtrelenemediğini belirtin. |
|
format
|
format | string |
biçim ifadesi |
|
kimlik
|
id | string |
Alan listesi param ve filterExpression param içinde kullanılacak alan kimliği |
|
name
|
name | string |
İnsan tarafından anlaşılabilen metin |
|
sıralanabilir
|
sortable | boolean |
Alanın sıralanabilir olup olmadığını belirtin. |
|
type
|
type | string |
Olası veri türleri. |
|
birim
|
unit | string |
Değer görünümünü biçimlendirmek için tamamlayıcı bir işaret |
recordResultPageDTO
| Name | Yol | Tür | Description |
|---|---|---|---|
|
page
|
page | integer |
Sayfa |
|
pageSize
|
pageSize | integer |
Sayfa boyutu, pageSize parametresiyle tanımlanır |
|
sort
|
sort | array of string | |
|
toplam
|
total | integer |
Sayfada döndürülen toplam öğe sayısı |
|
Kayıt Öğesi
|
content | recordItemDTO |
recordSchemaResultPage
| Name | Yol | Tür | Description |
|---|---|---|---|
|
page
|
page | integer |
Sayfa |
|
pageSize
|
pageSize | integer |
Sayfa boyutu, pageSize parametresiyle tanımlanır |
|
sort
|
sort | string |
İstenen verilere sıralama uygulamak için kullanılan alan, + veya simge yok, ASC, - DESC anlamına gelir |
|
toplam
|
total | integer |
Sayfada döndürülen toplam öğe sayısı |
|
içerik
|
content | array of recordIdDTO |
signalDTO
Abonelikte depolanan sinyal
| Name | Yol | Tür | Description |
|---|---|---|---|
|
signal
|
signal | string |
Bir sinyalin ham json değeri |
|
subscriptionId
|
subscriptionId | string |
Abonenin SUID olarak Benzersiz tanımlayıcısı |
|
triggerId
|
triggerId | string |
Tetikleyicinin BENZERSIZ tanımlayıcısı SUID olarak |
|
oluşturmaTarihi
|
creationDate | date-time |
Sinyal oluşturma tarihi |
subscriptionDTO
Abonelik şeması
| Name | Yol | Tür | Description |
|---|---|---|---|
|
configurations
|
configurations | array of string |
Abonelik yapılandırması |
|
kimlik
|
id | string |
Abonenin SUID olarak Benzersiz tanımlayıcısı |
|
knowledgeModelId
|
knowledgeModelId | string |
Bilgi Modelinin Benzersiz Tanımlayıcısı |
|
latestSucceedEvent
|
latestSucceedEvent | date-time |
Son başarılı olayın tarihi |
|
name
|
name | string |
İnsan tarafından anlaşılabilen Abonelik adı |
|
statü
|
status | string | |
|
triggerId
|
triggerId | string |
Tetikleyicinin BENZERSIZ tanımlayıcısı SUID olarak |
subscriptionResultPage
| Name | Yol | Tür | Description |
|---|---|---|---|
|
page
|
page | integer |
Sayfa |
|
pageSize
|
pageSize | integer |
Sayfa boyutu, pageSize parametresiyle tanımlanır |
|
sort
|
sort | string |
İstenen verilere sıralama uygulamak için kullanılan alan, + veya simge yok, ASC, - DESC anlamına gelir |
|
toplam
|
total | integer |
Sayfada döndürülen toplam öğe sayısı |
|
içerik
|
content | array of subscriptionDTO |
triggerDTO
KM'de tanımlanan tetikleyici
| Name | Yol | Tür | Description |
|---|---|---|---|
|
kimlik
|
id | string |
Tetikleyicinin BENZERSIZ tanımlayıcısı SUID olarak |
|
name
|
name | string |
İnsan tarafından anlaşılabilen Tetikleyici adı |
|
kayıt
|
record | string |
Kaydın SUID olarak Benzersiz tanımlayıcısı |
triggerResultPage
| Name | Yol | Tür | Description |
|---|---|---|---|
|
page
|
page | integer |
Sayfa |
|
pageSize
|
pageSize | integer |
Sayfa boyutu, pageSize parametresiyle tanımlanır |
|
sort
|
sort | string |
İstenen verilere sıralama uygulamak için kullanılan alan, + veya simge yok, ASC, - DESC anlamına gelir |
|
toplam
|
total | integer |
Sayfada döndürülen toplam öğe sayısı |
|
içerik
|
content | array of triggerDTO |
String
Bu, 'string' temel veri türüdür.