correlation.get

Apraksts

integer/array correlation.get(object parameters)

Metode ļauj izgūt korelācijas atbilstoši norādītajiem parametriem.

Šī metode ir pieejama jebkura tipa lietotājiem. Atļaujas izsaukt šo metodi var tikt atsauktas lietotāju lomu iestatījumos. Plašāku informāciju skatiet Lietotāju lomas.

Parametri

(object) Parametri, kas nosaka vēlamo izvadi.

Metode atbalsta šādus parametrus.

Parametrs Tips Apraksts
correlationids ID/array Atgriezt tikai korelācijas ar norādītajiem ID.
selectFilter query Atgriezt filter īpašību ar korelācijas nosacījumiem.
selectOperations query Atgriezt operations īpašību ar korelācijas operācijām.
sortfield string/array Kārtot rezultātu pēc norādītajām īpašībām.

Iespējamās vērtības: correlationid, name, status.
countOutput boolean Šie parametri ir aprakstīti atsauces komentārā.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Atgrieztās vērtības

(integer/array) Atgriež:

  • objektu masīvu;
  • izgūto objektu skaitu, ja ir izmantots parametrs countOutput.

Piemēri

Iegūt korelācijas

Iegūt visas konfigurētās korelācijas kopā ar korelāciju nosacījumiem un operācijām. Filtrs izmanto "and/or" novērtēšanas tipu, tāpēc formula īpašība ir tukša un eval_formula tiek ģenerēta automātiski.

Pieprasījums:

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

Atbilde:

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

Skatiet arī

Avots

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