Create Schedule

Create new Schedule

A schedule is a method to program in time the extractions of shops. For example a shop can be scheduled to extract at 8am every day, or another shop can be extracted on Tuesdays only. By making a POST request to this endpoint, users can provide the necessary parameters and details in the request body to define a new schedule. This includes information such as the schedule name, date, time, and any other relevant parameters or configurations.

Mandatory Fields

• _timezone: The ID of the timezone.
• dayOfMonth: The day(s) of the month when the schedule is active. Can be a number (1-31), or * to indicate all days. Multiple days should be separated by comma (,).
• month: The month(s) when the schedule is active. Can be a number (1-12), or * to indicate all months. Multiple months should be by comma (,).
• dayOfWeek: The day(s) of the week when the schedule is active. Can be a number (0-6), where 0 is Sunday, or * to indicate all days. Multiple days should be by comma (,).
• hour: The hour(s) when the schedule is active. Can be a number (0-23), or * to indicate all hours. Multiple hours should be by comma (,).
• minute: The minute(s) when the schedule is active. Can be a number (0-59). Multiple minutes are not accepted.
• isActiveStatus: Boolean value indicating whether the schedule is active (true or false).
• startDate: The start date of the schedule (format: YYYY-MM-DD).
• endDate: The end date of the schedule (format: YYYY-MM-DD).
• scheduleName: The name of the schedule.
• _shops: The ID(s) of the shop(s) associated with the schedule, by comma (,) if multiple.

The provided data should align with the following structures retrieved from the database:

• Timezones: Active and non-deleted timezones fetched from the Timezone model.
• Shops: Active, non-deleted shops associated with the authenticated user, excluding those marked as real-time.

This format ensures all necessary parameters are covered with detailed explanations to facilitate a new shop creation via the API.