GET v1/bunits/{bunitId}/DeleteRequestSettings/{deleteRequestSettingsId}
Get deletion request settings relevant to the business unit
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
bunitId |
The business unit requesting the deletion requests | integer |
Required |
deleteRequestSettingsId |
The id of the settings to get | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Deletion request settings relevant to the business unit
DeleteRequestSettingsName | Description | Type | Additional information |
---|---|---|---|
Type |
What type of deletion requests these settings are applied to |
integer |
None. |
OffsetDays |
Number of days before a deletion request for a consumption unit can be excecuted |
integer |
None. |
OffsetMonths |
Number of months before a deletion request for a consumption unit can be excecuted |
integer |
None. |
EndOfMonth |
If true the first month offset will return end of month |
boolean |
None. |
MonthSpan |
How many months in to the future it is possible to request deletions |
integer |
None. |
DeletionDays |
The days during a month deletions can be requested |
Collection of integer |
None. |
OnlyAllowDeletionDays |
If set to true only days can be selected If set to false the first day after retention will be first selectable day |
boolean |
None. |
OnlyAllowFirstDay |
If set to true only the first day after retention can be selected |
boolean |
None. |
GigaBytesWarningLimit |
A limit for when a warning is sent when deletion request is created |
decimal number |
None. |
MegaBytesWarningLimit |
A limit for when a warning is sent when deletion request is created. Not to be used through API |
decimal number |
None. |
WarningLimitEmails |
The address any violations of the megabytes limit should be sent to |
Collection of string |
None. |
Inherited |
Whether or not the settings are related to the current business unit or inherited from a parent |
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.