elasticsearch/docs/java-rest/high-level/ml/delete-calendar-event.asciidoc

--
:api: delete-calendar-event
:request: DeleteCalendarEventRequest
:response: AcknowledgedResponse
--
[role="xpack"]
[id="{upid}-{api}"]
=== Delete calendar events API

Removes a scheduled event from an existing {ml} calendar.
The API accepts a +{request}+ and responds
with a +{response}+ object.

[id="{upid}-{api}-request"]
==== Delete calendar events request

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"]
====  Delete calendar events response

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[]