delete-calendar-event.asciidoc 1.2 KB

123456789101112131415161718192021222324252627282930313233343536
  1. --
  2. :api: delete-calendar-event
  3. :request: DeleteCalendarEventRequest
  4. :response: AcknowledgedResponse
  5. --
  6. [id="{upid}-{api}"]
  7. === Delete calendar event API
  8. Removes a scheduled event from an existing {ml} calendar.
  9. The API accepts a +{request}+ and responds
  10. with a +{response}+ object.
  11. [id="{upid}-{api}-request"]
  12. ==== Delete calendar event request
  13. A +{request}+ is constructed referencing a non-null
  14. calendar ID, and eventId which to remove from the calendar
  15. ["source","java",subs="attributes,callouts,macros"]
  16. --------------------------------------------------
  17. include-tagged::{doc-tests-file}[{api}-request]
  18. --------------------------------------------------
  19. <1> The ID of the calendar from which to remove the jobs
  20. <2> The eventId to remove from the calendar
  21. [id="{upid}-{api}-response"]
  22. ==== Delete calendar event response
  23. The returned +{response}+ acknowledges the success of the request:
  24. ["source","java",subs="attributes,callouts,macros"]
  25. --------------------------------------------------
  26. include-tagged::{doc-tests-file}[{api}-response]
  27. --------------------------------------------------
  28. <1> Acknowledgement of the request and its success
  29. include::../execution.asciidoc[]