Add scheduled events to the calendar | Elasticsearch Serverless API

Add scheduled events to the calendar Added in 6.2.0

POST /_ml/calendars/{calendar_id}/events

Path parameters

calendar_id string Required

A string that uniquely identifies a calendar.

application/json

Body Required

events array[object] Required

A list of one of more scheduled events. The event’s start and end times can be specified as integer milliseconds since the epoch or as a string in ISO 8601 format.
Hide events attributes Show events attributes object
- calendar_id string
- event_id string
- description string Required
  
  A description of the scheduled event.
- end_time string | number Required
  
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  
  One of:
  _types:DateTime string _types:UnitMillis number
  
  Time unit for milliseconds
- start_time string | number Required
  
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  
  One of:
  _types:DateTime string _types:UnitMillis number
  
  Time unit for milliseconds
- skip_result boolean
  
  When true the model will not create results for this calendar period.
- skip_model_update boolean
  
  When true the model will not be updated for this calendar period.
- force_time_shift number
  
  Shift time by this many seconds. For example adjust time for daylight savings changes

Responses

200 application/json
Hide response attribute Show response attribute object
- events array[object] Required
  
  Hide events attributes Show events attributes object
  
  calendar_id string
  
  event_id string
  
  description string Required
  
  A description of the scheduled event.
  
  end_time string | number Required
  
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  
  One of:
  _types:DateTime string _types:UnitMillis number
  
  Time unit for milliseconds
  
  start_time string | number Required
  
  A date and time, either as a string whose format can depend on the context (defaulting to ISO 8601), or a number of milliseconds since the Epoch. Elasticsearch accepts both as input, but will generally output a string representation.
  
  One of:
  _types:DateTime string _types:UnitMillis number
  
  Time unit for milliseconds
  
  skip_result boolean
  
  When true the model will not create results for this calendar period.
  
  skip_model_update boolean
  
  When true the model will not be updated for this calendar period.
  
  force_time_shift number
  
  Shift time by this many seconds. For example adjust time for daylight savings changes

POST /_ml/calendars/{calendar_id}/events

curl \
 -X POST http://api.example.com/_ml/calendars/{calendar_id}/events \
 -H "Content-Type: application/json" \
 -d '{"events":[{"calendar_id":"string","event_id":"string","description":"string","":"string","skip_result":true,"skip_model_update":true,"force_time_shift":42.0}]}'

Add scheduled events to the calendar Added in 6.2.0

Path parameters

Body Required

end_time string | number Required

start_time string | number Required

Responses

end_time string | number Required

start_time string | number Required