GET v1/bunits/{bunitId}/consumers/{consumerId}/vmfilespace/retentionRules

Get retention rules a VM file space is assigned to

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bunitId integer

Required

consumerId integer

Required

Body Parameters

None.

Response Information

Resource Description

RetentionRule
NameDescriptionTypeAdditional information
Name NAME VARCHAR 65 NULL=FALSE
string

None.

NodePaths List of nodes related to the retention rule
string

None.

FilespacePaths List of file spaces related to the retention rule
string

None.

RetentionDays RETDAYS VARCHAR 12 NULL=FALSE
integer

None.

IsActive ISACTIVE VARCHAR 5 NULL=FALSE
boolean

None.

StartTime START TIMESTAMP NULL=TRUE
date

None.

Description DESCR VARCHAR 256 NULL=TRUE
string

None.

ScheduleStyle SCHEDSTYLE VARCHAR 17 NULL=FALSE
Can be "CLASSIC" or "ENHANCED"
string

None.

Frequency FREQUENCY VARCHAR 21 NULL=TRUE
string

None.

DayOfWeek DAY_OF_WEEK VARCHAR 501 NULL=TRUE
string

None.

Month MONTH VARCHAR 501 NULL=TRUE
string

None.

DayOfMonth DAY_OF_MONTH VARCHAR 250 NULL=TRUE
string

None.

WeekOfMonth WEEK_OF_MONTH VARCHAR 251 NULL=TRUE
string

None.

NextStart NEXTSTART TIMESTAMP NULL=TRUE
date

None.

PreviousStart PREVSTART TIMESTAMP NULL=TRUE
date

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.