Documentation
Table of Contents
correlation.get
Descrição
inteiro/array correlação.obter(parâmetros do objeto)
O método permite recuperar correlações de acordo com os parâmetros fornecidos.
::: nota clássica 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 oferece suporte aos parâmetros a seguir.
|Parâmetro|Tipo|Descrição| |---------|----------------------------------- ------------|-----------| |correlationids|string/array|Retorna apenas correlações com os IDs fornecidos.| |selectFilter|query|Retorne uma propriedade filter com as condições de correlação.| |selectOperations|query|Retorne uma propriedade operações com as operações de correlação.| |sortfield|string/array|Ordenar o resultado pelas propriedades fornecidas.
Os valores possíveis são: correlationid, name e status.| |countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos get são descritos no comentário de referência.| |editável|booleano|^| |excludePesquisa|boolean|^| |filtro|objeto|^| |limite|inteiro|^| |saída|consulta|^| |preservekeys|boolean|^| |pesquisar|objeto|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |ordem de classificação|cadeia/matriz|^| |startSearch|boolean|^|
Valores de retorno
(integer/array) Retorna:
- uma matriz de objetos;
- a contagem de objetos recuperados, se o parâmetro
countOutputtiver sido usado.
Exemplos
Recuperar correlações
Recupere todas as correlações configuradas junto com a correlação condições e operações. O filtro usa o tipo de avaliação "e/ou", então a propriedade formula está vazia e eval_formula é gerado automaticamente.
Solicitação:
{
"jsonrpc": "2.0",
"método": "correlação.get",
"parâmetros": {
"saída": "estender",
"selectOperations": "extender",
"selectFilter": "estender"
},
"auth": "343baad4f88b4106b9b5961e77437688",
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"resultado": [
{
"correlationid": "1",
"nome": "Correlação 1",
"Descrição": "",
"estado": "0",
"filtro": {
"evaltype": "0",
"Fórmula": "",
"condições": [
{
"tipo": "3",
"oldtag": "erro",
"newtag": "ok",
"formulaid": "A"
}
],
"eval_formula": "A"
},
"operações": [
{
"tipo": "0"
}
]
}
],
"id": 1
}Veja também
Fonte
CCorrelation::get() in ui/include/classes/api/services/CCorrelation.php.