12345678910111213141516171819202122232425262728293031323334353637 |
- --
- :api: delete-calendar-job
- :request: DeleteCalendarJobRequest
- :response: PutCalendarResponse
- --
- [role="xpack"]
- [id="{upid}-{api}"]
- === Delete {anomaly-jobs} from calendar API
- Removes {anomaly-jobs} from an existing {ml} calendar.
- The API accepts a +{request}+ and responds
- with a +{response}+ object.
- [id="{upid}-{api}-request"]
- ==== Delete {anomaly-jobs} from calendar request
- A +{request}+ is constructed referencing a non-null
- calendar ID, and JobIDs 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 JobIds to remove from the calendar
- [id="{upid}-{api}-response"]
- ==== Delete {anomaly-jobs} from calendar response
- The returned +{response}+ contains the updated Calendar:
- ["source","java",subs="attributes,callouts,macros"]
- --------------------------------------------------
- include-tagged::{doc-tests-file}[{api}-response]
- --------------------------------------------------
- <1> The updated calendar with the jobs removed
- include::../execution.asciidoc[]
|