Consultar catálogo de restricciones

Este endpoint devuelve el catálogo de restricciones disponible en el negocio.

GET /api/v2/businesses/{businessId}/constraints/catalog

Si los datos incluidos en la petición son correctos —businessId—, la respuesta contendrá la información definida para cada restricción incluyendo el identificador y el esquema de parámetros.

Ejemplo de respuesta

[
    {
        "parameters_schema": {
            "weekDays": {
                "type": "WEEK_ISO_DAYS",
                "optional": false
            }
        },
        "id": "constraint.days_off_after_free_weekend"
    },
    {
        "parameters_schema": {
            "min": {
                "type": "TIME",
                "defaultValue": 9720.0,
                "optional": true
            },
            "max": {
                "type": "TIME",
                "defaultValue": 12000.0,
                "optional": false
            }
        },
        "id": "constraint.monthly_net_hours_limit"
    }
]
Detalles

  • parameters_schema. Mapa de parámetros configurables de la restricción, donde cada clave es el nombre del parámetro.

    • <nombre del parámetro>. Nombre identificativo del parámetro dentro de la restricción (por ejemplo, weekDays, min, max, etc.).

      • type. Tipo de dato del parámetro: BOOLEAN, DATE, DECIMAL, INTEGER, LOCATION, PERCENTAGE, STRING, TIME, TIME_SLOTS, WEEK_ISO_DAYS, etc.

      • defaultValue. Valor por defecto del parámetro. Solo está presente cuando el parámetro tiene un valor predefinido en el sistema.

      • optional. Indica si el parámetro es opcional (true) o requerido (false) al configurar la restricción.

  • id. Identificador único de la restricción en el sistema.

El ejemplo muestra dos restricciones del catálogo:

  • constraint.days_off_after_free_weekend (días libres tras un fin de semana libre). Requiere un único parámetro, weekDays, de tipo WEEK_ISO_DAYS, que es obligatorio.

  • constraint.monthly_net_hours_limit (límite mensual de horas netas). Acepta dos parámetros de tipo TIME: mínimo opcional y máximo obligatorio, ambos con valor por defecto.

Aspectos que tener en cuenta

La respuesta incluye todas las restricciones definidas en el sistema que pueden ser aplicadas a los empleados del negocio.

Los parámetros de cada restricción varían según su configuración.

Enlaces de interés

¿Qué es una restricción?