Create Report Schedule Using POST

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.

Request
URI
POST
https://{api_host}/api/reportdefinitions/{id}/schedules
COPY
Path Parameters
string
id
Required

id

Header Parameters
string
X-vRealizeOps-API-Timezone
Optional

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.

Request Body

The Report Schedule to create in the system

report-schedule of type(s) application/json
Required

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"
}
integer As int32 As int32
dayOfTheMonth
Required

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

array of string
daysOfTheWeek
Optional

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

Possible values are : UNKNOWN, SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
array of string
emailAddresses
Required

Comma separated Email addresses of the recipients for the Report

array of string
emailBccAddresses
Optional

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

array of string
emailCcAddresses
Optional

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

string As uuid As uuid
emailPluginId
Optional

Identifier of the email plugin for which this rule applies.

string As uuid As uuid
id
Required

UUID of the schedule

string As uuid As uuid
networkSharePluginId
Optional

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

integer As int32 As int32
recurrence
Required

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

array of string
relativePath
Required

Network file share folder names where the reports should be stored

string As uuid As uuid
reportDefinitionId
Required

Report Definition identifier

string
reportScheduleType
Optional

The type of schedule - MONTHLY, WEEKLY etc.

Possible values are : UNKNOWN, DAILY, WEEKLY, MONTHLY, YEARLY,
array of string
resourceId
Optional

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

string
startDate
Required

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

integer As int32 As int32
startHour
Optional

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

integer As int32 As int32
startMinute
Optional

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

traversal-spec
traversalSpec
Optional

Represents traversal specs. These are templates in the system using which admins can assign specific set of resources to their users.

string
weekOfMonth
Optional

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

Possible values are : UNKNOWNN, FIRST, SECOND, THIRD, FOURTH, LAST,
Authentication
This operation uses the following authentication methods.
Responses
200

The Report Schedule to create in the system

Returns report-schedule of type(s) application/json 
{
    "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"
}
integer As int32 As int32
dayOfTheMonth
Required

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

array of string
daysOfTheWeek
Optional

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

Possible values are : UNKNOWN, SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,
array of string
emailAddresses
Required

Comma separated Email addresses of the recipients for the Report

array of string
emailBccAddresses
Optional

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

array of string
emailCcAddresses
Optional

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

string As uuid As uuid
emailPluginId
Optional

Identifier of the email plugin for which this rule applies.

string As uuid As uuid
id
Required

UUID of the schedule

string As uuid As uuid
networkSharePluginId
Optional

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

integer As int32 As int32
recurrence
Required

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

array of string
relativePath
Required

Network file share folder names where the reports should be stored

string As uuid As uuid
reportDefinitionId
Required

Report Definition identifier

string
reportScheduleType
Optional

The type of schedule - MONTHLY, WEEKLY etc.

Possible values are : UNKNOWN, DAILY, WEEKLY, MONTHLY, YEARLY,
array of string
resourceId
Optional

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

string
startDate
Required

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

integer As int32 As int32
startHour
Optional

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

integer As int32 As int32
startMinute
Optional

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

traversal-spec
traversalSpec
Optional

Represents traversal specs. These are templates in the system using which admins can assign specific set of resources to their users.

string
weekOfMonth
Optional

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

Possible values are : UNKNOWNN, FIRST, SECOND, THIRD, FOURTH, LAST,

On This Page
Reports Operations
POST
Create Report Schedule Using POST
POST
Create Report Using POST
DELETE
Delete Report Using DELETE
DELETE
Delete Schedule Using DELETE
GET
Download Report Using GET
GET
Get Report Definitions Using GET
GET
Get Report Definition Using GET
GET
Get Report Schedules Using GET
GET
Get Report Schedule Using GET
GET
Get Reports Using GET
GET
Get Report Using GET
PUT
Update Report Schedule Using PUT