correlation.get

Beschreibung

integer/array correlation.get(object parameters)

Die Methode ermöglicht es, Korrelationen entsprechend den angegebenen Parametern abzurufen.

Diese Methode ist für Benutzer jeden Typs verfügbar. Die Berechtigung zum Aufruf der Methode kann in den Benutzerrolleneinstellungen entzogen werden. Prüfen Sie Benutzer- Rollen für mehr Informationen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
correlationids ID/array Gibt nur Korrelationen mit den angegebenen IDs zurück.
selectFilter query Gibt eine Eigenschaft filter mit den Korrelationsbedingungen zurück.
selectOperations query Gibt eine Eigenschaft operations mit den Korrelationsoperationen zurück.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: correlationid, name, status.
countOutput boolean Diese Parameter sind in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Gibt entweder:

  • ein Array von Objekten zurück;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Korrelationen abrufen

Rufen Sie alle konfigurierten Korrelationen zusammen mit den Korrelationsbedingungen und Operationen ab. Der Filter verwendet den Auswertungstyp „and/or“, daher ist die Eigenschaft formula leer und eval_formula wird automatisch generiert.

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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