Obtener cambios incrementales

Este endpoint permite consultar los cambios registrados en las incidencias desde una fecha concreta. El objetivo que se persigue es poder realizar peticiones recurrentes para mantener actualizados los datos de manera más sencilla.

GET /api/v2/businesses/{businessId}/incidences/incremental?since={yyyy-MM-ddTHH:mm:ss.mss}

La respuesta es paginada, es decir, contiene una cabecera next que indica la URL de la siguiente petición incremental: para obtener la siguiente página, se debe realizar una petición a esa URL. La última página no contiene la cabecera, lo que indica que la paginación ha terminado.

Si los datos incluidos en la petición son correctos, la petición devuelve las incidencias que han cambiado desde una fecha dada (since) hasta la fecha actual. Orquest solo almacena los últimos 45 días de cambios incrementales, por lo que la consulta deberá considerar ese intervalo de tiempo.

Ejemplo de respuesta

[
    {
        "employeeId": "0001",
        "businessDay": "2026-08-12",
        "incidences": [
            {
                "initTime": "12:00",
                "endTime": "13:00",
                "workedMinutes": 0,
                "from": "2026-08-12",
                "to": "2026-08-12",
                "id": "2026-08-12-2026-08-12",
                "orquestId": 63167596
            }
        ]
    }
]
Detalles

  • employeeId: identificador externo del empleado.

  • businessDay: día de negocio al que se imputan las incidencias agrupadas, en formato yyyy-MM-dd.

  • incidences: listado de incidencias del empleado para el día indicado.

    • type: identificador del tipo de incidencia, configurado previamente en Orquest.

    • initTime: hora de inicio de la incidencia, en formato HH:mm. Se considera la hora local, es decir, la zona horaria del servicio.

    • endTime: hora de finalización de la incidencia, en formato HH:mm. Se considera la hora local, es decir, la zona horaria del servicio.

    • workedMinutes: tiempo, en minutos, que la incidencia computa.

    • from: fecha en la que comienza la incidencia, en formato yyyy-MM-dd.

    • to: fecha en la que finaliza la incidencia, en formato yyyy-MM-dd.

    • id: identificador externo de la incidencia.

    • orquestId: identificador interno de la incidencia en Orquest.

Consideraciones

Dada la naturaleza compleja de los datos, hay ocasiones en las que no se puede determinar si un elemento ha cambiado realmente o no. Por ejemplo, ante cambios masivos, cuando la modificación se realiza en bloque y no se lleva a cabo una comparación exhaustiva. En este sentido, es posible que se tenga en cuenta que han cambiado las incidencias de un día, independientemente de cuántas incidencias hayan cambiado en él.

El uso de este endpoint requiere que la funcionalidad sea activada previamente por el equipo de Orquest, dado su coste de cómputo y memoria al realizar auditorías sobre ciertas entidades. Por tanto, será necesario analizar el caso de uso y gestionar su habilitación.

Códigos de error

Además de los errores comunes, este endpoint puede devolver los siguientes códigos:

Código Mensaje Descripción

400 Bad Request

Business not authorized

El negocio no tiene habilitada la consulta de cambios incrementales de incidencias. Se recomienda contactar con el equipo de Orquest para habilitarla.

406 Not Acceptable

-

El parámetro since tiene un formato inválido, o no se ha indicado ni since ni cursor en la petición. Se recomienda revisar el formato de fecha (yyyy-MM-ddTHH:mm:ss.SSS) e incluir uno de los dos parámetros.

Enlaces de interés

¿Qué es una incidencia?

¿Cómo integrar incidencias?