put-calendar.asciidoc 957 B

12345678910111213141516171819202122232425262728293031323334353637
  1. --
  2. :api: put-calendar
  3. :request: PutCalendarRequest
  4. :response: PutCalendarResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Create calendars API
  9. Creates a new {ml} calendar.
  10. The API accepts a +{request}+ and responds
  11. with a +{response}+ object.
  12. [id="{upid}-{api}-request"]
  13. ==== Request
  14. A +{request}+ is constructed with a calendar object
  15. ["source","java",subs="attributes,callouts,macros"]
  16. --------------------------------------------------
  17. include-tagged::{doc-tests-file}[{api}-request]
  18. --------------------------------------------------
  19. <1> Create a request with the given calendar.
  20. [id="{upid}-{api}-response"]
  21. ==== Response
  22. The returned +{response}+ contains the created calendar:
  23. ["source","java",subs="attributes,callouts,macros"]
  24. --------------------------------------------------
  25. include-tagged::{doc-tests-file}[{api}-response]
  26. --------------------------------------------------
  27. <1> The created calendar.
  28. include::../execution.asciidoc[]