PUT v1/bunits/{bunitId}/jobdeliveryconfig

Update a job delivery config

Request Information

URI Parameters

Name	Description	Type	Additional information
`bunitId`	ID of the business unit the config is related to	integer	Required

Body Parameters

The config to update

JobDeliveryConfig

Name	Description	Type	Additional information
`GroupByConsumer`	When true all jobs would be estimated by highest severity and sent as one line	boolean	None.
`DeliveryTime`	Time of day the subscription is sent	time interval	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.
`InlineHtml`	Include the requested data as html in body of mail	boolean	None.
`AttachCsv`	Attach a CSV-file with the requested data.	boolean	None.
`CsvDelimiter`		string	None.
`AttachJson`	Attach a JSON-file with the requested data.	boolean	None.
`AttachPdf`	Attach a PDF-file with the requested data.	boolean	None.
`AttachExcel`	Attach an Excel-file with the requested data.	boolean	None.
`DataViewConfig`	A config describing what content to include and how to sort it	DataViewConfig	None.
`IncludeSeverityOk`		boolean	None.
`IncludeSeverityWarning`		boolean	None.
`IncludeSeverityError`		boolean	None.
`DecimalMark`	Decimal mark to use in content Can be "." or ","	string	None.
`DateFormat`	Date format used in content	string	None.
`DateFormatInitialized`	Date format that cannot be null as default date format will be used	string	None.
`TimeFormat`	Time format used in content	string	None.
`TimeFormatInitialized`	Time format that cannot be null as default time format will be used	string	None.
`DateTimeFormat`	The user's preferred date and time format combined Read only	string	None.
`DateAtTimeFormat`	The user's preferred date and time format combined with an @ for easy readability Read only	string	None.
`Inherited`	Gets or sets a value indicating whether this is inherited from an ancestor business unit.	boolean	None.
`StartTime`	Earliest completed time If none given current date minus 24 hours is used	date	None.
`IncludeActive`		boolean	None.
`IncludeUnaccessed`		boolean	None.
`IncludeDecommissioned`		boolean	None.
`IncludeNotFound`		boolean	None.
`IncludeScheduled`		boolean	None.
`IncludeUnscheduled`		boolean	None.
`IncludeSupportActive`		boolean	None.
`IncludeSupportResolved`		boolean	None.
`IncludeSupportIgnored`		boolean	None.
`EndTime`	Latest completed time Nullable	date	None.
`IncludeCompleted`	Include jobs with a completed time	boolean	None.
`IncludeUncompleted`	Include jobs with no completed time These should have status Started, In Progress or Expired	boolean	None.
`IncludeDescendants`	If false, only jobs for current business unit will be returned. If true, jobs for all descendants will included	boolean	None.
`JobTypes`	Types of jobs	Collection of JobType	None.
`Statuses`	Statuses of jobs	Collection of JobStatus	None.
`Severities`	Severities of jobs	Collection of JobSeverity	None.
`DataSourceTypes`	Data-source type of jobs	Collection of DataSourceType	None.
`ServerTypes`	Servertypes of jobs	Collection of ServerType	None.
`JobNames`	Names of jobs	Collection of JobName	None.
`Tags`	A list of tags the data-sources must or must not have	Collection of Tag	None.
`ExcludeTags`	True if data-sources with tags should be excluded	boolean	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:

<JobDeliveryConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>30</Id>
  <CreatedDate>2024-09-14T11:46:13.0523961+02:00</CreatedDate>
  <ArchivedDate>2024-09-14T11:46:13.0523961+02:00</ArchivedDate>
  <StartTime>2024-09-14T11:46:13.0523961+02:00</StartTime>
  <IncludeActive>true</IncludeActive>
  <IncludeUnaccessed>true</IncludeUnaccessed>
  <IncludeDecommissioned>true</IncludeDecommissioned>
  <IncludeNotFound>true</IncludeNotFound>
  <IncludeScheduled>true</IncludeScheduled>
  <IncludeUnscheduled>true</IncludeUnscheduled>
  <IncludeSupportActive>true</IncludeSupportActive>
  <IncludeSupportResolved>true</IncludeSupportResolved>
  <IncludeSupportIgnored>true</IncludeSupportIgnored>
  <EndTime>2024-09-14T11:46:13.0523961+02:00</EndTime>
  <IncludeCompleted>true</IncludeCompleted>
  <IncludeUncompleted>true</IncludeUncompleted>
  <IncludeDescendants>true</IncludeDescendants>
  <JobTypes>
    <JobType>
      <Id>1</Id>
    </JobType>
    <JobType>
      <Id>1</Id>
    </JobType>
  </JobTypes>
  <Statuses>
    <JobStatus>
      <Id>1</Id>
    </JobStatus>
    <JobStatus>
      <Id>1</Id>
    </JobStatus>
  </Statuses>
  <Severities>
    <JobSeverity>NotSet</JobSeverity>
    <JobSeverity>NotSet</JobSeverity>
  </Severities>
  <DataSourceTypes>
    <DataSourceType>
      <Id>1</Id>
    </DataSourceType>
    <DataSourceType>
      <Id>1</Id>
    </DataSourceType>
  </DataSourceTypes>
  <ServerTypes>
    <ServerType>
      <Id>1</Id>
    </ServerType>
    <ServerType>
      <Id>1</Id>
    </ServerType>
  </ServerTypes>
  <JobNames>
    <JobName>
      <Id>2</Id>
      <CreatedDate>2024-09-14T11:46:13.0523961+02:00</CreatedDate>
      <ArchivedDate>2024-09-14T11:46:13.0523961+02:00</ArchivedDate>
      <Name>sample string 1</Name>
    </JobName>
    <JobName>
      <Id>2</Id>
      <CreatedDate>2024-09-14T11:46:13.0523961+02:00</CreatedDate>
      <ArchivedDate>2024-09-14T11:46:13.0523961+02:00</ArchivedDate>
      <Name>sample string 1</Name>
    </JobName>
  </JobNames>
  <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>
  <GroupByConsumer>true</GroupByConsumer>
  <DeliveryTime />
  <Frequency>Daily</Frequency>
  <FrequencyDetails>
    <int>1</int>
    <int>2</int>
  </FrequencyDetails>
  <InlineHtml>true</InlineHtml>
  <AttachCsv>true</AttachCsv>
  <CsvDelimiter>sample string 5</CsvDelimiter>
  <AttachJson>true</AttachJson>
  <AttachPdf>true</AttachPdf>
  <AttachExcel>true</AttachExcel>
  <DataViewConfig>
    <Id>2</Id>
    <CreatedDate>2024-09-14T11:46:13.0523961+02:00</CreatedDate>
    <ArchivedDate>2024-09-14T11:46:13.0523961+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-09-14T11:46:13.0523961+02:00</CreatedDate>
      <ArchivedDate>2024-09-14T11:46:13.0523961+02:00</ArchivedDate>
      <Name>sample string 1</Name>
      <Type>
        <Id>2</Id>
        <CreatedDate>2024-09-14T11:46:13.0523961+02:00</CreatedDate>
        <ArchivedDate>2024-09-14T11:46:13.0523961+02:00</ArchivedDate>
        <Name>sample string 1</Name>
      </Type>
    </DataView>
    <Inherited>true</Inherited>
  </DataViewConfig>
  <IncludeSeverityOk>true</IncludeSeverityOk>
  <IncludeSeverityWarning>true</IncludeSeverityWarning>
  <IncludeSeverityError>true</IncludeSeverityError>
  <DecimalMark>sample string 12</DecimalMark>
  <DateFormat>sample string 13</DateFormat>
  <TimeFormat>sample string 14</TimeFormat>
  <Inherited>true</Inherited>
</JobDeliveryConfig>

Response Information

Resource Description

The updated config

JobDeliveryConfig

Name	Description	Type	Additional information
`GroupByConsumer`	When true all jobs would be estimated by highest severity and sent as one line	boolean	None.
`DeliveryTime`	Time of day the subscription is sent	time interval	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.
`InlineHtml`	Include the requested data as html in body of mail	boolean	None.
`AttachCsv`	Attach a CSV-file with the requested data.	boolean	None.
`CsvDelimiter`		string	None.
`AttachJson`	Attach a JSON-file with the requested data.	boolean	None.
`AttachPdf`	Attach a PDF-file with the requested data.	boolean	None.
`AttachExcel`	Attach an Excel-file with the requested data.	boolean	None.
`DataViewConfig`	A config describing what content to include and how to sort it	DataViewConfig	None.
`IncludeSeverityOk`		boolean	None.
`IncludeSeverityWarning`		boolean	None.
`IncludeSeverityError`		boolean	None.
`DecimalMark`	Decimal mark to use in content Can be "." or ","	string	None.
`DateFormat`	Date format used in content	string	None.
`DateFormatInitialized`	Date format that cannot be null as default date format will be used	string	None.
`TimeFormat`	Time format used in content	string	None.
`TimeFormatInitialized`	Time format that cannot be null as default time format will be used	string	None.
`DateTimeFormat`	The user's preferred date and time format combined Read only	string	None.
`DateAtTimeFormat`	The user's preferred date and time format combined with an @ for easy readability Read only	string	None.
`Inherited`	Gets or sets a value indicating whether this is inherited from an ancestor business unit.	boolean	None.
`StartTime`	Earliest completed time If none given current date minus 24 hours is used	date	None.
`IncludeActive`		boolean	None.
`IncludeUnaccessed`		boolean	None.
`IncludeDecommissioned`		boolean	None.
`IncludeNotFound`		boolean	None.
`IncludeScheduled`		boolean	None.
`IncludeUnscheduled`		boolean	None.
`IncludeSupportActive`		boolean	None.
`IncludeSupportResolved`		boolean	None.
`IncludeSupportIgnored`		boolean	None.
`EndTime`	Latest completed time Nullable	date	None.
`IncludeCompleted`	Include jobs with a completed time	boolean	None.
`IncludeUncompleted`	Include jobs with no completed time These should have status Started, In Progress or Expired	boolean	None.
`IncludeDescendants`	If false, only jobs for current business unit will be returned. If true, jobs for all descendants will included	boolean	None.
`JobTypes`	Types of jobs	Collection of JobType	None.
`Statuses`	Statuses of jobs	Collection of JobStatus	None.
`Severities`	Severities of jobs	Collection of JobSeverity	None.
`DataSourceTypes`	Data-source type of jobs	Collection of DataSourceType	None.
`ServerTypes`	Servertypes of jobs	Collection of ServerType	None.
`JobNames`	Names of jobs	Collection of JobName	None.
`Tags`	A list of tags the data-sources must or must not have	Collection of Tag	None.
`ExcludeTags`	True if data-sources with tags should be excluded	boolean	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:

<JobDeliveryConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>30</Id>
  <CreatedDate>2024-09-14T11:46:13.0835025+02:00</CreatedDate>
  <ArchivedDate>2024-09-14T11:46:13.0835025+02:00</ArchivedDate>
  <StartTime>2024-09-14T11:46:13.0835025+02:00</StartTime>
  <IncludeActive>true</IncludeActive>
  <IncludeUnaccessed>true</IncludeUnaccessed>
  <IncludeDecommissioned>true</IncludeDecommissioned>
  <IncludeNotFound>true</IncludeNotFound>
  <IncludeScheduled>true</IncludeScheduled>
  <IncludeUnscheduled>true</IncludeUnscheduled>
  <IncludeSupportActive>true</IncludeSupportActive>
  <IncludeSupportResolved>true</IncludeSupportResolved>
  <IncludeSupportIgnored>true</IncludeSupportIgnored>
  <EndTime>2024-09-14T11:46:13.0835025+02:00</EndTime>
  <IncludeCompleted>true</IncludeCompleted>
  <IncludeUncompleted>true</IncludeUncompleted>
  <IncludeDescendants>true</IncludeDescendants>
  <JobTypes>
    <JobType>
      <Id>1</Id>
    </JobType>
    <JobType>
      <Id>1</Id>
    </JobType>
  </JobTypes>
  <Statuses>
    <JobStatus>
      <Id>1</Id>
    </JobStatus>
    <JobStatus>
      <Id>1</Id>
    </JobStatus>
  </Statuses>
  <Severities>
    <JobSeverity>NotSet</JobSeverity>
    <JobSeverity>NotSet</JobSeverity>
  </Severities>
  <DataSourceTypes>
    <DataSourceType>
      <Id>1</Id>
    </DataSourceType>
    <DataSourceType>
      <Id>1</Id>
    </DataSourceType>
  </DataSourceTypes>
  <ServerTypes>
    <ServerType>
      <Id>1</Id>
    </ServerType>
    <ServerType>
      <Id>1</Id>
    </ServerType>
  </ServerTypes>
  <JobNames>
    <JobName>
      <Id>2</Id>
      <CreatedDate>2024-09-14T11:46:13.0835025+02:00</CreatedDate>
      <ArchivedDate>2024-09-14T11:46:13.0835025+02:00</ArchivedDate>
      <Name>sample string 1</Name>
    </JobName>
    <JobName>
      <Id>2</Id>
      <CreatedDate>2024-09-14T11:46:13.0835025+02:00</CreatedDate>
      <ArchivedDate>2024-09-14T11:46:13.0835025+02:00</ArchivedDate>
      <Name>sample string 1</Name>
    </JobName>
  </JobNames>
  <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>
  <GroupByConsumer>true</GroupByConsumer>
  <DeliveryTime />
  <Frequency>Daily</Frequency>
  <FrequencyDetails>
    <int>1</int>
    <int>2</int>
  </FrequencyDetails>
  <InlineHtml>true</InlineHtml>
  <AttachCsv>true</AttachCsv>
  <CsvDelimiter>sample string 5</CsvDelimiter>
  <AttachJson>true</AttachJson>
  <AttachPdf>true</AttachPdf>
  <AttachExcel>true</AttachExcel>
  <DataViewConfig>
    <Id>2</Id>
    <CreatedDate>2024-09-14T11:46:13.0835025+02:00</CreatedDate>
    <ArchivedDate>2024-09-14T11:46:13.0835025+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-09-14T11:46:13.0835025+02:00</CreatedDate>
      <ArchivedDate>2024-09-14T11:46:13.0835025+02:00</ArchivedDate>
      <Name>sample string 1</Name>
      <Type>
        <Id>2</Id>
        <CreatedDate>2024-09-14T11:46:13.0835025+02:00</CreatedDate>
        <ArchivedDate>2024-09-14T11:46:13.0835025+02:00</ArchivedDate>
        <Name>sample string 1</Name>
      </Type>
    </DataView>
    <Inherited>true</Inherited>
  </DataViewConfig>
  <IncludeSeverityOk>true</IncludeSeverityOk>
  <IncludeSeverityWarning>true</IncludeSeverityWarning>
  <IncludeSeverityError>true</IncludeSeverityError>
  <DecimalMark>sample string 12</DecimalMark>
  <DateFormat>sample string 13</DateFormat>
  <TimeFormat>sample string 14</TimeFormat>
  <Inherited>true</Inherited>
</JobDeliveryConfig>