correlation.get

Описание

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

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

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

Параметры

(object) Параметры, определяющие желаемый вывод.

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

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

Возможные значения: correlationid, name, status.
countOutput boolean Эти параметры описаны в справочном комментарии.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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

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

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

Примеры

Получение корреляций

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

Запрос:

{
    "jsonrpc": "2.0",
    "method": "correlation.get",
    "params": {
        "output": "extend",
        "selectOperations": "extend",
        "selectFilter": "extend"
    },
    "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.