Class ReportSchedulePatchRequestAttributes

The updated configuration of the report schedule. These values replace the existing ones; the targeted resource (resource_id and resource_type) cannot be changed.

Hierarchy

  • ReportSchedulePatchRequestAttributes

Constructors

constructor

Properties

additionalProperties? deliveryFormat? description recipients rrule tabId? templateVariables timeframe timezone title

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional deliveryFormat

deliveryFormat?: ReportScheduleDeliveryFormat

How a PDF-export report is delivered. pdf attaches a PDF file, png embeds an inline PNG image, and pdf_and_png delivers both.

description

description: string

A description of the report, up to 4096 characters.

recipients

recipients: string[]

The recipients of the report. Each entry is an email address, a Slack channel reference in the form slack:{team_id}.{channel_id}.{channel_name}, or a Microsoft Teams channel reference in the form teams:{tenant_id}|{team_id}|{channel_id}.

rrule

rrule: string

The recurrence rule for the schedule, expressed as an iCalendar RRULE string.

Optional tabId

tabId?: string

The identifier of the dashboard tab to render, when the dashboard has tabs.

templateVariables

templateVariables: ReportScheduleTemplateVariable[]

The dashboard template variables applied when rendering the report.

timeframe

timeframe: string

The relative timeframe of data to include in the report.

timezone

timezone: string

The IANA time zone identifier the recurrence rule is evaluated in.

title

title: string

The title of the report, between 1 and 78 characters.

Settings

Member Visibility

Theme

Generated using TypeDoc