OpenSearch/docs/reference/ml/apis/calendarresource.asciidoc

[role="xpack"]
[testenv="platinum"]
[[ml-calendar-resource]]
=== Calendar resources

A calendar resource has the following properties:

`calendar_id`::
  (string) A numerical character string that uniquely identifies the calendar.

`job_ids`::
  (array) An array of job identifiers. For example: `["total-requests"]`.

For more information, see 
{xpack-ref}/ml-calendars.html[Calendars and Scheduled Events].
[DOCS] Added ML add and delete calendar event APIs (elastic/x-pack-elasticsearch#3394) Original commit: elastic/x-pack-elasticsearch@3283af2215630ce7997037fc472a829ae585042e 2018-01-24 08:14:23 -08:00			`[role="xpack"]`
[DOCS] Moves machine learning APIs to docs folder (#31118) 2018-08-31 16:49:24 -07:00			`[testenv="platinum"]`
[DOCS] Added ML add and delete calendar event APIs (elastic/x-pack-elasticsearch#3394) Original commit: elastic/x-pack-elasticsearch@3283af2215630ce7997037fc472a829ae585042e 2018-01-24 08:14:23 -08:00			`[[ml-calendar-resource]]`
[DOCS] Synchs titles of X-Pack APIs 2018-12-20 10:23:28 -08:00			`=== Calendar resources`
[DOCS] Added ML add and delete calendar event APIs (elastic/x-pack-elasticsearch#3394) Original commit: elastic/x-pack-elasticsearch@3283af2215630ce7997037fc472a829ae585042e 2018-01-24 08:14:23 -08:00
			`A calendar resource has the following properties:`

			`calendar_id`::
			`(string) A numerical character string that uniquely identifies the calendar.`

			`job_ids`::
			(array) An array of job identifiers. For example: `["total-requests"]`.

			`For more information, see`
			`{xpack-ref}/ml-calendars.html[Calendars and Scheduled Events].`