2018-01-24 11:14:23 -05:00
|
|
|
[role="xpack"]
|
2018-08-31 19:49:24 -04:00
|
|
|
[testenv="platinum"]
|
2018-01-24 11:14:23 -05:00
|
|
|
[[ml-event-resource]]
|
2018-12-20 13:23:28 -05:00
|
|
|
=== Scheduled event resources
|
2018-01-24 11:14:23 -05:00
|
|
|
|
|
|
|
|
An events resource has the following properties:
|
|
|
|
|
|
|
|
|
|
`calendar_id`::
|
|
|
|
|
(string) An identifier for the calendar that contains the scheduled
|
|
|
|
|
event. This property is optional in the <<ml-post-calendar-event>>.
|
|
|
|
|
|
|
|
|
|
`description`::
|
|
|
|
|
(string) A description of the scheduled event.
|
|
|
|
|
|
|
|
|
|
`end_time`::
|
2019-03-11 10:02:50 -04:00
|
|
|
(date) The timestamp for the end of the scheduled event
|
|
|
|
|
in milliseconds since the epoch or ISO 8601 format.
|
2018-01-24 11:14:23 -05:00
|
|
|
|
|
|
|
|
`event_id`::
|
|
|
|
|
(string) An automatically-generated identifier for the scheduled event.
|
|
|
|
|
|
|
|
|
|
`start_time`::
|
2019-03-11 10:02:50 -04:00
|
|
|
(date) The timestamp for the beginning of the scheduled event
|
|
|
|
|
in milliseconds since the epoch or ISO 8601 format.
|
2018-01-24 11:14:23 -05:00
|
|
|
|
|
|
|
|
For more information, see
|
|
|
|
|
{xpack-ref}/ml-calendars.html[Calendars and Scheduled Events].
|
