Áú»¢¶Ä²©

correlation.get

¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®

integer/array correlation.get(object parameters)

El m¨¨tode permet recuperar correlacions segons els par¨¤metres prove?ts.

Aquest m¨¨tode ¨¦s disponible per a usuaris de qualsevol mena. Els permisos per cridar al m¨¨tode es poden revocar a les configuracions de rols d'usuari. Per a m¨¦s informaci¨®, veieu Rols d'usuari.

±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ

(objet) ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ que defineixen la sortida esperada.

El m¨¨tode admet els par¨¤metres seg¨¹ents.

±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð Tipus ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
correlationids ID/array Retorna nom¨¦s correlacions amb els identificadors donats.
selectFilter query Retorna una propietat filtre amb la correlaci¨® de condicions.
selectOperations query Retorna una propietat operacions amb la correlaci¨® de condicions.
sortfield string/array Ordena el resultat segons les propietats donades.

Els valors possibles s¨®n: rcorrelationid, name, status.
countOutput boolean Aquests par¨¤metres es descriuen als comentaris de refer¨¨ncia.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el par¨¤metre countOutput.

Exemples

Recuperar correlacions

Recupera totes les correlacions configurades juntament amb condicions i operacions. El filtre empra "i/o" tipus d'avaluaci¨®, pel que la propietat formula ¨¦s buida i eval_formula es genera autom¨¤ticament.

±Ê±ð³Ù¾±³¦¾±¨®:

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

Resposta:

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

Veieu tamb¨¦

Font

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