[comment]: # translation:outdated

[comment]: # ({7416ad19-7416ad19})
# correlation.get

[comment]: # ({/7416ad19-7416ad19})

[comment]: # ({3d508065-858936aa})
### Опис

`integer/array correlation.get(object parameters)`

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

::: noteclassic
Цей спосіб доступний користувачам будь-якого типу. Дозволи на виклик методу можна скасувати в налаштуваннях ролі користувача. Див. [Ролі користувача](/manual/web_interface/frontend_sections/administration/user_roles) для отримання додаткової інформації.
:::

[comment]: # ({/3d508065-858936aa})

[comment]: # ({1ef634fe-06a650a0})
### Параметри

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

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

|Параметр|[Тип](/manual/api/reference_commentary#data_types)|Опис|
|--|--|------|
|correlationids|рядок/масив|Повертає лише кореляції з заданими ідентифікаторами.|
|selectFilter|query|Повернути властивість [filter](/manual/api/reference/correlation/object#correlation_filter) з умовами кореляції.|
|selectOperations|query|Повернути властивість [operations](/manual/api/reference/correlation/object#correlation_operation) з операціями кореляції.|
|sortfield|string/array|Відсортуйте результат за заданими властивостями.<br><br>Можливі значення: `correlationid`, `name` і `status`.|
|countOutput|boolean|Ці параметри, які є спільними для всіх методів `get`, описані в [довідковому коментарі](/manual/api/reference_commentary#common_get_method_parameters).|
|редагований|логічний|^|
|excludeSearch|boolean|^|
|фільтр|об'єкт|^|
|ліміт|ціле|^|
|вивід|запит|^|
|preservekeys|boolean|^|
|пошук|об'єкт|^|
|searchByAny|логічний|^|
|увімкнено знаки підстановки|логічний|^|
|порядок сортування|рядок/масив|^|
|почати пошук|логічний|^|

[comment]: # ({/1ef634fe-06a650a0})

[comment]: # ({7223bab1-7223bab1})
### Повернуті значення

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

- масив об'єктів;
- кількість отриманих об'єктів, якщо використовувався параметр `countOutput`.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Приклади

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({a2342aa1-d14c4f20})
#### Отримати кореляції

Отримати всі налаштовані кореляції разом із умовами та операціями кореляції. Фільтр використовує тип оцінки "і/або", тому властивість `formula` порожня, а `eval_formula` генерується автоматично.

Запит:

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

Відповідь:

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

[comment]: # ({/a2342aa1-d14c4f20})

[comment]: # ({e7d15410-e7d15410})
### Дивись також

- [Фільтр кореляції](object#correlation_filter)
- [Операція кореляції](object#correlation_operation)

[comment]: # ({/e7d15410-e7d15410})

[comment]: # ({bbab04bd-bbab04bd})
### Джерело

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

[comment]: # ({/bbab04bd-bbab04bd})