correlation.get

Описание

integer/array correlation.get(параметры объекта)

Этот метод позволяет получать корреляции в соответствии с заданными параметрами.

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(объект) Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

Параметр Тип Тип
correlationids строка/массив Возврат корреляций только с заданными ID.
selectFilter запрос Возврат фильтра корреляции в свойстве filter.
selectOperations запрос Возврат операций корреляции в свойстве operations.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

Возможные значения: correlationid, name и status.
countOutput логический Эти параметры являются общими для всех методов get и они описаны в справочных комментариях.
editable логический
excludeSearch логический
filter объект
limit целое число
output запрос
preservekeys логический
search объект
searchByAny логический
searchWildcardsEnabled логический
sortorder строка/массив
startSearch логический

Возвращаемые значения

(целое число/массив) Возвращает:

  • · массив объектов;
  • · количество извлеченных объектов, если использовался параметр countOutput.

Примеры

Получить корреляции

Получить все настроенные корреляции вместе с условиями и операциями корреляций. Фильтр использует тип вычисления "и/или", поэтому свойство formula пустое, а eval_formula генерируется автоматически.

Запрос:

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

Ответ:

{
    "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
}

Смотрите также

Источник

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