Propósito

• El parámetro $select te permite especificar qué propiedades de un recurso deben incluirse en la respuesta.

Puntos clave

• Puedes incluir propiedades concretas de cualquier recurso enumerándolas en la expresión $select.
• Esto ayuda a reducir la cantidad de datos devueltos, mejorando el rendimiento.
• Las propiedades deben especificarse por nombre y deben coincidir con las definidas en los metadatos.

Sintaxis de la expresión $select

• La expresión sigue este formato:

PROPERTY1_NAME, PROPERTY2_NAME

• Esto significa que puedes listar varias propiedades separadas por comas.

prod_ref, prod_title

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 $select en una solicitud

• Al construir tu solicitud a la API, añade el parámetro $select para especificar los campos que quieres recuperar.

http://api2.saleslayer.com/rest/Catalog/Products?$select=prod_ref,prod_title

Formato de la respuesta

• Cuando usas $select, la respuesta solo contendrá las propiedades especificadas, por lo que será más concisa y eficiente.

{
    "value": [
        {
            "prod_ref": "MyPer",
            "prod_title": {
                "en": "My Personify"
            }
        },
        {
            "prod_ref": "CuMoApp",
            "prod_title": {
                "en": "Custom Mobile Apps"
            }
        },
        {
            "prod_ref": "Atrius",
            "prod_title": {
                "en": "Atrius"
            }
        },
        {
            "prod_ref": "Builder",
            "prod_title": {
                "en": "Builder"
            }
        },
        {
            "prod_ref": "X-pressP",
            "prod_title": {
                "en": "X-press gfx Points"
            }
        },
        {
            "prod_ref": "EC-gfx",
            "prod_title": {
                "en": "EC-gfxProgram"
            }
        },
        {
            "prod_ref": "PreApp",
            "prod_title": {
                "en": "Preloaded Applications"
            }
        },
        {
            "prod_ref": "ProdEnhanT",
            "prod_title": {
                "en": "Productivity Enhancing Tools"
            }
        },
        {
            "prod_ref": "ECx-L-4D",
            "prod_title": {
                "en": "ECx-Light-4DALI"
            }
        },
        {
            "prod_ref": "ECx-L-S",
            "prod_title": {
                "en": "ECx-Light Series"
            }
        },
        {
            "prod_ref": "ECx-B-S",
            "prod_title": {
                "en": "ECx-Blind Series"
            }
        }
    ],
    "@count": 11,
    "@readLink": "https://api2.saleslayer.com/rest/Catalog/Products?$select=[prod_ref,prod_title]"
}

Notas

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