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

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

[comment]: # ({63c25abe-858936aa})
### Description

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

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

[comment]: # ({/63c25abe-858936aa})

[comment]: # ({295ca463-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|Description|
|----------|----|-----------|
|correlationids|string/array|Renvoie uniquement les corrélations avec les identifiants spécifiés.|
|selectFilter|query|Renvoie le filtre de corrélation dans la propriété `filter`.|
|selectOperations|query|Renvoie les opérations de corrélation dans la propriété `operations`.|
|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 dans les [commentaires de référence](/fr/manual/api/reference_commentary#Parametres_communs_de_la_methode_get).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/295ca463-06a650a0})

[comment]: # ({51ae0d6d-7223bab1})
### Valeurs de retour

`(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]: # ({/51ae0d6d-7223bab1})

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

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

[comment]: # ({9b215fb0-d14c4f20})
#### Récupérer 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]: # ({/9b215fb0-d14c4f20})

[comment]: # ({d890b34f-e7d15410})
### Voir également

-   [Filtre de Corrélation](object#filtre_de_correlation)
-   [Opération de Corrélation](object#operation_de_correlation)

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

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

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

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