History Service API

[Jeremydupras]

Description

This API provides a way to get the information within the Job History Index.

API calls
GET /_plugins/_job_scheduler/api/history

With
GET /_plugins/_job_scheduler/api/history/.scheduler_sample_extension-jobid1

GET /_plugins/_job_scheduler/api/history/

The history ID is the "index_id"-"jobid"

Example API response

{
  "total_history": 2,
  "history": {
    ".scheduler_sample_extension-jobid1-1755727454": {
      "job_index_name": ".scheduler_sample_extension",
      "job_id": "jobid1",
      "start_time": 1755727454,
      "completion_status": 0,
      "end_time": 1755727454
    },
    ".scheduler_sample_extension-jobid1-1755727514": {
      "job_index_name": ".scheduler_sample_extension",
      "job_id": "jobid1",
      "start_time": 1755727514,
      "completion_status": 0,
      "end_time": 1755727514
    }
  }
}

Related Issues

Resolves #808

Check List

• New functionality includes testing.
• New functionality has been documented.
• API changes companion pull request created.
• Commits are signed per the DCO using --signoff.
• Public documentation issue/PR created.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.