report-schedule

report-schedule
report-schedule

Model to represent a Report Schedule

JSON Example
{
    "id": "string",
    "reportDefinitionId": "string",
    "resourceId": [
        "string"
    ],
    "traversalSpec": {
        "name": "string",
        "description": "string",
        "rootAdapterKindKey": "string",
        "rootResourceKindKey": "string",
        "adapterInstanceAssociation": false
    },
    "startDate": "string",
    "weekOfMonth": "string",
    "reportScheduleType": "string",
    "daysOfTheWeek": [
        "string"
    ],
    "startHour": 0,
    "startMinute": 0,
    "recurrence": 0,
    "dayOfTheMonth": 0,
    "emailAddresses": [
        "string"
    ],
    "emailCcAddresses": [
        "string"
    ],
    "emailBccAddresses": [
        "string"
    ],
    "emailPluginId": "string",
    "networkSharePluginId": "string",
    "relativePath": [
        "string"
    ]
}
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.

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

Property Of
Parameter To
Returned By