POST v1/bunits/{bunitId}/jobdeliveryconfig
Create a job delivery config for a business unit
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
bunitId |
ID of the business unit the config should be related to | integer |
Required |
Body Parameters
The config to create
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 |
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. |
Operations |
Collection of OperationResult |
None. |
Request Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
The created 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 |
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. |
Operations |
Collection of OperationResult |
None. |
Response Formats
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.