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

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

[comment]: # ({6e13bc51-858936aa})
### Descripció

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

El mètode permet recuperar correlacions segons els paràmetres proveïts.

::: noteclassic
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu [Rols d'usuari](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/6e13bc51-858936aa})

[comment]: # ({7c68a8c3-06a650a0})
### Paràmetres

`(objet)` Paràmetres que defineixen la sortida esperada.

El mètode admet els paràmetres següents.

|Paràmetre|[Tipus](/manual/api/reference_commentary#data-types)|Descripció|
|--|--|------|
|correlationids|ID/array|Retorna només correlacions amb els identificadors donats.|
|selectFilter|query|Retorna una propietat [filtre](/manual/api/reference/correlation/object#correlation-filter) amb la correlació de condicions.|
|selectOperations|query|Retorna una propietat  [operacions](/manual/api/reference/correlation/object#correlation-operation) amb la correlació de condicions.|
|sortfield|string/array|Ordena el resultat segons les propietats donades.<br><br>Els valors possibles són: `rcorrelationid`, `name`, `status`.|
|countOutput|boolean|Aquests paràmetres es descriuen als [comentaris de referència](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/7c68a8c3-06a650a0})

[comment]: # ({7223bab1-7223bab1})
### Valors de retorn

`(integer/array)` Retorna un d'entre:

-   una taula d'objectes;
-   el recompte d'objectes recuperats, si s'empra el paràmetre `countOutput`.

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

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

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

[comment]: # ({ef8be6d3-d14c4f20})
#### Recuperar correlacions

Recupera totes les correlacions configurades juntament amb condicions i operacions. El filtre empra "i/o" tipus d'avaluació, pel que la propietat `formula` és buida i `eval_formula` es genera automàticament.

[Petició](/manual/api#performing-requests):

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

Resposta:

```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]: # ({/ef8be6d3-d14c4f20})

[comment]: # ({1341f8b4-e7d15410})
### Veieu també

-   [Filtre de correlació](object#correlation-filter)
-   [Operació de correlació](object#correlation-operation)

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

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

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

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