correlatie.get

Beschrijving

integer/array correlation.get(object parameters)

De methode maakt het mogelijk om correlaties op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

|Parameter|Type|Beschrijving| |---------|--------------------------------------- ------------|-----------| |correlationids|string/array|Retourneer alleen correlaties met de opgegeven ID's.| |selectFilter|query|Retourneer een eigenschap filter met de correlatievoorwaarden.| |selectOperations|query|Retourneer een eigenschap operations met de correlatiebewerkingen.| |sortfield|string/array|Sorteer het resultaat op de gegeven eigenschappen.

Mogelijke waarden zijn: correlationid, name en status.| |countOutput|boolean|Deze parameters gelden voor alle get-methoden en worden beschreven in de referentiecommentaar.| |editable|booleaans|^| |excludeSearch|boolean|^| |filter|object|^| |limit|geheel getal|^| |output|query|^| |preservekeys|boolean|^| |search|object|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|booleaans|^|

Retourwaarden

(integer/array) Retourneert ofwel:

een reeks objecten;
het aantal opgehaalde objecten, als de parameter countOutput is gebruikt.

Voorbeelden

Correlaties ophalen

Haal alle geconfigureerde correlaties op samen met correlatie omstandigheden en operaties. Het filter gebruikt het evaluatietype "en/of",

Verzoek:

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

Antwoord:

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

Zie ook

Bron

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

Documentation