Summary
The RestScheduleImportExt creates SpecialEvents in a schedule by reading from an API. It will create only the current or future events in the schedule.
Implementation
- Add a RestScheduleImportExt in a schedule
- Configure its properties
Properties
- HttpConfig : To configure the Http (Get) request to get data about SpecialEvents. See Http Config
- ScheduleId: If used with the discover of RestScheduleDeviceExt, will contain the id to identify the schedule. Will be empty otherwise
- EventSelector: To select the part of the json that represents an event. It can be an array or an object. This is a JSON Key Selector based on the Http response
- EventNameSelector: To select the name of the event to create. It should be a String. This is a JSON Key Selector based on the json part selected by the EventSelector
- StartDateSelector: To select the start date of the event. It should be a String encoded. The encoding format has to be precised in DateFormat. This is a JSON Key Selector based on the json part selected by the EventSelector
- EndDateSelector: To select the end date of the event. Works the same way than StartDateSelector.
- DateFormat: To define the encoding used for start and end dates. Will be used to convert them in AbsTimes.
- DateTimeZone: To define the timezone given by the API (usually UTC)
- TagsSelector: To define which tags to create for each booking based on the returned JSON. It's useful when we want to display the attendees for example.
Actions
- Execute: To execute the import of SpecialEvents.