POST v1/bunits/{bunitId}/statusreportsubscriptions
Create a status report subscription for a business unit
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bunitId |
ID of the business unit the subscription should be related to | integer |
Required |
Body Parameters
The subscription to create
StatusReportSubscriptionName | Description | Type | Additional information |
---|---|---|---|
Enabled |
An enabled subscription will be sent out Disable to keep information but avoid getting mails |
boolean |
None. |
Name |
Name of subscription. Used to describe content |
string |
None. |
Subject |
Custom subject set by end user. Leave blank for default subject |
string |
None. |
SendBcc |
Whether or not to use BCC or To when sending emails. Use BCC to hide receivers from each other |
boolean |
None. |
DeliveryConfig |
Information about what items should be included in status report and when it should be sent. If none is set this information will be inhereted from the business unit |
StatusReportDeliveryConfig |
None. |
ErrorConfig |
Information about how severe issues affects the status of the consumption units If not set the error config is inhereted from the business unit |
ReportErrorConfig |
None. |
ConsumptionUnitDeliveryConfig |
Information on how to send information about individual consumption units included in the status report. Can be used for sending emails to ticket systems or other automated systems Filters applied for consumption unit delivery config is applied to the already filtered items of the status report |
StatusReportConsumptionUnitDeliveryConfig |
None. |
ConsumptionUnitEmails |
A list of receivers of individual consumption unit emails |
Collection of string |
None. |
BusinessUnitId |
Id of the business unit whose status reports the configuration concerns |
integer |
None. |
Emails |
Recipient email addresses. |
Collection of string |
None. |
LatestDelivery |
Information about the latest time the subscription was sent |
SubscriptionLog |
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 subscription
StatusReportSubscriptionName | Description | Type | Additional information |
---|---|---|---|
Enabled |
An enabled subscription will be sent out Disable to keep information but avoid getting mails |
boolean |
None. |
Name |
Name of subscription. Used to describe content |
string |
None. |
Subject |
Custom subject set by end user. Leave blank for default subject |
string |
None. |
SendBcc |
Whether or not to use BCC or To when sending emails. Use BCC to hide receivers from each other |
boolean |
None. |
DeliveryConfig |
Information about what items should be included in status report and when it should be sent. If none is set this information will be inhereted from the business unit |
StatusReportDeliveryConfig |
None. |
ErrorConfig |
Information about how severe issues affects the status of the consumption units If not set the error config is inhereted from the business unit |
ReportErrorConfig |
None. |
ConsumptionUnitDeliveryConfig |
Information on how to send information about individual consumption units included in the status report. Can be used for sending emails to ticket systems or other automated systems Filters applied for consumption unit delivery config is applied to the already filtered items of the status report |
StatusReportConsumptionUnitDeliveryConfig |
None. |
ConsumptionUnitEmails |
A list of receivers of individual consumption unit emails |
Collection of string |
None. |
BusinessUnitId |
Id of the business unit whose status reports the configuration concerns |
integer |
None. |
Emails |
Recipient email addresses. |
Collection of string |
None. |
LatestDelivery |
Information about the latest time the subscription was sent |
SubscriptionLog |
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.