2018-11-20 09:15:21 -05:00
|
|
|
--
|
|
|
|
|
:api: post-calendar-event
|
|
|
|
|
:request: PostCalendarEventRequest
|
|
|
|
|
:response: PostCalendarEventResponse
|
|
|
|
|
--
|
2019-09-10 11:26:56 -04:00
|
|
|
[role="xpack"]
|
2018-11-20 09:15:21 -05:00
|
|
|
[id="{upid}-{api}"]
|
2020-10-02 17:01:01 -04:00
|
|
|
=== Post calendar events API
|
|
|
|
|
|
2018-11-20 09:15:21 -05:00
|
|
|
Adds new ScheduledEvents to an existing {ml} calendar.
|
|
|
|
|
|
|
|
|
|
The API accepts a +{request}+ and responds
|
|
|
|
|
with a +{response}+ object.
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-request"]
|
2020-10-02 17:01:01 -04:00
|
|
|
==== Post calendar events request
|
2018-11-20 09:15:21 -05:00
|
|
|
|
|
|
|
|
A +{request}+ is constructed with a calendar ID object
|
|
|
|
|
and a non-empty list of scheduled events.
|
|
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
<1> Non-null existing calendar ID
|
|
|
|
|
<2> Non-null, non-empty collection of `ScheduledEvent` objects
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[id="{upid}-{api}-response"]
|
2020-10-02 17:01:01 -04:00
|
|
|
==== Post calendar events response
|
2018-11-20 09:15:21 -05:00
|
|
|
|
|
|
|
|
The returned +{response}+ contains the added `ScheduledEvent` objects:
|
|
|
|
|
|
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
|
|
|
--------------------------------------------------
|
|
|
|
|
<1> The `ScheduledEvent` objects that were added to the calendar
|
|
|
|
|
|
|
|
|
|
include::../execution.asciidoc[]
|
