Asignaciones

En este apartado, se encuentra la explicación técnica y detallada de todos los endpoints necesarios para gestionar la información relativa a las asignaciones a través de la API.

Aspectos que tener en cuenta

Considerando los datos que devuelve la API en estas peticiones, es necesario hacer una distinción entre dos conceptos: asignación y resumen de asignaciones.

Asignación

Hace referencia a la información detallada y específica sobre los empleados, tareas y horarios individuales. Cada asignación contiene la siguiente información:

Estructura de una asignación

  • product. Identificador del producto (sección) al que pertenece la asignación.

  • blockedType. Si la asignación está bloqueada y cómo (NONE, EXTENSIBLE_WORK, NON_EXTENSIBLE_WORK, EXTENSIBLE_TIME, NON_EXTENSIBLE_TIME, DAILY_WORKED).

  • person. Identificador del empleado.

  • day. Día de la asignación en formato yyyy-MM-dd.

  • presence. Tipo de asignación que contiene los periodos de trabajo (timeFrames) con sus ubicaciones. Contiene los siguientes campos:

    • startTime. La hora de inicio de la presencia en minutos desde el comienzo del día (00:00). Puede ser null, ya que la hora de inicio real se puede calcular como la suma de las duraciones de sus periodos de tiempo (timeFrames).

    • duration. La duración en minutos de toda la presencia. Puede ser null, ya que la duración real se puede calcular como la suma de las duraciones de sus periodos de tiempo (timeFrames).

    • worked. Si el tipo de asignación o presencia es trabajada (true) o si es un día de descanso (false).

    • timeFrames. Conjunto de intervalos de tiempo que contiene las tareas que se van a realizar. Para cada intervalo, se incluye la siguiente información:

      • startMinuteDay. Comienzo del intervalo en minutos transcurridos desde el inicio del día (00:00).

      • duration. Duración del intervalo en minutos.

      • paid. Si el intervalo, sea de trabajo o descanso, es pagado (true) o no (false).

      • worked. Determina si el timeFrame tiene tarea asignada (true) o es un intervalo de descanso (false).

      • location. Tarea que se va a realizar en el intervalo definido. Por cada tarea, se incluye la siguiente información:

        • color. Color configurado en Orquest para la tarea.

        • description. Descripción de la tarea definida en Orquest.

        • name. Nombre de la tarea en Orquest.

        • shortName. Abreviatura de la tarea en Orquest.

        • requiredLevel. Nivel de aptitud requerido para realizar la tarea. Va de 0 (sin necesidad de formación) a 3 (nivel máximo de formación) y debe ser previamente configurado en Orquest.

        • priority. Prioridad de cobertura de la tarea. Va de 0 (baja) a 5 (alta) y debe ser previamente configurada en Orquest.

        • maxResources. Límite de personas para la tarea.

        • type. Tipo de tarea, si es fija, variable o no planificable (FIXED, VARIABLE, NON_PLANIFIABLE).

        • shouldAvoidOvercover. Si este parámetro es true, la tarea no se sobrecubrirá.

        • system. Determina si la tarea ha sido creada por el sistema (true) o por el usuario (false).

        • category. Categoría de la tarea previamente configurada en Orquest.

        • product. Identificador del producto o sección.

        • id. Identificador de la tarea.

        • metadata. Cualquier dato adicional que se haya configurado previamente para la tarea en Orquest. La estructura de los metadatos debe configurarse previamente.

Resumen de asignaciones

Proporciona un resumen global del número de empleados que se requieren en franjas horarias específicas para cubrir una tarea.

Resumen de asignaciones

  • location. Nombre de la tarea.

  • locationId. Identificador externo de la tarea.

  • product. Identificador externo del producto o sección.

  • service. Identificador externo del servicio o tienda.

  • timeSlots. Franjas horarias que indican durante cuánto tiempo se necesitan los empleados en la tarea. Cada franja horaria tiene una duración de 15 minutos y contiene los siguientes campos:

    • from. Inicio de la franja horaria en UTC.

    • to. Fin de la franja horaria en UTC.

    • total. Cantidad de empleados asignados a la franja horaria.

Así, mientras que una asignación se centra en los detalles del trabajo de cada empleado en su turno, el resumen de asignaciones se enfoca en la necesidad de personal para las tareas de manera global, sin especificar quién hará qué trabajo exactamente.