correlation.get

Опис

integer/array correlation.get(object parameters)

Метод дозволяє відновлювати кореляції за заданими параметрами.

Цей спосіб доступний користувачам будь-якого типу. Дозволи на виклик методу можна скасувати в налаштуваннях ролі користувача. Див. Ролі користувача для отримання додаткової інформації.

Параметри

(object) Параметри, що визначають бажаний результат.

Метод підтримує такі параметри.

Параметр Тип Опис
correlationids рядок/масив Повертає лише кореляції з заданими ідентифікаторами.
selectFilter query Повернути властивість filter з умовами кореляції.
selectOperations query Повернути властивість operations з операціями кореляції.
sortfield string/array Відсортуйте результат за заданими властивостями.

Можливі значення: correlationid, name і status.
countOutput boolean Ці параметри, які є спільними для всіх методів get, описані в довідковому коментарі.
редагований логічний
excludeSearch boolean
фільтр об'єкт
ліміт ціле
вивід запит
preservekeys boolean
пошук об'єкт
searchByAny логічний
увімкнено знаки підстановки логічний
порядок сортування рядок/масив
почати пошук логічний

Повернуті значення

(integer/array) Повертає або:

  • масив об'єктів;
  • кількість отриманих об'єктів, якщо використовувався параметр 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.