delete-calendar-job.asciidoc 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. --
  2. :api: delete-calendar-job
  3. :request: DeleteCalendarJobRequest
  4. :response: PutCalendarResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Delete {anomaly-jobs} from calendar API
  9. Removes {anomaly-jobs} from an existing {ml} calendar.
  10. The API accepts a +{request}+ and responds
  11. with a +{response}+ object.
  12. [id="{upid}-{api}-request"]
  13. ==== Delete {anomaly-jobs} from calendar request
  14. A +{request}+ is constructed referencing a non-null
  15. calendar ID, and JobIDs which to remove from the calendar
  16. ["source","java",subs="attributes,callouts,macros"]
  17. --------------------------------------------------
  18. include-tagged::{doc-tests-file}[{api}-request]
  19. --------------------------------------------------
  20. <1> The ID of the calendar from which to remove the jobs
  21. <2> The JobIds to remove from the calendar
  22. [id="{upid}-{api}-response"]
  23. ==== Delete {anomaly-jobs} from calendar response
  24. The returned +{response}+ contains the updated Calendar:
  25. ["source","java",subs="attributes,callouts,macros"]
  26. --------------------------------------------------
  27. include-tagged::{doc-tests-file}[{api}-response]
  28. --------------------------------------------------
  29. <1> The updated calendar with the jobs removed
  30. include::../execution.asciidoc[]