[comment]: # translation:outdated

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

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

[comment]: # ({0c82416b-858936aa})
### Description

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

La méthode permet de récupérer des corrélations en fonction des paramètres spécifiés.

::: noteclassic
Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d'appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir les [rôles utilisateur](/manual/web_interface/frontend_sections/administration/user_roles) pour plus d'informations.
:::

[comment]: # ({/0c82416b-858936aa})

[comment]: # ({99d9352e-06a650a0})
### Paramètres

`(object)` Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

|Paramètre|[Type](/manual/api/reference_commentary#data_types)|Description|
|---------|---------------------------------------------------|-----------|
|correlationids|string/array|Renvoie uniquement les corrélations avec les identifiants spécifiés.|
|selectFilter|query|Renvoie les conditions de de corrélation dans la propriété [filter](/manual/api/reference/correlation/object#correlation_filter).|
|selectOperations|query|Renvoie les opérations de corrélation dans la propriété [operations](/manual/api/reference/correlation/object#correlation_operation).|
|sortfield|string/array|Trier le résultat par les propriétés spécifiées.<br><br>Valeurs possibles : `correlationid`, `name` et `status`.|
|countOutput|boolean|Ces paramètres communs à toutes les méthodes `get` sont décrits en détail dans la page des [commentaires de référence](/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]: # ({/99d9352e-06a650a0})

[comment]: # ({7223bab1-7223bab1})
### Valeurs retournées

`(integer/array)` Retourne soit:

- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre `countOutput` a été utilisé.

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

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

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

[comment]: # ({21909ea5-d14c4f20})
#### Récupération des corrélations

Récupérer toutes les corrélations configurées ainsi que les conditions et opérations de corrélation. Le filtre utilise le type d'évaluation "et/ou", ainsi la propriété `formula` est vide et la propriété `eval_formula` est générée automatiquement.

Requête :

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

Réponse :

``` {.java}
{
 "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]: # ({/21909ea5-d14c4f20})

[comment]: # ({e7d15410-e7d15410})
### Voir également
- [Filtre de Corrélation](object#correlation_filter)
- [Opération de Corrélation](object#correlation_operation)

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

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

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

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