Schema bimoM.v1
Elementy
| Element | Opis |
|---|---|
| getMonitoredEntitiesRequest | Żądanie listy monitorowanych podmiotów
Element wejściowy dla operacji zmiany konfiguracji monitoringu w BIG API. Element zawiera kryteria filtrowania zamawianej listy. |
| getMonitoredEntitiesResponse | Lista monitorowanych podmiotów
Element wyjściowy dla operacji zmiany konfiguracji monitoringu w BIG API. Element zawiera kolekcję monitorowanych podmiotów, które spełniają kryteria przekazane w żądaniu pobrania listy. |
| getTracedEventsRequest | Żądanie listy wychwyconych zdarzeń
Element wejściowy dla operacji pobrania listy zdarzeń wychwyconych w ramach monitoringu. Element zawiera kryteria filtrowania zamawianej listy. |
| getTracedEventsResponse | Lista wychwyconych zdarzeń
Element wyjściowy dla operacji pobrania listy zdarzeń wychwyconych w ramach monitoringu. Element zawiera kolekcję wychwyconych w ramach monitoringu zdarzeń, które spełniają kryteria przekazane w żądaniu pobrania listy. |
| removeTracedEventsRequest | Żądanie usunięcia wychwyconych zdarzeń
Element wejściowy dla operacji usunięcia zdarzeń wychwyconych w ramach monitoringu. Element zawiera kryteria określające, które zdarzenia mają zostać usunięte. |
| removeTracedEventsResponse | Potwierdzenie usunięcia zdarzeń
Element wyjściowy dla operacji usunięcia zdarzeń wychwyconych w ramach monitoringu. Element zawiera potwierdzenie wykonania operacji lub informację o błędzie. |
| updateMonitoringRequest | Żądanie zmiany konfiguracji monitoringu
Element wejściowy dla operacji zmiany konfiguracji monitoringu w BIG API (Dodanie / usunięcie podmiotu monitorowanego, włączenie / wyłączenie automonitoringu). |
| updateMonitoringResponse | Rezultat przetworzenia zmiany konfiguracji monitoringu
Element wyjściowy dla operacji zmiany konfiguracji monitoringu w BIG API. Element zawiera potwierdzenie wykonania operacji lub informację o błędzie. |
| whoMonitorsMeRequest | Żądanie listy podmiotów monitorujących
Element wejściowy dla operacji odczytania listy podmiotów, które monitorują subskrybenta (wykonującego żądanie). |
| whoMonitorsMeResponse | Lista podmiotów monitorujących
Element wyjściowy dla operacji odczytania listy podmiotów, które monitorują subskrybenta (wykonującego żądanie). |
Typy złożone
| Complex Type | Opis |
|---|---|
| AddEntity | Dodanie podmiotu do monitoringu
Typ umożliwia skonfigurowanie monitoringu dla wskazanego podmiotu. |
| EnableSelfMonitoring | Włączenie automonitoringu
Typ umożliwiający przekazanie konfiguracji automonitoringu. |
| Entity | Podmiot monitorowany
Typ umożliwia przekazanie danych podmiotu monitorowanego.
Po typie "Entity" dziedziczą: |
| EntityEvents | Lista wychwyconych zdarzeń dla podmiotu
Kolekcja wychwyconych zdarzeń, dotyczących określonego podmiotu. |
| EntityList | Lista podmiotów
Typ umożliwia przekazanie kolekcji podmiotów monitorowanych lub monitorujących. |
| EntitySelector | Wskazanie podmiotu
Typ umożliwia jednoznaczne wskazanie podmiotu (konsumenta lub podmiotu niebędącego konsumentem) |
| Event | Wychwycone zdarzenie
Typ umożliwia przekazanie danych wychwyconego w ramach monitoringu zdarzenia. |
| EventsFilter | Filtr listy zdarzeń
Typ umożliwia zdefiniowanie kryteriów filtrowania listy wychwyconych w ramach monitoringu zdarzeń |
| EventsRequest | Żądanie listy wychwyconych zdarzeń
Element umożliwiający zdefiniowanie kryteriów dla pobieranej listy zdarzeń wychwyconych przez monitoring. |
| LegalPersonSelector | Wskazanie podmiotu niebędącego konsumentem
Typ umożliwia jednoznaczne wskazanie podmiotu niebędącego konsumentem. |
| MonitoredEntitiesRequest | Żądanie listy monitorowanych podmiotów
Element umożliwiający zdefiniowanie kryteriów dla pobieranej listy monitorowanych podmiotów. |
| MonitoringEntitiesSortings | Sortowanie listy podmiotów monitorowanych
Typ umożliwiający przekazywanie kryteriów dla sortowania listy podmiotów monitorowanych |
| Request | |
| RequestError | Błąd walidacji zapytania
Typ reprezentujący błąd walidacji zapytania |
| Response | Rezultat przetworzenia operacji
Typ zawierający listę możliwych rezultatów przetworzenia operacji.
Po typie "Response" dziedziczą: |
| TracedEvents | Lista wychwyconych zdarzeń
Typ umożliwia przekazanie kolekcji wychwyconych w ramach monitoringu zdarzeń. |
| UpdateMonitoringPeriod | Aktualizacja okresu monitorowania |
| UpdateMonitoringRequest | Zmiana konfiguracji monitoringu
Typ umożliwia zmianę konfiguracji monitoringu w SIBIG (Dodanie / usunięcie podmiotu monitorowanego, włączenie / wyłączenie automonitoringu). |
| UpdateResponse | Rezultat przetworzenia operacji
Typ zawierający listę możliwych rezultatów przetworzenia operacji aktualizacji. |
Typy proste
| Simple Type | Opis |
|---|---|
| criterionTypeEnum | Rodzaj warunku
Słownik rozdajów warunków filtrowania. |
| entityScopeEnum | Zakres podmiotów na których wystąpiły zdarzenia
Słownik zakresów podmiotów dla których może być zwrócona historia zdarzeń |
| eventTypeEnum | Rodzaj zdarzenia monitorowanego
Słownik rozdajów zdarzeń możliwych do monitorowania przez BIG InfoMonitor. |
| limit | Typ prosty umożliwiający zapisanie liczby całkowitej będącej limitem liczby zwracanych zdarzeń. |
| monitoringEntitiesSortingsEnum | Atrybuty sortowania listy podmiotów monitorowanych
Atrybuty sortowania listy podmiotów monitorowanych |
| sortDirectionEnum | Kierunek sortowania. |