Consultas por ID

Las consultas por ID permiten acceder directamente a un registro específico dentro de una entidad del sistema. Esta funcionalidad es útil para obtener información puntual sin necesidad de realizar filtros complejos.

❔ ¿Cómo saber cuál es el campo clave?

Cada entidad tiene uno o más campos clave que la identifican de forma única. Para conocerlos, puedes consultar la metadata del servicio OData, como se explica en la sección correspondiente de esta guía.

🔑 Consultas en entidades con clave simple

Si la entidad tiene un solo campo clave, puedes realizar la consulta agregando el valor entre paréntesis al final de la URL. Aquí algunos ejemplos:

Consultar un producto por código

Producto con código 000001:

GET /v1/OrganizacionOData.svc/Producto('000001')?$format=json

Producto con código 000002:

GET /v1/OrganizacionOData.svc/Producto('000002')?$format=json

Consultar un cliente por identificación

Cliente con identificación 986741698-8:

GET /v1/OrganizacionOData.svc/Cliente('986741698-8')?$format=json

🔑🔑 Consultas en entidades con clave compuesta

Algunas entidades, como las ventas, tienen claves compuestas. En estos casos, debes incluir todos los valores clave en el orden definido por la metadata, separados por comas dentro de los paréntesis.

Consultar encabezado de venta

Venta realizada en la Terminal 010101, con MesDia 0105 y Consecutivo 0001:

GET /v1/OrganizacionOData.svc/VentaEnero(Terminal='010101',MesDia='0105',Consecutivo='0001')?$format=json

❓ ¿Qué pasa si el registro no existe?

Si intentas consultar un registro que no está en el sistema, recibirás una respuesta como:

Recurso no encontrado para el segmento 'Entidad'

Por ejemplo, al consultar un producto inexistente: