[comment]: # ({7416ad19-7416ad19})
# correlation.get

[comment]: # ({/7416ad19-7416ad19})

[comment]: # ({6e13bc51-858936aa})
### Descripción

`integer/array correlation.get(object parameters)`

El método permite recuperar correlaciones según los parámetros dados.

::: noteclassic
Este método está disponible para usuarios de cualquier tipo. Los permisos
para llamar al método se pueden revocar en la configuración de roles de usuario. Ver [Roles de usuario](/manual/web_interface/frontend_sections/users/user_roles)
para más información.
:::

[comment]: # ({/6e13bc51-858936aa})

[comment]: # ({7c68a8c3-06a650a0})
### Parámetros

`(object)` Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

|Parámetro|[Tipo](/manual/api/reference_commentary#data-types)|Descripción|
|--|--|------|
|correlationids|ID/array|Devolver solo las correlaciones con los IDs dados.|
|selectFilter|query|Devolver una propiedad [`filter`](/manual/api/reference/correlation/object#correlation-filter) con las condiciones de correlación.|
|selectOperations|query|Devolver una propiedad [`operations`](/manual/api/reference/correlation/object#correlation-operation) con las operaciones de correlación.|
|sortfield|string/array|Ordenar el resultado por las propiedades dadas.<br><br>Valores posibles: `correlationid`, `name`, `status`.|
|countOutput|boolean|Estos parámetros se describen en el [comentario de referencia](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/7c68a8c3-06a650a0})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno

`(entero/matriz)` Devuelve:

- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro `countOutput`
    ha sido usado.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Ejemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({ef8be6d3-d14c4f20})
#### Recuperar correlaciones

Recuperar todas las correlaciones configuradas junto con las 
condiciones y operaciones de la correlación. El filtro utiliza el tipo de evaluación "y/o",
entonces la propiedad `fórmula` está vacía y se genera `eval_formula`
automáticamente.

[Solicitud](/manual/api#performing-requests):

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

Respuesta:

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

[comment]: # ({/ef8be6d3-d14c4f20})

[comment]: # ({1341f8b4-e7d15410})
### Ver también

-   [Filtro de correlación](object#correlation-filter)
-   [Operación de correlación](object#correlation-operation)

[comment]: # ({/1341f8b4-e7d15410})

[comment]: # ({bbab04bd-bbab04bd})
### Fuente

CCorrelación::get() en
*ui/include/classes/api/services/CCorrelation.php*.

[comment]: # ({/bbab04bd-bbab04bd})