OpenSearch/docs/java-rest/high-level/ml/put-calendar-job.asciidoc

37 lines
1.1 KiB
Plaintext

--
:api: put-calendar-job
:request: PutCalendarJobRequest
:response: PutCalendarResponse
--
[id="{upid}-{api}"]
=== Put Calendar Job API
Adds {ml} jobs to an existing {ml} calendar.
The API accepts a +{request}+ and responds
with a +{response}+ object.
[id="{upid}-{api}-request"]
==== Put Calendar Job Request
A +{request}+ is constructed referencing a non-null
calendar ID, and JobIDs to which to add to the calendar
["source","java",subs="attributes,callouts,macros"]
--------------------------------------------------
include-tagged::{doc-tests-file}[{api}-request]
--------------------------------------------------
<1> The ID of the calendar to which to add the jobs
<2> The JobIds to add to the calendar
[id="{upid}-{api}-response"]
==== Put 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
include::../execution.asciidoc[]