correlation.get

Descrição

integer/array correlation.get(object parameters)

O método permite recuperar correlações de acordo com os parâmetros fornecidos.

Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário. Veja Funções de usuário para mais informações.

Parâmetros

(object) Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

Parâmetro	Tipo	Descrição
correlationids	ID/array	Retorna apenas correlações com os IDs fornecidos.
selectFilter	query	Retorna uma propriedade `filter` com as condições de correlação.
selectOperations	query	Retorna uma propriedade `operations` com as operações de correlação.
sortfield	string/array	Ordena o resultado pelas propriedades fornecidas. Valores possíveis: `correlationid`, `name`, `status`.
countOutput	boolean	Esses parâmetros são descritos no comentário 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

Valores de retorno

(integer/array) Retorna:

um array de objetos;
a contagem de objetos recuperados, se o parâmetro countOutput tiver sido usado.

Exemplos

Recuperar correlações

Recupera todas as correlações configuradas juntamente com as condições e operações de correlação. O filtro usa o tipo de avaliação "and/or", portanto, a propriedade formula fica vazia e eval_formula é gerada automaticamente.

Requisição:

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

Veja também

Fonte

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

Documentation