2018-11-21 17:22:04 -05:00
|
|
|
--
|
|
|
|
|
:api: delete-calendar-event
|
|
|
|
|
:request: DeleteCalendarEventRequest
|
|
|
|
|
:response: AcknowledgedResponse
|
|
|
|
|
--
|
2019-09-10 11:26:56 -04:00
|
|
|
[role="xpack"]
|
2018-11-21 17:22:04 -05:00
|
|
|
[id="{upid}-{api}"]
|
2019-07-25 14:20:42 -04:00
|
|
|
=== Delete calendar event API
|
2018-11-21 17:22:04 -05:00
|
|
|
Removes a scheduled event from an existing {ml} calendar.
|
|
|
|
|
The API accepts a +{request}+ and responds
|
|
|
|
|
with a +{response}+ object.
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
2019-07-25 14:20:42 -04:00
|
|
|
==== Delete calendar event request
|
2018-11-21 17:22:04 -05:00
|
|
|
|
|
|
|
|
A +{request}+ is constructed referencing a non-null
|
|
|
|
|
calendar ID, and eventId which to remove from the calendar
|
|
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
<1> The ID of the calendar from which to remove the jobs
|
|
|
|
|
<2> The eventId to remove from the calendar
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
2019-07-25 14:20:42 -04:00
|
|
|
==== Delete calendar event response
|
2018-11-21 17:22:04 -05:00
|
|
|
|
|
|
|
|
The returned +{response}+ acknowledges the success of the request:
|
|
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
<1> Acknowledgement of the request and its success
|
|
|
|
|
|
|
|
|
|
include::../execution.asciidoc[]
|
