rest-api-spec.api.ml.get_calendar_events.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

Elasticsearch subproject :rest-api-spec

There is a newer version: 8.17.0

{
  "ml.get_calendar_events":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html",
      "description":"Retrieves information about the scheduled events in calendars."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"]
    },
    "url":{
      "paths":[
        {
          "path":"/_ml/calendars/{calendar_id}/events",
          "methods":[
            "GET"
          ],
          "parts":{
            "calendar_id":{
              "type":"string",
              "description":"The ID of the calendar containing the events"
            }
          }
        }
      ]
    },
    "params":{
      "job_id":{
        "type":"string",
        "description":"Get events for the job. When this option is used calendar_id must be '_all'"
      },
      "start":{
        "type":"string",
        "description":"Get events after this time"
      },
      "end":{
        "type":"date",
        "description":"Get events before this time"
      },
      "from":{
        "type":"int",
        "description":"Skips a number of events"
      },
      "size":{
        "type":"int",
        "description":"Specifies a max number of events to get"
      }
    }
  }
}