Create Report Schedule

Create Report Schedule

To specify the time zone add X-Ops-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}/suite-api/api/reportdefinitions/{id}/schedules
COPY
Path Parameters
string
id
Required

Report Definition identifier

Header Parameters
string
X-Ops-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

{
    "reportDefinitionId": "string",
    "startDate": "string",
    "recurrence": 0,
    "dayOfTheMonth": 0,
    "relativePath": [
        {}
    ]
}
"{\n  \"reportDefinitionId\" : \"2667dbff-8777-49cb-bfd9-ee380f9f9857\",\n  \"resourceId\" : [ \"79364126-7207-4325-a980-8cfc33ff26ab\" ],\n  \"traversalSpec\" : {\n    \"name\" : \"Traversal spec name\",\n    \"rootAdapterKindKey\" : \"VMWARE\",\n    \"rootResourceKindKey\" : \"VM\",\n    \"adapterInstanceAssociation\" : false\n  },\n  \"startDate\" : \"4/30/15\",\n  \"reportScheduleType\" : \"WEEKLY\",\n  \"daysOfTheWeek\" : [ \"SUNDAY\", \"MONDAY\" ],\n  \"startHour\" : 1,\n  \"startMinute\" : 0,\n  \"recurrence\" : 2\n}"
string As uuid As uuid
id
Optional

UUID of the schedule

string As uuid As uuid
reportDefinitionId
Required

Report Definition identifier

array of string
resourceId
Optional

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

object
traversalSpec
Optional

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

string
startDate
Required

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

string
weekOfMonth
Optional

Week of the Month

Possible values are : UNKNOWNN, FIRST, SECOND, THIRD, FOURTH, LAST,
string
reportScheduleType
Optional

Types of schedule

Possible values are : UNKNOWN, DAILY, WEEKLY, MONTHLY, YEARLY,
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,
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.

integer As int32 As int32
recurrence
Required

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

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
emailAddresses
Optional

Comma separated Email addresses of the recipients for the Report

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 As uuid As uuid
emailPluginId
Optional

Identifier of the email plugin for which this rule applies.

string As uuid As uuid
networkSharePluginId
Optional

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

array of string
relativePath
Required

Network file share folder names where the reports should be stored

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 
"{\n  \"reportDefinitionId\" : \"aad73445-808e-4577-a7af-c1448a425765\",\n  \"resourceId\" : [ \"b9ab7d40-d798-4668-b649-9b5001d5837d\" ],\n  \"startDate\" : \"01/01/2015\",\n  \"reportScheduleType\" : \"MONTHLY\",\n  \"startHour\" : 8,\n  \"startMinute\" : 0,\n  \"recurrence\" : 1,\n  \"dayOfTheMonth\" : 1,\n  \"emailAddresses\" : [ \"[email protected]\" ]\n}"
string As uuid As uuid
id
Optional

UUID of the schedule

string As uuid As uuid
reportDefinitionId
Required

Report Definition identifier

array of string
resourceId
Optional

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

object
traversalSpec
Optional

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

string
startDate
Required

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

string
weekOfMonth
Optional

Week of the Month

Possible values are : UNKNOWNN, FIRST, SECOND, THIRD, FOURTH, LAST,
string
reportScheduleType
Optional

Types of schedule

Possible values are : UNKNOWN, DAILY, WEEKLY, MONTHLY, YEARLY,
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,
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.

integer As int32 As int32
recurrence
Required

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

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
emailAddresses
Optional

Comma separated Email addresses of the recipients for the Report

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 As uuid As uuid
emailPluginId
Optional

Identifier of the email plugin for which this rule applies.

string As uuid As uuid
networkSharePluginId
Optional

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

array of string
relativePath
Required

Network file share folder names where the reports should be stored


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"dayOfTheMonth:"integer","recurrence:"integer","relativePath":["string"],"reportDefinitionId:"string","startDate:"string"}' https://{api_host}/suite-api/api/reportdefinitions/{id}/schedules
On This Page
Reports Operations
GET
Get Report Schedules
PUT
Update Report Schedule
POST
Create Report Schedule
GET
Get Reports
POST
Create Report
GET
Get Report
DELETE
Delete Report
GET
Download Report
GET
Get Report Definitions
GET
Get Report Definition
GET
Get Report Schedule
DELETE
Delete Schedule