service.get

Opis

integer/array service.get(object parameters)

Metoda umożliwia pobranie usług zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika aby uzyskać więcej informacji.

Parametry

(object) Parametry definiujące pożądany wynik.

Metoda obsługuje następujące parametry. | Parametr | Typ | | |------------------------|-----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | serviceids | string/array | Zwraca tylko usługi o podanych identyfikatorach. | | parentids | string/array | Zwraca tylko usługi połączone z podanymi usługami nadrzędnymi. | | deep_parentids | flag | Zwraca wszystkie bezpośrednie i pośrednie usługi podrzędne. Używane razem z parentids. | | childids | string/array | Zwraca tylko usługi połączone z podanymi usługami podrzędnymi. | | evaltype | integer | Zasady wyszukiwania znaczników.

Mozliwe wartości:
0 - (domyślne) I/Lub;
2 - Lub. | | tags | object/array | Zwraca tylko usługi z określonymi znacznikami. Dokładne dopasowanie tagu i wyszukiwanie z uwzględnieniem wielkości liter lub bez, w zależności od wartości operatora.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Pusta tablica zwraca wszystkie usługi.

Możliwe wartości operatora:
0 - (domyślne) Zawiera;
1 - Jest równy;
2 - Nie zawiera;
3 - Nie jest równy;
4 - Istnieje;
5 - Nie istnieje. | | problem_tags | object/array | Zwraca tylko usługi z określonymi znacznikami problemów. Dokładne dopasowanie tagu i wyszukiwanie z uwzględnieniem wielkości liter lub bez, w zależności od wartości operatora.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Pusta tablica zwraca wszystkie usługi.

Możliwe wartości operatora:
0 - (domyślne) Zawiera;
1 - Jest równy;
2 - Nie zawiera;
3 - Nie jest równy;
4 - Istnieje;
5 - Nie istnieje. | | without_problem_tags | flag | Zwraca tylko usługi bez znaczników problemów. | | slaids | string/array | Zwraca tylko usługi połączone z określonymi SLA. | | selectChildren | query | Zwraca właściwość children z usługami podrzędnymi.

Obsługuje count. | | selectParents | query | Zwraca właściwość parents z usługami nadrzędnymi.

Obsługuje count. | | selectTags | query | Zwraca właściwość tags z znacznikami usługi.

Obsługuje count. | | selectProblemEvents | query | Zwraca właściwość problem_events z tablicą obiektów problemów.

Obiekt problemu ma następujące właściwości:
eventid - (string) ID zdarzenia;
severity - (string) Bieżący poziom zdarzenia;
name - (string) Nazwa rozwiązanego zdarzenia.

Obsługuje count. | | selectProblemTags | query | Zwraca właściwość problem_tags z znacznikami problemów.

Obsługuje count. | | selectStatusRules | query | Zwraca właściwość status_rules z zasadami statusu.

Obsługuje count. | | selectStatusTimeline | object/array | Zwraca właściwość status_timeline zawierającą zmiany stanu usługi dla określonych okresów.

Format [{"period_from": "<period_from>", "period_to": "<period_to>"}, ...] - period_from to początkowa data (włącznie; znacznik czasu jako liczba całkowita) i period_to to końcowa data (wyłącznie; znacznik czasu jako liczba całkowita) dla interesującego cię okresu.

Zwraca tablicę wpisów zawierającą właściwość start_value i tablicę alarmów dla zmian stanu w określonych okresach. |

sortfield string/array Sortuj wynik według podanych właściwości.

Możliwe wartości to: serviceid, name, status, sortorder i created_at.
countOutput boolean Te parametry, które są wspólne dla wszystkich metod get, są szczegółowo opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobieranie wszystkich usług

Pobierz wszystkie dane dotyczące wszystkich usług i ich zależności.

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "service.get",
           "params": {
               "output": "extend",
               "selectChildren": "extend",
               "selectParents": "extend"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "serviceid": "1",
                   "name": "My Service - 0001",
                   "status": "-1",
                   "algorithm": "2",
                   "sortorder": "0",
                   "weight": "0",
                   "propagation_rule": "0",
                   "propagation_value": "0",
                   "description": "My Service Description 0001.",
                   "uuid": "dfa4daeaea754e3a95c04d6029182681",
                   "created_at": "946684800",
                   "readonly": false,
                   "parents": [],
                   "children": []
               },
               {
                   "serviceid": "2",
                   "name": "My Service - 0002",
                   "status": "-1",
                   "algorithm": "2",
                   "sortorder": "0",
                   "weight": "0",
                   "propagation_rule": "0",
                   "propagation_value": "0",
                   "description": "My Service Description 0002.",
                   "uuid": "20ea0d85212841219130abeaca28c065",
                   "created_at": "946684800",
                   "readonly": false,
                   "parents": [],
                   "children": []
               }
           ],
           "id": 1
       }

Źródło

CService::get() w ui/include/classes/api/services/CService.php.