correlation.get

Beschrijving

integer/array correlation.get(object parameters)

Deze methode maakt het mogelijk om correlaties op te halen volgens de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode op te roepen kunnen worden ingetrokken in gebruikersrol-instellingen. Zie Gebruikersrollen voor meer informatie.

Parameters

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

De methode ondersteunt de volgende parameters.

Parameter	Type	Omschrijving
correlationids	string/array	Geef alleen correlaties terug met de opgegeven ID's.
selectFilter	query	Geef een eigenschap filter terug met de correlatievoorwaarden.
selectOperations	query	Geef een eigenschap operations terug met de correlatiebewerkingen.
sortfield	string/array	Sorteer het resultaat op de opgegeven eigenschappen. Mogelijke waarden: `correlationid`, `naam`, `status`.
countOutput	boolean	Deze parameters die gemeenschappelijk zijn voor alle `get` methodes, worden beschreven in het referentiecommentaar.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Retourwaarden

(integer/array) Retourneert ofwel:

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

Voorbeelden

Correlaties ophalen

Haal alle geconfigureerde correlaties op, samen met correlatievoorwaarden en bewerkingen. De filter maakt gebruik van het evaluatietype "en/of", dus de eigenschap formula is leeg en eval_formula wordt automatisch gegenereerd.

Aanvraag:

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

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "correlationid": "1",
                   "naam": "Correlatie 1",
                   "omschrijving": "",
                   "status": "0",
                   "filter": {
                       "evaltype": "0",
                       "formula": "",
                       "voorwaarden": [
                           {
                               "type": "3",
                               "oudetag": "fout",
                               "nieuwetag": "ok",
                               "formulaid": "A"
                           }
                       ],
                       "eval_formula": "A"
                   },
                   "bewerkingen": [
                       {
                           "type": "0"
                       }
                   ]
               }
           ],
           "id": 1
       }

Zie ook

Bron

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

Documentation