Model input

The modelInput is where you add your data about available employees and the shifts to be scheduled and optimized.

The JSON shows an example modelInput. Note, most of the values are missing.

{
  "modelInput": {
    "tagTypes": [
      {
        "id": "tagTypeName"
      }
    ],
    "tags": [
      {
        "id": "tagName"
      }
    ],
    "contracts": [
      {
        "id": "string"
      }
    ],
    "employees": [
      {
        "id": "Ann"
      }
    ],
    "shifts": [
      {
        "id": "string"
      }
    ],
    "shiftGroups": [
      {
        "id": "string"
      }
    ],
    "employeeCostGroups": [
      {
        "id": "string"
      }
    ],
    "scheduleParameterization": {
      "weekStart": "MONDAY"
    },
    "globalRules": {
    },
    "planningWindow": {
      "start": "2024-02-05T00:00+01:00",
      "end": "2024-02-12T:00:00+01:00"
    }
  }
}

  • tagTypes and tags provide additional information about employees and shifts. See Tags and tag types, Shift travel and locations, Shift tag types, and Unique tags per period for specific examples.

  • contracts includes information about employees contracts and rules related to the hours employees work. See Employee contracts and Work limits for more details.

  • employees include information about employees, their availability, and skills. See Employee resource constraints for more details.

  • shifts includes information about the shifts to be assigned to employees. See Shift service constraints for more details.

  • shiftGroups includes information about alternative shifts in a group where only one or more of the shifts need to be assigned. see Alternative shifts for more details.

  • employeeCostGroups defines employee activation costs to help manage costs. see Employee activation for more details.

  • scheduleParameterization lets you define the first day of the week. See Work limits and Time off for more details.

  • globalRules define rules that apply to the entire schedule.

  • planningWindow is the period of time the schedule is being planned for. See Planning window for more details.

Next