correlation.get

Description

integer/array correlation.get(object parameters)

Cette méthode permet de récupérer les corrélations selon les paramètres donnés.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appeler la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.

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 ID/array Retourner uniquement les corrélations avec les ID donnés.
selectFilter query Retourner une propriété filter avec les conditions de corrélation.
selectOperations query Retourner une propriété operations avec les opérations de corrélation.
sortfield string/array Trier le résultat selon les propriétés données.

Valeurs possibles : correlationid, name, status.
countOutput boolean Ces paramètres sont décrits dans le commentaire de référence.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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é.

Exemples

Récupérer les corrélations

Récupérez toutes les corrélations configurées avec les conditions et les opérations de corrélation. Le filtre utilise le type d’évaluation « and/or », donc la propriété formula est vide et eval_formula est générée automatiquement.

Requête :

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

Réponse :

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

Voir également

Source

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