Create Report Schedule By Id

Create a Tenant Report Schedule to generate a Report for the specified Report Definition and Resource(s)

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/chargeback/reportdefinitions/{id}/schedules

COPY

Path Parameters

string

Required

The Tenant 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 Tenant Report Schedule to create in the system

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

Required

Show optional properties

{
    "recurrence": 0,
    "reportScheduleType": "string",
    "resourceIds": [
        {}
    ],
    "startDate": "string"
}

"{\n  \"resourceIds\" : [ \"d2580a78-eacf-49fd-b6e2-b6e9eacd155e\" ],\n  \"startDate\" : \"4/30/15\",\n  \"reportScheduleType\" : \"WEEKLY\",\n  \"daysOfTheWeek\" : [ \"SUNDAY\", \"MONDAY\" ],\n  \"startHour\" : 1,\n  \"startMinute\" : 0,\n  \"recurrence\" : 2\n}"

integer As int32 As int32

dayOfTheMonth

Optional

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

Possible values are : UNKNOWN, SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,

string As uuid As uuid

Optional

UUID of the schedule

integer As int32 As int32

recurrence

Required

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

string

reportScheduleType

Required

Types of schedule

Possible values are : UNKNOWN, DAILY, WEEKLY, MONTHLY, YEARLY,

array of string

resourceIds

Required

Constraints: minItems: 0 maxItems: 1

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.

string

weekOfMonth

Optional

Week of the Month

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

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

201

The Tenant Report Schedule to create in the system

Returns chargeback-report-schedule of type(s) application/json

"{\n  \"resourceIds\" : [ \"b7c82429-40cb-47ac-bb98-46ea2af83002\" ],\n  \"startDate\" : \"01/01/2015\",\n  \"reportScheduleType\" : \"MONTHLY\",\n  \"startHour\" : 8,\n  \"startMinute\" : 0,\n  \"recurrence\" : 1,\n  \"dayOfTheMonth\" : 1\n}"

integer As int32 As int32

dayOfTheMonth

Optional

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

Possible values are : UNKNOWN, SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY,

string As uuid As uuid

Optional

UUID of the schedule

integer As int32 As int32

recurrence

Required

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

string

reportScheduleType

Required

Types of schedule

Possible values are : UNKNOWN, DAILY, WEEKLY, MONTHLY, YEARLY,

array of string

resourceIds

Required

Constraints: minItems: 0 maxItems: 1

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.

string

weekOfMonth

Optional

Week of the Month

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

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"recurrence":"integer","reportScheduleType":"string","resourceIds":["string"],"startDate":"string"}' https://{api_host}/suite-api/api/chargeback/reportdefinitions/{id}/schedules

On This Page

Description

Request

Path Parameters

Header Parameters

Request Body

Authentication

Response

201 Response Body

Tenant Reports Operations

GET

Get Report Schedules By Id