Sign in

v1

latestOpenAPI 3.0.12026-07-244011,5573.5 MB
Report Schedules

Update a report runner

Applies a partial update to the supplied report runner. Only the fields present in the body are changed; omitted fields are left intact. Returns the persisted report runner after the update. Returns 404 report_runner_not_found if the id does not exist. Locked runners (report_runner_locked) must be updated via deployment tooling.

put/v7/report-runners/{reportRunnerId}

Path parameters

reportRunnerIdstring required

The Extole unique report runner identifier.

Request body

OR

Example request

{
  "report_name_pattern": "handlebars@runtime:{{reportNamePattern}}",
  "sftp_report_name_pattern": "handlebars@runtime:{{sftpReportNamePattern}}"
}

Response

Updated report runner.

OR

Example response

{
  "created_date": "2025-10-24T02:00:00-07:00",
  "pause_info": {
    "updated_date": "2025-10-24T09:00:00.000Z"
  },
  "paused": {
    "updated_date": "2025-10-24T09:00:00.000Z"
  },
  "report_name_pattern": "handlebars@runtime:{{reportNamePattern}}",
  "sftp_report_name_pattern": "handlebars@runtime:{{sftpReportNamePattern}}",
  "updated_date": "2025-10-24T02:00:00-07:00"
}