ProRoster - Start an AI auto assignment of demands

API Url

Used to start the AI auto assignment of demands.

POST

http://localhost:16010/ProMarkREST/web/ProRoster/plans/{planId}/automations

Permissions: user

Path parameters

Field	Type	Description
planId	Number	The plan Id.

Query parameters

Field	Type	Description
empIds`optional`	String	Comma seperated list of employee ids. if not sent the employees of the current plans are loaded.

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
planSimulation	Object[]
from	Date	The start date of the simulation
isPrivate	Boolean	If the snapshot is private, meaning only the planner who created it will see it
name	String	The name of the simulation that will be found in the snapshots
settings	Object[]	Object used for the simulation different settings
settingName`optional`	Object	Object for a specific setting, where settingName can be: correctTeam, maxHoursDay, maxHoursWeek, maxHoursMonth, lateFridayNeverWithEarlyMonday, maxNHoursInKWeeks, workBothWeekendDays, sameTimeOfDayForConsecutiveShifts, lateShiftWithDayOffNextDayNeverWithEarlyShift, alternatingShiftTypes, hoursBetweenShift, dayOffInAWeekAfterWeekendShift, atLeastTwoContinousDaysOffAWeek If left empty, the AI engine will take care of filling those settings
firstPriorityWeight`optional`	Number	Value for first priority weight used to determin how critical the setting is
fourthPriorityWeight`optional`	Number	Value for first priority weight used to determin how critical the setting is
secondPriorityWeight`optional`	Number	Value for first priority weight used to determin how critical the setting is
thirdPriorityWeight`optional`	Number	Value for first priority weight used to determin how critical the setting is
to	Date	The end date of the simulation

Request example:

{
    "request": {
        "data": {
            "planSimulation": {
                "name": "1",
                "from": "2024-04-03",
                "to": "2024-04-10",
                "isPrivate": true,
                "settings": {
                    "correctTeam": {
                        "firstPriorityWeight": 0,
                        "fourthPriorityWeight": 0,
                        "thirdPriorityWeight": 0,
                        "secondPriorityWeight": 0
                    }
                }
            }
        }
    }
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`