Registrar una incidencia

Este endpoint permite registrar la información de una incidencia para un empleado.

POST /api/v1/import/incidence

A continuación, se expone una explicación detallada de cada uno de los campos que pueden conformar el cuerpo de la petición, siendo algunos de ellos obligatorios para que esta se realice de manera exitosa.

Los campos obligatorios están marcados con un asterisco (*).

Cuerpo de la petición

Análisis del JSON 
{
  "business": "string",
  "employeeId": "string",
  "type": "string",
  "initTime": "string",
  "endTime": "string",
  "workedMinutes": 0,
  "from": "string",
  "to": "string",
  "id": "string",
  "orquestId": 0
}
Detalles

  • business*: identificador configurado en Orquest para el negocio.

  • employeeId*: identificador del empleado vinculado con la incidencia.

  • type*: identificador del tipo de incidencia. Debe estar configurado previamente en Orquest.

  • initTime: hora de inicio de la incidencia. Debe estar en formato HH:mm con la siguiente expresión regular: ^([01]\d|2[0-3]):[0-5]\d$. Se considera la hora local, es decir, la zona horaria del servicio.

  • endTime: hora de finalización de la incidencia. Debe estar en formato HH:mm con la siguiente expresión regular: ^([01]\d|2[0-3]):[0-5]\d$. Se considera la hora local, es decir, la zona horaria del servicio.

  • workedMinutes*: número de minutos que el empleado ha trabajado desde el inicio de su jornada laboral hasta el comienzo de la incidencia. Si el empleado no ha trabajado, deberá especificarse 0.

  • from*: fecha en la que comienza la incidencia. Debe estar en formato yyyy-MM-dd.

  • to*: fecha en la que finaliza la incidencia. Debe estar en formato yyyy-MM-dd.

  • id: identificador externo de la incidencia.

  • orquestId: identificador interno de la incidencia en Orquest.

Ejemplo de la petición

Una vez realizado el análisis de los distintos campos, se muestra un ejemplo del cuerpo de la petición:

{
  "business": "BUSINESSID",
  "employeeId": "C14A658",
  "type": "01",
  "initTime": "08:30",
  "endTime": "09:30",
  "workedMinutes": 30,
  "from": "2024-04-15",
  "to": "2024-04-15",
  "id": "C14-12545"
}

Aspectos que tener en cuenta

Esta petición generará una operación atómica que se puede revertir de forma automática si hay errores: el error se mostrará en la respuesta de la petición.

Si una incidencia no está definida en el catálogo de incidencias del negocio, no podrá ser asignada a ningún empleado.

Si la incidencia solapa con otra incidencia registrada previamente en el sistema, la petición devolverá un error 400 Bad Request indicando error.incidence_overlapped.

Enlaces de interés

¿Qué es una incidencia?

¿Cómo integrar incidencias?