Create Monitor
POST/api/EntityEventSchedules/CreateMonitor
Tier: Public — stable, supported for third-party integration.
Creates the (single allowed) monitor for a schedule. On success this registers a
Hangfire recurring job (id = the created monitor's id, cron =
AddEventScheduleMonitorDto.CronExpression, timezone = the schedule's
timezone) that periodically evaluates the schedule's compliance.
Request
Responses
- 200
- 400
The created monitor. See Monitor.EventScheduleMonitorDetailDto.
AddEventScheduleMonitorDto.CronExpression missing (MissingRequiredField);
AddEventScheduleMonitorDto.EventScheduleId does not reference an existing schedule (InvalidReference, message "Event Schedule");
the schedule already has a monitor (DuplicateResource, message "Event Schedule");
or a post-insert failure occurred, e.g. an unresolvable timezone (OperationFailed — note the monitor row may already be committed in this case).