v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Report

ReportSchedules.update

Modifies ReportSchedule or ReportSchedules with given id(s)

patch/entities/ReportSchedules/{id}

Path parameters

idstring uuid required

ID of ReportSchedule to update

Query parameters

validation-levelinteger

Specify validation level of ReportSchedule on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

owner_idstring uuid

Id of the owning user.

report_idstring uuid

Id of the scheduled report.

settingsobject

Schedule configuration: cadence, timezone, recipients, email body and report attachment options. Stored as a JSON document.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "owner_id": "01234567-abcd-dcba-ffff-000000000000",
  "report_id": "01234567-abcd-dcba-ffff-000000000000",
  "revision": 1
}

Response

Modification confirmation. Returns resulting ReportSchedule

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "report_id": "01234567-abcd-dcba-ffff-000000000000",
    "revision": 1,
    "sender_email": "string",
    "report_name": "string",
    "report_owner_id": "01234567-abcd-dcba-ffff-000000000000"
  }
}