[comment]: # aside: 1

[comment]: # ({f1f8a413-e205e572})
# Objeto correlation

Os seguintes objetos estão diretamente relacionados à API `correlation`.

[comment]: # ({/f1f8a413-e205e572})

[comment]: # ({f8f9bf74-935ba6ef})
### Correlação

O objeto de correlação possui as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|correlationid|ID|ID da correlação.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*<br>- *obrigatório* para operações de atualização|
|name|string|Nome da correlação.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* para operações de criação|
|description|string|Descrição da correlação.|
|status|integer|Se a correlação está habilitada ou desabilitada.<br><br>Valores possíveis:<br>0 - *(padrão)* habilitada;<br>1 - desabilitada.|

[comment]: # ({/f8f9bf74-935ba6ef})

[comment]: # ({bdea5057-d12c2169})
### Operação de correlação

O objeto de operação de correlação define uma operação que será executada quando uma correlação for executada. Possui as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|type|integer|Tipo de operação.<br><br>Valores possíveis:<br>0 - fechar eventos antigos;<br>1 - fechar novo evento.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório*|

[comment]: # ({/bdea5057-d12c2169})

[comment]: # ({b1607be6-d0662dba})
### Filtro de correlação

O objeto de filtro de correlação define um conjunto de condições que devem ser atendidas para executar as operações de correlação configuradas.
Possui as seguintes propriedades.

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|conditions|array|Conjunto de [condições de filtro](#correlation-filter-condition) a serem usadas para filtrar os resultados. As condições serão classificadas na ordem de sua colocação na fórmula.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório*|
|evaltype|integer|[Método de avaliação](/manual/config/event_correlation/global#configuration) da condição do filtro.<br><br>Valores possíveis:<br>0 - E/Ou;<br>1 - E;<br>2 - Ou;<br>3 - Expressão personalizada.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório*|
|eval\_formula|string|Expressão gerada que será usada para avaliar as condições do filtro. A expressão contém IDs que referenciam condições de filtro específicas por seu `formulaid`. O valor de `eval_formula` é igual ao valor de `formula` para filtros com uma expressão personalizada.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *somente leitura*|
|formula|string|Expressão definida pelo usuário a ser usada para avaliar as condições dos filtros com uma expressão personalizada. A expressão deve conter IDs que referenciem condições de filtro específicas por seu `formulaid`. Os IDs usados na expressão devem corresponder exatamente aos definidos nas condições do filtro: nenhuma condição pode permanecer não utilizada ou omitida.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `evaltype` estiver definido como "expressão personalizada"|

[comment]: # ({/b1607be6-d0662dba})

[comment]: # ({46c1514b-72ee5420})
#### Condição de filtro de correlação

O objeto de condição de filtro de correlação define uma condição específica
que deve ser verificada antes de executar as operações de correlação.

|Propriedade|[Tipo](/manual/api/reference_commentary#data-types)|Descrição|
|--|--|------|
|type|integer|Tipo de condição.<br><br>Valores possíveis:<br>0 - tag de evento antigo;<br>1 - tag de evento novo;<br>2 - grupo de hosts do evento novo;<br>3 - par de tags de evento;<br>4 - valor da tag de evento antigo;<br>5 - valor da tag de evento novo.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório*|
|tag|string|Tag do evento (antigo ou novo).<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "tag de evento antigo", "tag de evento novo", "valor da tag de evento antigo" ou "valor da tag de evento novo"|
|groupid|ID|ID do grupo de hosts.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "grupo de hosts do evento novo"|
|oldtag|string|Tag do evento antigo.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "par de tags de evento"|
|newtag|string|Tag do evento novo.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "par de tags de evento"|
|value|string|Valor da tag do evento (antigo ou novo).<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "valor da tag de evento antigo" ou "valor da tag de evento novo"|
|formulaid|string|ID único arbitrário que é usado para referenciar a condição a partir de uma expressão personalizada. Só pode conter letras maiúsculas. O ID deve ser definido pelo usuário ao modificar as condições do filtro, mas será gerado novamente ao solicitá-las posteriormente.|
|operator|integer|Operador da condição.<br><br>[Comportamento da propriedade](/manual/api/reference_commentary#property-behavior):<br>- *obrigatório* se `type` estiver definido como "grupo de hosts do evento novo", "valor da tag de evento antigo" ou "valor da tag de evento novo"|

::: notetip
Para entender melhor como usar filtros com vários
tipos de expressões, veja exemplos nas páginas dos métodos
[correlation.get](get#retrieve-correlations) e
[correlation.create](create#using-a-custom-expression-filter).
:::

Os seguintes operadores e valores são suportados para cada tipo de condição.

|Condição|Nome da condição|Operadores suportados|Valor esperado|
|---------|--------------|-------------------|--------------|
|2|Grupo de hosts|=, <>|ID do grupo de hosts.|
|4|Valor da tag de evento antigo|=, <>, like, not like|string|
|5|Valor da tag de evento novo|=, <>, like, not like|string|

[comment]: # ({/46c1514b-72ee5420})