Objetivo

• El parámetro $filter te permite aplicar criterios de filtrado a los recursos devueltos por la API.

Puntos clave

• Los filtros se pueden aplicar a las propiedades del recurso principal.
• Puedes combinar varios criterios de filtrado usando operadores lógicos y funciones de cadena.
• El filtrado admite tipos de datos como integer, big integer, double, decimal, string, date y datetimeoffset.
• La API no admite el filtrado sobre propiedades de recursos anidados.

Sintaxis de la expresión $filter

• La expresión sigue este formato:

[OPERATOR (PROPERTY_NAME, 'VALUE')]

• Esto significa que puedes combinar varias condiciones usando operadores lógicos.

[(contains(prod_ref,'ECx')) or (contains(prod_title,'App'))]

Propiedades compatibles

• La lista de propiedades disponibles para el recurso Product se puede encontrar en el esquema JSON devuelto por los endpoints /$metadata.
• Ejemplo: al hacer una solicitud a /Products/$metadata, obtendrás un esquema con todas las propiedades disponibles, como prod_title, prod_ref, etc.

Cómo usar $filter en una solicitud

• Al construir tu solicitud de API, añade el parámetro $filter para indicar las condiciones de filtrado.

http://api2.saleslayer.com/rest/Catalog/Products?$select=prod_ref,prod_title&$filter=contains(prod_title,'EC')

Formato de respuesta

• Cuando uses $filter, la respuesta solo contendrá los recursos que coincidan con los criterios indicados.

{
    "value": [
        {
            "prod_ref": "MyPer",
            "prod_title": {
                "en": "EC Personify"
            }
        }
    ],
    "@count": 1,
    "@readLink": "http://api2.saleslayer.com/rest/Catalog/Products?$select=prod_ref,prod_title&$filter=contains(prod_title,'EC')"
}

Notas

• El parámetro $filter es una herramienta muy útil para reducir el tamaño de la respuesta, especialmente cuando trabajas con conjuntos de datos grandes.
• Te recomendamos consultar siempre el endpoint de metadata, por ejemplo /Products/$metadata, para confirmar qué propiedades están disponibles en los recursos con los que estás trabajando.