PUT v1/bunits/{bunitId}/statusreportemailcontent

Update status report email content

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId ID of the business unit the email content is related to integer

Required

Body Parameters

The email content to update

StatusReportEmailContent
NameDescriptionTypeAdditional information
Inherited Gets or sets a value indicating whether this is inherited from an ancestor business unit.
boolean

None.

Introduction string

None.

OnUpdatesOnlyText string

None.

OnCompleteReportText string

None.

SupportInformation string

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:
<StatusReportEmailContent xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>6</Id>
  <CreatedDate>2024-05-20T17:42:46.2654698+02:00</CreatedDate>
  <ArchivedDate>2024-05-20T17:42:46.2654698+02:00</ArchivedDate>
  <Inherited>true</Inherited>
  <Introduction>sample string 2</Introduction>
  <OnUpdatesOnlyText>sample string 3</OnUpdatesOnlyText>
  <OnCompleteReportText>sample string 4</OnCompleteReportText>
  <SupportInformation>sample string 5</SupportInformation>
</StatusReportEmailContent>

Response Information

Resource Description

The updated email content

StatusReportDeliveryConfig
NameDescriptionTypeAdditional information
Filter NodeReportFilter

None.

OmitTotals If the status report is filtered only filtered
totals will be included in email.
boolean

None.

CreateLinks Create links for items in status report mails
boolean

None.

LinkToSubscription A link to the subscription will be added at the bottom of the mail
boolean

None.

OnlySendUpdates Send partial reports containing only the newly reported data. This is opposed to sending the full reports each time.
This is due to the nature of reporting for servers in different time zones. Status reports may be updated several times a day.
boolean

None.

OnlySendOnError Only send reports that contain errors.
boolean

None.

AlwaysSendOverview Send the report with the totals even though
no data-sources are included because of filtering
boolean

None.

DeliveryTime A time of delivery can be set. This will postpone the sending of
the report until the desired time.
time interval

None.

SendAlthoughDelivered If there is a delivery time, report will be sent even if it has been sent manually in advance
boolean

None.

Frequency How often the report should be sent
Types: On demand (undefined), Daily, Weekly, Monthly
Frequency

None.

FrequencyDetails A list of days if FrequencyType is weekly or monthly
if frequency is weekly valid options are 0 to 6 where 0 represents sunday and 6 represents saturday
if frequency is monthly valid options are 1 to 31 where values n represents last day of the month if no more than n days are in the month
Collection of integer

None.

InlineOverview Inline the status report overview in the email itself.
boolean

None.

InlineServerInfo Inline information about which servers that backup nodes in this report are related to.
boolean

None.

InlineNodes Inline the backup node reports in the email itself.
boolean

None.

InlineWarnings Inline the warnings of the backup node reports
boolean

None.

InlineEvents Inline the events of the backup node reports
boolean

None.

InlineActivities Inline the activities of the backup node reports
boolean

None.

InlineActivityLogs Inline the activitylogs of the backup node reports
boolean

None.

InlineVmBackups Inline the activitylogs of the backup node reports
boolean

None.

AttachOverview Include status report summary overview in the selected attachment formats.
boolean

None.

AttachNodes Include backup node reports in the selected attachment formats.
boolean

None.

AttachWarnings Include backup node warnings on in the selected attachment formats.
boolean

None.

AttachEvents Include scheduled events in the selected attachment formats.
boolean

None.

AttachActivities Include unscheduled activities in the selected attachment formats.
boolean

None.

AttachActivityLogs Include activity logs in the selected attachment formats.
boolean

None.

AttachVmBackups Include activity logs in the selected attachment formats.
boolean

None.

LimitToErrorCausingEvents Limit the list of scheduled events to only include events
causing the backup node to have status "Error"
boolean

None.

LimitToErrorCausingWarnings Limit the list of warnings to only include warnings
causing the backup node to have status "Error"
boolean

None.

EmailCsv Attach a CSV-file with the requested data.
boolean

None.

EmailJson Attach a JSON-file with the requested data.
boolean

None.

EmailPdf Attach a PDF-file with the requested data.
boolean

None.

EmailExcel Attach an Excel-file with the requested data.
boolean

None.

GroupByBusinessUnit boolean

None.

GroupByFileserverWorkstations boolean

None.

GroupByFileserverWorkstationsReplicationState boolean

None.

GroupByApplicationServers boolean

None.

GroupByApplicationServersReplicationState boolean

None.

GroupBySpForVe boolean

None.

GroupBySpForVeReplicationState boolean

None.

GroupByOperatingSystem boolean

None.

GroupByVmFilespaces boolean

None.

GroupByHypervisors boolean

None.

GroupByVms boolean

None.

GroupByMicrosoft365Tenants boolean

None.

GroupByMicrosoft365Accounts boolean

None.

GroupByRubrikHypervisors boolean

None.

GroupByRubrikVms boolean

None.

GroupByRubrikNutanixClusters boolean

None.

GroupByRubrikNutanixVms boolean

None.

GroupByRubrikWindowsHosts boolean

None.

GroupByRubrikLinuxHosts boolean

None.

GroupByRubrikOtherHosts boolean

None.

GroupByRubrikMsSqlDatabases boolean

None.

GroupByRubrikOracleDatabases boolean

None.

DataViewConfigs Collection of DataViewConfig

None.

Inherited Gets or sets a value indicating whether this is inherited from an ancestor business unit.
boolean

None.

DecimalMark string

None.

DateFormat string

None.

TimeFormat string

None.

DateTimeFormat string

None.

CsvDelimiter string

None.

Id A unique ID for the object.
integer

Read-only.

CreatedDate Time and date the object was created.
date

Read-only.

ArchivedDate Time and date the object was or is going to be archived.

Unarchived objects have no value in ArchivedDate
date

Read-only.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

application/xml, text/xml

Sample:
<StatusReportDeliveryConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>56</Id>
  <CreatedDate>2024-05-20T17:42:46.2654698+02:00</CreatedDate>
  <ArchivedDate>2024-05-20T17:42:46.2654698+02:00</ArchivedDate>
  <Filter>
    <Id>56</Id>
    <CreatedDate>2024-05-20T17:42:46.2654698+02:00</CreatedDate>
    <ArchivedDate>2024-05-20T17:42:46.2654698+02:00</ArchivedDate>
    <ConcatenateOkAndOkWithWarnings>true</ConcatenateOkAndOkWithWarnings>
    <StatusOk>true</StatusOk>
    <StatusOkWithWarnings>true</StatusOkWithWarnings>
    <StatusWarning>true</StatusWarning>
    <StatusError>true</StatusError>
    <StatusIgnored>true</StatusIgnored>
    <StatusPending>true</StatusPending>
    <SupportStatusActive>true</SupportStatusActive>
    <SupportStatusResolved>true</SupportStatusResolved>
    <SupportStatusIgnored>true</SupportStatusIgnored>
    <TypeFileServer>true</TypeFileServer>
    <TypeWorkstation>true</TypeWorkstation>
    <TypeApplicationServer>true</TypeApplicationServer>
    <ReplicationModeNone>true</ReplicationModeNone>
    <ReplicationModeSource>true</ReplicationModeSource>
    <ReplicationModeTarget>true</ReplicationModeTarget>
    <IncludeNodes>true</IncludeNodes>
    <IncludeVmFilespaces>true</IncludeVmFilespaces>
    <IncludeHypervisors>true</IncludeHypervisors>
    <IncludeVms>true</IncludeVms>
    <IncludeMicrosoft365Tenants>true</IncludeMicrosoft365Tenants>
    <IncludeMicrosoft365Accounts>true</IncludeMicrosoft365Accounts>
    <IncludeRubrikHypervisors>true</IncludeRubrikHypervisors>
    <IncludeRubrikVms>true</IncludeRubrikVms>
    <IncludeRubrikNutanixClusters>true</IncludeRubrikNutanixClusters>
    <IncludeRubrikNutanixVms>true</IncludeRubrikNutanixVms>
    <IncludeRubrikWindowsHosts>true</IncludeRubrikWindowsHosts>
    <IncludeRubrikLinuxHosts>true</IncludeRubrikLinuxHosts>
    <IncludeRubrikOtherHosts>true</IncludeRubrikOtherHosts>
    <IncludeRubrikMsSqlDatabases>true</IncludeRubrikMsSqlDatabases>
    <IncludeRubrikOracleDatabases>true</IncludeRubrikOracleDatabases>
    <PendingTermination>true</PendingTermination>
    <BillingEndDate>true</BillingEndDate>
    <Active>true</Active>
    <Decommissioned>true</Decommissioned>
    <Unaccessed>true</Unaccessed>
    <NotFound>true</NotFound>
    <HasStorage>true</HasStorage>
    <NoStorage>true</NoStorage>
    <Internal>true</Internal>
    <Resale>true</Resale>
    <Monday>true</Monday>
    <Tuesday>true</Tuesday>
    <Wednesday>true</Wednesday>
    <Thursday>true</Thursday>
    <Friday>true</Friday>
    <Saturday>true</Saturday>
    <Sunday>true</Sunday>
    <NoPlannedProtection>true</NoPlannedProtection>
    <CommentNone>true</CommentNone>
    <CommentOpen>true</CommentOpen>
    <CommentClosed>true</CommentClosed>
    <CommentIgnored>true</CommentIgnored>
    <Tags>
      <Tag>
        <Id>1</Id>
        <BusinessUnitId>2</BusinessUnitId>
        <Text>sample string 3</Text>
        <Inheritable>true</Inheritable>
        <BusinessUnitCount>5</BusinessUnitCount>
        <ConsumerCount>6</ConsumerCount>
      </Tag>
      <Tag>
        <Id>1</Id>
        <BusinessUnitId>2</BusinessUnitId>
        <Text>sample string 3</Text>
        <Inheritable>true</Inheritable>
        <BusinessUnitCount>5</BusinessUnitCount>
        <ConsumerCount>6</ConsumerCount>
      </Tag>
    </Tags>
    <ExcludeTags>true</ExcludeTags>
    <EditDate>2024-05-20T17:42:46.2654698+02:00</EditDate>
  </Filter>
  <OmitTotals>true</OmitTotals>
  <CreateLinks>true</CreateLinks>
  <LinkToSubscription>true</LinkToSubscription>
  <OnlySendUpdates>true</OnlySendUpdates>
  <OnlySendOnError>true</OnlySendOnError>
  <AlwaysSendOverview>true</AlwaysSendOverview>
  <DeliveryTime />
  <SendAlthoughDelivered>true</SendAlthoughDelivered>
  <Frequency>Daily</Frequency>
  <FrequencyDetails>
    <int>1</int>
    <int>2</int>
  </FrequencyDetails>
  <InlineOverview>true</InlineOverview>
  <InlineServerInfo>true</InlineServerInfo>
  <InlineNodes>true</InlineNodes>
  <InlineWarnings>true</InlineWarnings>
  <InlineEvents>true</InlineEvents>
  <InlineActivities>true</InlineActivities>
  <InlineActivityLogs>true</InlineActivityLogs>
  <InlineVmBackups>true</InlineVmBackups>
  <AttachOverview>true</AttachOverview>
  <AttachNodes>true</AttachNodes>
  <AttachWarnings>true</AttachWarnings>
  <AttachEvents>true</AttachEvents>
  <AttachActivities>true</AttachActivities>
  <AttachActivityLogs>true</AttachActivityLogs>
  <AttachVmBackups>true</AttachVmBackups>
  <LimitToErrorCausingEvents>true</LimitToErrorCausingEvents>
  <LimitToErrorCausingWarnings>true</LimitToErrorCausingWarnings>
  <EmailCsv>true</EmailCsv>
  <EmailJson>true</EmailJson>
  <EmailPdf>true</EmailPdf>
  <EmailExcel>true</EmailExcel>
  <GroupByBusinessUnit>true</GroupByBusinessUnit>
  <GroupByFileserverWorkstations>true</GroupByFileserverWorkstations>
  <GroupByFileserverWorkstationsReplicationState>true</GroupByFileserverWorkstationsReplicationState>
  <GroupByApplicationServers>true</GroupByApplicationServers>
  <GroupByApplicationServersReplicationState>true</GroupByApplicationServersReplicationState>
  <GroupBySpForVe>true</GroupBySpForVe>
  <GroupBySpForVeReplicationState>true</GroupBySpForVeReplicationState>
  <GroupByOperatingSystem>true</GroupByOperatingSystem>
  <GroupByVmFilespaces>true</GroupByVmFilespaces>
  <GroupByHypervisors>true</GroupByHypervisors>
  <GroupByVms>true</GroupByVms>
  <GroupByMicrosoft365Tenants>true</GroupByMicrosoft365Tenants>
  <GroupByMicrosoft365Accounts>true</GroupByMicrosoft365Accounts>
  <GroupByRubrikHypervisors>true</GroupByRubrikHypervisors>
  <GroupByRubrikVms>true</GroupByRubrikVms>
  <GroupByRubrikNutanixClusters>true</GroupByRubrikNutanixClusters>
  <GroupByRubrikNutanixVms>true</GroupByRubrikNutanixVms>
  <GroupByRubrikWindowsHosts>true</GroupByRubrikWindowsHosts>
  <GroupByRubrikLinuxHosts>true</GroupByRubrikLinuxHosts>
  <GroupByRubrikOtherHosts>true</GroupByRubrikOtherHosts>
  <GroupByRubrikMsSqlDatabases>true</GroupByRubrikMsSqlDatabases>
  <GroupByRubrikOracleDatabases>true</GroupByRubrikOracleDatabases>
  <DataViewConfigs>
    <DataViewConfig>
      <Id>2</Id>
      <CreatedDate>2024-05-20T17:42:46.2654698+02:00</CreatedDate>
      <ArchivedDate>2024-05-20T17:42:46.2654698+02:00</ArchivedDate>
      <Properties>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Properties>
      <SortOrder>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </SortOrder>
      <DataView>
        <Id>2</Id>
        <CreatedDate>2024-05-20T17:42:46.2654698+02:00</CreatedDate>
        <ArchivedDate>2024-05-20T17:42:46.2654698+02:00</ArchivedDate>
        <Name>sample string 1</Name>
        <Type>
          <Id>2</Id>
          <CreatedDate>2024-05-20T17:42:46.2654698+02:00</CreatedDate>
          <ArchivedDate>2024-05-20T17:42:46.2654698+02:00</ArchivedDate>
          <Name>sample string 1</Name>
        </Type>
      </DataView>
      <Inherited>true</Inherited>
    </DataViewConfig>
    <DataViewConfig>
      <Id>2</Id>
      <CreatedDate>2024-05-20T17:42:46.2654698+02:00</CreatedDate>
      <ArchivedDate>2024-05-20T17:42:46.2654698+02:00</ArchivedDate>
      <Properties>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Properties>
      <SortOrder>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </SortOrder>
      <DataView>
        <Id>2</Id>
        <CreatedDate>2024-05-20T17:42:46.2654698+02:00</CreatedDate>
        <ArchivedDate>2024-05-20T17:42:46.2654698+02:00</ArchivedDate>
        <Name>sample string 1</Name>
        <Type>
          <Id>2</Id>
          <CreatedDate>2024-05-20T17:42:46.2654698+02:00</CreatedDate>
          <ArchivedDate>2024-05-20T17:42:46.2654698+02:00</ArchivedDate>
          <Name>sample string 1</Name>
        </Type>
      </DataView>
      <Inherited>true</Inherited>
    </DataViewConfig>
  </DataViewConfigs>
  <Inherited>true</Inherited>
  <DecimalMark>sample string 52</DecimalMark>
  <DateFormat>sample string 53</DateFormat>
  <TimeFormat>sample string 54</TimeFormat>
  <CsvDelimiter>sample string 55</CsvDelimiter>
</StatusReportDeliveryConfig>