correlation.get

Description

integer/array correlation.get(object parameters)

Metoda pozwala na pobranie korelacji zgodnie z zadanymi 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 po więcej informacji.

Parametry

(object)Parametry określające pożądane wyjście.

Metoda obsługuje następujące parametry.

Parametr	Typ	Opis
correlationids	string/array	Zwraca korelacje tylko z podanymi identyfikatorami ID.
selectFilter	query	Zwraca właściwość filtra z warunkami korelacji.
selectOperations	query	Zwraca właściwość operacji z operacjami korelacji.
sortfield	string/array	Sortuj wynik według podanych właściwości. Możliwe wartości to: `correlationid`, `name` oraz `status`.
countOutput	boolean	Te parametry są wspólne dla wszystkich metod `get` 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ł użyty.

Przykłady

Pobierz korelację

Pobierz wszystkie skonfigurowane korelacje wraz z warunkami i operacjami korelacji. Filtr wykorzystuje typ oceny "and/or", więc właściwość formula jest pusta i eval_formula jest generowana automatycznie.

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "correlation.get",
           "params": {
               "output": "extend",
               "selectOperations": "extend",
               "selectFilter": "extend"
           },
           "auth": "343baad4f88b4106b9b5961e77437688",
           "id": 1
       }

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "correlationid": "1",
                   "name": "Correlation 1",
                   "description": "",
                   "status": "0",
                   "filter": {
                       "evaltype": "0",
                       "formula": "",
                       "conditions": [
                           {
                               "type": "3",
                               "oldtag": "error",
                               "newtag": "ok",
                               "formulaid": "A"
                           }
                       ],
                       "eval_formula": "A"
                   },
                   "operations": [
                       {
                           "type": "0"
                       }
                   ]
               }
           ],
           "id": 1
       }

Zobacz także

Źródło

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

Documentation