@@ -27,19 +27,25 @@ calendars by using `_all`.
27
27
`calendar_id` (required)::
28
28
(string) Identifier for the calendar.
29
29
30
- ==== Request Body
30
+ ==== Query Parameters
31
31
32
32
`end`::
33
- (string) Specifies to get events with timestamps earlier than this time.
33
+ (Optional, string) Specifies to get events with timestamps earlier than this
34
+ time.
34
35
35
36
`from`::
36
- (integer) Skips the specified number of events.
37
+ (Optional, integer) Skips the specified number of events. Defaults to `0`.
38
+
39
+ `job_id`::
40
+ (Optional, string) Specifies to get events for a specific {anomaly-job}
41
+ identifier or job group. It must be used with a calendar identifier of `_all`.
37
42
38
43
`size`::
39
- (integer) Specifies the maximum number of events to obtain.
44
+ (Optional, integer) Specifies the maximum number of events to obtain. Defaults
45
+ to `100`.
40
46
41
47
`start`::
42
- ( string) Specifies to get events with timestamps after this time.
48
+ (Optional, string) Specifies to get events with timestamps after this time.
43
49
44
50
==== Results
45
51
@@ -105,3 +111,12 @@ The API returns the following results:
105
111
// TESTRESPONSE[s/Ly8LJGEBMTCMA-qz49st/$body.$_path/]
106
112
107
113
For more information about these properties, see <<ml-event-resource>>.
114
+
115
+ The following example retrieves scheduled events that occur within a specific
116
+ period of time:
117
+
118
+ [source,console]
119
+ --------------------------------------------------
120
+ GET _xpack/ml/calendars/planned-outages/events?start=1635638400000&end=1635724800000
121
+ --------------------------------------------------
122
+ // TEST[skip:setup:calendar_outages_addevent]
0 commit comments