4.1.8. Alerty (GET)

Adres URL żądania:

https://<hostname>/ekranapi/alerts

Wymagane nagłówki:

Nagłówek	Wymagany	Opis
ApiKey	Tak	Służy do uwierzytelnienia żądania.

Przykład nagłówka żądania:

ApiKey: xJ)tsCNcpj)l+]}(@_|lt!t………

Parametry żądania:

Nazwa	Opis	Typ	Format	Wymagane
Alerts	Zwraca listę zdarzeń alertów, które wystąpiły w wyniku wyzwolenia alertów (z pełnymi szczegółami).	GET	–	–
start	Uwzględnia alerty, które wystąpiły po podanym czasie.	string	`"2021-04-01""2021-04-01T12:00""2021-04-01T12:00:00"`	Nie
end	Uwzględnia alerty, które wystąpiły przed podanym czasem.	string	jw.	Nie
alertCount	Liczba alertów, które mają zostać zwrócone w jednym żądaniu. Domyślnie: 1000. Maksymalnie: 1000.	int	Liczba całkowita od 0 do 1000	Nie
afterActivityId	Gdy liczba alertów przekracza 1000, można pobrać kolejną porcję za pomocą tego parametru.	int	Dowolna liczba całkowita dodatnia	Nie

Uwagi:

Jeśli nie określono parametrów czasu:
- Jeśli start i end są pominięte, zostaną zwrócone wszystkie zdarzenia alertów z bazy.
- Jeśli start jest pominięty, zostaną zwrócone wszystkie alerty przed datą end.
- Jeśli end jest pominięty, zostaną zwrócone wszystkie alerty po dacie start.

Odpowiedź (status: 200 = sukces):

{
  "afterActivityId": 20223,
  "alerts": [
    {
      "alertId": 88,
      "activityId": 29,
      "date": "2022-09-05T12:33:32.548",
      "alertName": "application alert",
      "alertDescription": "check application equal cmd",
      "userName": "WINDEV2106EVAL\\User",
      "clientName": "WinDev2106Eval",
      "what": "Command Prompt - cmd.exe - cmd",
      "playerLink": "https://localhost/EkranSystem/Player?id=5&startSlideId=29&play=false&mode=0"
    },
    {
      "alertId": 91,
      "activityId": 20223,
      "date": "2022-09-19T16:11:24.356",
      "alertName": "username alert",
      "alertDescription": "check username equal WINDEV2106EVAL\\User",
      "userName": "WINDEV2106EVAL\\User",
      "clientName": "WinDev2106Eval",
      "what": "explorer.exe",
      "playerLink": "https://localhost/EkranSystem/Player?id=1013&startSlideId=20223&play=false&mode=0"
    }
  ]
}

Parametry odpowiedzi:

Nazwa (typ)	Opis
afterActivityId (int)	ID pierwszego zdarzenia alertu w paczce (czyli pierwszego `activityId`).
alerts (lista)	Lista zdarzeń alertów zawierających:
alertId (int)	ID alertu, który został wyzwolony.
activityId (int)	ID zdarzenia alertu (które nastąpiło po wyzwoleniu).
date (date)	Data i godzina wyzwolenia alertu.
alertName (string)	Nazwa alertu.
alertDescription (string)	Opis warunku alertu.
userName (string)	Nazwa użytkownika, który wywołał alert.
clientName (string)	Nazwa komputera (agenta monitorowania), na którym wystąpił alert.
what (string)	Czynność użytkownika, która spowodowała alert (np. aplikacja, URL, tytuł aktywności itd.).
playerLink (string)	Link do przeglądarki sesji pokazujący moment wyzwolenia alertu.

Uwaga: Jeśli zażądano więcej niż 1000 alertów (alertCount > 1000), zostanie zwrócony kod odpowiedzi 400.