Create Report Schedule Using POST
To specify the time zone add X-vRealizeOps-API-Timezone header with value of format e.g. Asia/Yerevan. All the schedules created using this API will be configured to use GMT time zone.
id
Custom HTTP header used by Ops API clients to specify Timezone information. This Timezone value will be typically used for Report Generation. Either an abbreviation such as "GMT", "PDT" can be specified, or a full name such as "America/Los_Angeles". Other formats and representations are not supported.
The Report Schedule to create in the system
Show optional properties
{
"dayOfTheMonth": 0,
"emailAddresses": [
{}
],
"id": "string",
"recurrence": 0,
"relativePath": [
{}
],
"reportDefinitionId": "string",
"startDate": "string"
}
{
"dayOfTheMonth": 0,
"daysOfTheWeek": [
"string"
],
"emailAddresses": [
"string"
],
"emailBccAddresses": [
"string"
],
"emailCcAddresses": [
"string"
],
"emailPluginId": "string",
"id": "string",
"networkSharePluginId": "string",
"recurrence": 0,
"relativePath": [
"string"
],
"reportDefinitionId": "string",
"reportScheduleType": "string",
"resourceId": [
"string"
],
"startDate": "string",
"startHour": 0,
"startMinute": 0,
"traversalSpec": {
"adapterInstanceAssociation": false,
"description": "string",
"name": "string",
"rootAdapterKindKey": "string",
"rootResourceKindKey": "string"
},
"weekOfMonth": "string"
}
The days of the month when the Schedule will run - Valid values are from 1-31
The days of the week this Schedule repeats - SUNDAY, MONDAY, TUESDAY etc.
Comma separated Email addresses of the recipients for the Report
Comma separated Email addresses of the recipients with Bcc for the Report
Comma separated Email addresses of the recipients with Cc for the Report
Identifier of the email plugin for which this rule applies.
UUID of the schedule
Identifier of the network share plugin for which this rule applies.
Indicates the recurrence period of the Schedule. Defaults to 1.
Network file share folder names where the reports should be stored
Report Definition identifier
The type of schedule - MONTHLY, WEEKLY etc.
Resource identifiers for which the schedule will be created. Currently we support Schedules for a single Resource.
Starting time when the Report Schedule comes into effect. Defaults to the current date.
The hour of the day when the Schedule runs. Defaults to 8.
The minutes of the hour when the Schedule runs. Defaults to 0.
Represents traversal specs. These are templates in the system using which admins can assign specific set of resources to their users.
The week of the month of this Report Schedule, if the schedule of recurrence is monthly
The Report Schedule to create in the system
{
"dayOfTheMonth": 0,
"daysOfTheWeek": [
"string"
],
"emailAddresses": [
"string"
],
"emailBccAddresses": [
"string"
],
"emailCcAddresses": [
"string"
],
"emailPluginId": "string",
"id": "string",
"networkSharePluginId": "string",
"recurrence": 0,
"relativePath": [
"string"
],
"reportDefinitionId": "string",
"reportScheduleType": "string",
"resourceId": [
"string"
],
"startDate": "string",
"startHour": 0,
"startMinute": 0,
"traversalSpec": {
"adapterInstanceAssociation": false,
"description": "string",
"name": "string",
"rootAdapterKindKey": "string",
"rootResourceKindKey": "string"
},
"weekOfMonth": "string"
}
The days of the month when the Schedule will run - Valid values are from 1-31
The days of the week this Schedule repeats - SUNDAY, MONDAY, TUESDAY etc.
Comma separated Email addresses of the recipients for the Report
Comma separated Email addresses of the recipients with Bcc for the Report
Comma separated Email addresses of the recipients with Cc for the Report
Identifier of the email plugin for which this rule applies.
UUID of the schedule
Identifier of the network share plugin for which this rule applies.
Indicates the recurrence period of the Schedule. Defaults to 1.
Network file share folder names where the reports should be stored
Report Definition identifier
The type of schedule - MONTHLY, WEEKLY etc.
Resource identifiers for which the schedule will be created. Currently we support Schedules for a single Resource.
Starting time when the Report Schedule comes into effect. Defaults to the current date.
The hour of the day when the Schedule runs. Defaults to 8.
The minutes of the hour when the Schedule runs. Defaults to 0.
Represents traversal specs. These are templates in the system using which admins can assign specific set of resources to their users.
The week of the month of this Report Schedule, if the schedule of recurrence is monthly