[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations

ReportSchedule

Model to represent a Report Schedule


Properties

string as uuid
id Required

UUID of the schedule


string
startDate Required

Starting time when the Report Schedule comes into effect. Defaults to the current date.


array of string
emailAddresses Required

Comma separated Email addresses of the recipients for the Report


string as uuid
reportDefinitionId Required

Report Definition identifier


array of string
relativePath Required

Network file share folder names where the reports should be stored


integer as int32
recurrence Required

Indicates the recurrence period of the Schedule. Defaults to 1.


integer as int32
dayOfTheMonth Required

The days of the month when the Schedule will run - Valid values are from 1-31


string as uuid
networkSharePluginId Optional

Identifier of the network share plugin for which this rule applies.


string as uuid
emailPluginId Optional

Identifier of the email plugin for which this rule applies.


array of string
emailCcAddresses Optional

Comma separated Email addresses of the recipients with Cc for the Report


array of string
emailBccAddresses Optional

Comma separated Email addresses of the recipients with Bcc for the Report


string
reportScheduleType Optional

The type of schedule - MONTHLY, WEEKLY etc.

Possible values are: UNKNOWNDAILYWEEKLYMONTHLYYEARLY


array of string as uuid
resourceId Optional

Resource identifiers for which the schedule will be created. Currently we support Schedules for a single Resource.


array of string
daysOfTheWeek Optional

The days of the week this Schedule repeats - SUNDAY, MONDAY, TUESDAY etc.

Possible values are: UNKNOWNSUNDAYMONDAYTUESDAYWEDNESDAYTHURSDAYFRIDAYSATURDAY


integer as int32
startHour Optional

The hour of the day when the Schedule runs. Defaults to 8.


integer as int32
startMinute Optional

The minutes of the hour when the Schedule runs. Defaults to 0.


traversalSpec Optional

Traversal spec used for evaluating the set of Resources for which the Report will be generated. This is used in conjunction with the report definition that will be used when creating the Report Schedule


string
weekOfMonth Optional

The week of the month of this Report Schedule, if the schedule of recurrence is monthly

Possible values are: UNKNOWNNFIRSTSECONDTHIRDFOURTHLAST

JSON Example

{
	"dayOfTheMonth": 0,
	"emailAddresses": [
		"string"
	],
	"id": "string",
	"recurrence": 0,
	"relativePath": [
		"string"
	],
	"reportDefinitionId": "string",
	"startDate": "string"
}
[{"label":"Latest (8.6.3)","version":"latest"}]
vrealize-operations
Property Of

ReportSchedules
Parameter To

Update Report Schedule
Create Report Schedule
Returned By

Update Report Schedule
Create Report Schedule
Get Report Schedule

Feedback

Was this page helpful?