Filtros genéricos

En esta guía, veremos cómo trabajar con respuestas que permiten aplicar filtros genéricos al consultar la API de Subsidy. Los filtros se pueden aplicar a través del parámetro en el cuerpo filter y se pueden combinar con la paginación y la ordenación.

Cuando los filtros genéricos estan habilitados, se pueden aplicar a cualquier campo de la respuesta. Si dentro de la respuesta hay un objeto anidado, se puede acceder a sus campos utilizando el operador .. Por ejemplo, si queremos filtrar por el campo name de la respuesta user, podemos hacerlo de la siguiente manera user.name. Es posible que algunos campos no sean filtrables.

Para diferentes tipos de datos, los filtros se pueden aplicar de diferentes maneras. A continuación, se muestra una tabla con los diferentes tipos de datos y cómo se pueden aplicar los filtros.

Tipo de dato	Ejemplo de filtro	Descripción
`string`	`John`	Filtra si contiene el valor especificado.
`number`	`{ from: 10, to: 20 }`	Filtra por el valor del campo dentro del rango especificado.
`date`	`{ from: '2020-01-01', to: '2020-12-31' }`	Filtra por el valor del campo dentro del rango especificado.
`options`	`[{ value: "OPT 1" }, { value: "OPT 2" }]`	Filtra por el valor del campo dentro de los valores especificados.

Ejemplo

Ejemplo aplicando filtros a un pedido.

Atributos

Name
filter
Type
object
Description
Filtros a aplicar al pedido.

Pedido con filtro

{
  "filter": {
    "code": "123abc",
    "amount": { "from": 500, "to": 4000 },
    "charged_pay_at": { 
      "from": "2022-08-29",
      "to": "2023-05-12"
    },
    "contingency": [
      { "value": "ENFERMEDAD COMÚN" },
      { "value": "ACCIDENTE DE TRABAJO" },
    ],
    "user.name": "John",
  }
}