correlation.get

Descrizione

integer/array correlation.get(object parameters)

Il metodo consente di recuperare le correlazioni in base ai parametri specificati.

Questo metodo è disponibile per utenti di qualsiasi tipo. Le autorizzazioni per richiamare il metodo possono essere revocate nelle impostazioni dei ruoli utente. Per ulteriori informazioni, vedere Ruoli utente

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Type Descrizione
correlationids ID/array Restituisce solo le correlazioni con gli ID specificati.
selectFilter query Restituisce una proprietà filter con le condizioni della correlazione.
selectOperations query Restituisce una proprietà operations con le operazioni della correlazione.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: correlationid, name, status.
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(integer/array) Restituisce:

  • un array di oggetti;
  • il conteggio degli oggetti recuperati, se il parametro countOutput è stato usato.

Esempi

Recuperare le correlazioni

Recupera tutte le correlazioni configurate insieme alle condizioni e alle operazioni di correlazione. Il filtro utilizza il tipo di valutazione "and/or", quindi la proprietà formula è vuota e eval_formula viene generata automaticamente.

Richiesta:

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

Risposta:

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

Vedi anche

Sorgente

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