Create Report Schedule

This API helps to create a report schedule.


User Privilege

You need to have create privilege on report schedule privilege and read privilege on the hierarchy and entities for which you creating the report schedule. You must also have read privilege on the cost model and fixed costs. Additionally, in order to view the generated report, you should also have create privilege on the report.

Syntax

The syntax for calling this method is:

POST <Base_Url>/reportSchedule

For example, POST https://123.123.123.123/vCenter-CB/api/reportSchedule

Request Parameters

The API takes a request XML that contains the following information.

XPath

Type

Min Occurs

Max Occurs

Description

ReportSchedules/ReportSchedule/MetaData

 

1

1

Represents the meta data of the report schedule.

ReportSchedules/ReportSchedule/MetaData/Name

xs:string

1

1

Name of the report schedule that you want to add. The character limit for the report schedule name is 255 characters.

ReportSchedules/ReportSchedule/MetaData/Description

xs:string

0

1

An optional description of the report schedule. The character limit for the description is 512 characters.

ReportSchedules/ReportSchedule/MetaData/ReportType

xs:string

1

1

Type of the report that needs to be generated. Valid report types are COST_REPORT, COST_COMPARISON_REPORT and UTILIZATION_REPORT.

ReportSchedules/ReportSchedule/MetaData/OwnedByName

xs:string

0

1

User name of the owner of the report.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy

 

1

1

Represents the hierarchy for which you want to generate the report.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/@id

xs:int

1

1

ID of the hierarchy for which you want to generate the report.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity

 

1

unbounded

Represents the hierarchy for which you want to generate the report.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/@id

xs:int

1

1

IDs of the entities for which you want to generate the report.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/@costModelId

xs:int

1

1

ID of the cost model. This element is used for all reports except the Cost Comparison report.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes

 

0

1

Represents a complex expression based on custom attribute value pairs that is used to filter entities in the sub-tree under “Entity”.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/@operator

xs:string

0

1

Represents operator for the attribute criteria expression. [enum {“OR”, “AND”} ].

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/Attribute

 

0

unbounded

Represents simple expression using a single attribute value pair.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/Attribute/@id

xs:int

1

1

ID of the custom attribute.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/Attribute/@criteria

xs:string

0

1

Represents value matching criteria for the attribute value. [enum: { "EQUALS", "STARTS_WITH, ENDS_WITH", "CONTAINS"}].

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/Attribute/Value

 

1

1

Represents the value of the attribute in the attribute value pair.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/Attributes

 

0

unbounded

Attributes can be nested within attributes for complex expression.

ReportSchedules/ReportSchedule/MetaData/CostModels/CostModel

 

0

2

Represents the cost model for which you want to generate the report. This element needs to be used only for the Cost Comparison report.

ReportSchedules/ReportSchedule/MetaData/CostModels/CostModel/@id

xs:int

1

1

ID of the cost model for which you want to generate the report.

ReportSchedules/ReportSchedule/MetaData/ComputeResources/ComputeResources

 

1

unbounded

Represents the computing resources for which you want to generate the report.

ReportSchedules/ReportSchedule/MetaData/ComputeResources/ComputeResources/@id

xs:int

1

1

IDs of the computing resources for which you want to generate the report.

ReportSchedules/ReportSchedule/MetaData/ReportPeriodType

xs:string

1

1

Valid values are CUSTOM, DAILY, HALFYEARLY, MONTHLY, QUARTERLY, WEEKLY, YEARLY. If the value is HALFYEARLY, then the duration is implied as previous half of the year. If the value is QUARTERLY, then the duration is always the previous quarter.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod

 

1

1

Represents how often the report needs to be generated.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Daily

 

0

1

Represents the Daily report period.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Daily/DaysBefore

xs:int

1

1

Number of days the server needs to go back and compute the report start date. The report duration will always be one day.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Weekly

 

0

1

Represents the Weekly report period .

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Weekly/StartDayOfWeek

xs:int

1

1

Start day in the week to generate the report. The report duration will always be seven days.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Monthly

 

0

1

Represents the Monthly report period.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Monthly/StartDayOfMonth

xs:int

1

1

Start day in the month to generate the report. The report duration will always be one month.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Yearly

 

0

1

Represents the Yearly report period.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Yearly/StartDayOfMonth

xs:int

1

1

Start day in a month.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Yearly/Month

xs:int

1

1

Month from which the report’s start date needs to start.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Custom

 

0

1

Represents the Custom report period.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Custom/StartTimeInMillis

xs:long

1

1

Report’s start time from 12:00 AM in milliseconds. The valid value should be between 0 and 86340000.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Custom/EndTimeInMillis

xs:long

1

1

Report’s end time from 12:00 AM in milliseconds. The valid value should be between 0 and 86340000.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Custom/DaysBefore

xs:int

1

1

Number of days the server needs to go back and compute the report start date.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Custom/NumOfDays

xs:int

1

1

Number of days from the start date.

ReportSchedules/ReportSchedule/ScheduleDetail

 

1

1

 

 

ReportSchedules/ReportSchedule/ScheduleDetail/FireTime

 

1

1

Represents the time at which the report schedule needs to be triggered.

ReportSchedules/ReportSchedule/ScheduleDetail/FireTime/Hour

xs:int

1

1

The hour at which the schedule needs to be triggered.

ReportSchedules/ReportSchedule/ScheduleDetail/FireTime/Minute

xs:int

1

1

The minute at which the schedule needs to be triggered.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence

 

1

1

Represents the frequency at which the report needs to generated.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence/@type

xs:string

1

1

Indicates the frequency at which the report needs to generated. The valid values are DAILY, WEEKLY, MONTHLY and YEARLY.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence/DayOfMonth

xs:int

0

1

The day in a month when the report needs to triggered. This value is applicable if the report has a monthly or yearly schedule.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence/DayOfWeek

xs:int

0

1

The day in a week when the report needs to triggered. This value is applicable if the report has a weekly schedule.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence/RepeatInterval

xs:int

0

1

Repeat the “DAILY” schedule with the mentioned interval.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence/Month

xs:int

0

1

The month in which the report needs to be triggered. This is applicable to YEARLY schedule.

ReportSchedules/ReportSchedule/ScheduleDetail/Range

 

1

1

Represents the start and end dates of the period for which the report schedule is to be generated.

ReportSchedules/ReportSchedule/ScheduleDetail/Range/StartDate

xs:long

1

1

Time in milliseconds (from January 1, 1970 GMT 00:00) representing the schedule start date.

ReportSchedules/ReportSchedule/ScheduleDetail/Range/EndDate

xs:long

1

1

Time in milliseconds (from January 1, 1970 GMT 00:00) representing the schedule end date. If EndDate is not specified, the report schedule is triggered based on the Count parameter given below.

ReportSchedules/ReportSchedule/ScheduleDetail/Range/Count

xs:int

1

1

Number of times the report schedule is triggered.

A value of -1 means that the schedule is triggered infinite number of times.

ReportSchedules/ReportSchedule/Configuration

xs:complex type

0

1

Elements of this section are used in the vCenter Chargeback Manager UI to customize the look and feel of the report.

ReportSchedules/ReportSchedule/Configuration/Computation

 

0

1

Represents a complex expression that affects the computation logic of the report.

ReportSchedules/ReportSchedule/Configuration/Computation/Settings

 

0

unbounded

Every occurrence of the "Settings" element represents the configuration information for a feature.

ReportSchedules/ReportSchedule/Configuration/Computation/Settings/@type

xs:string

1

1

Type of the setting. The value currently supported is "costVariance".

ReportSchedules/ReportSchedule/Configuration/Computation/Settings/Property

 

1

unbounded

Property element that holds the property name and its value.

ReportSchedules/ReportSchedule/Configuration/Computation/Settings/Property/@name

xs:string

1

1

Represents the name of the property.

ReportSchedules/ReportSchedule/Configuration/Computation/Settings/Property/@value

xs:string

1

1

Represents the value of the property. Following are the valid properties for “costVariance”:

  • Name = enabled Values = true/false
  • Name = granularity Values = DAILY/HOURLY

ReportSchedules/ReportSchedule/Email

 

0

1

Represents the information required for sending a report schedule by email.

ReportSchedules/ReportSchedule/Email/Subject

xs:string

1

1

Subject of the email.

ReportSchedules/ReportSchedule/Email/Message

xs:string

1

1

Message body of the email.

ReportSchedules/ReportSchedule/Email/ToAddresses/EmailId

xs:string

1

1

Comma-separated email IDs of the recipients.

ReportSchedules/ReportSchedule/Email/CcAddresses/EmailId

xs:string

0

1

Comma-separated email IDs of the recipients who have been copied in the email.

A sample request XML is provided here.

API Response

The API returns an XML that provides details about the report schedule.

XPath

Type

Min Occurs

Max Occurs

Description

ReportSchedules/ReportSchedule/@id

xs:int

1

1

ID of the report schedule.

ReportSchedules/ReportSchedule/MetaData

 

1

1

Represents the meta data of the report schedule.

ReportSchedules/ReportSchedule/MetaData/Name

xs:string

1

1

Name of the report schedule.

ReportSchedules/ReportSchedule/MetaData/Description

xs:string

0

1

A brief description of the report schedule.

ReportSchedules/ReportSchedule/MetaData/ReportType

xs:string

1

1

Type of the report that will be generated by the schedule. The valid report types are COST_REPORT, COST_COMPARISON_REPORT and USAGE_REPORT.

ReportSchedules/ReportSchedule/MetaData/CreatedOn

xs:long

1

1

The date and time (in milliseconds; from January 1, 1970 GMT 00:00) of the creation of the report schedule.

ReportSchedules/ReportSchedule/MetaData/ModifiedOn

xs:long

0

1

The date and time (in milliseconds; from January 1, 1970 GMT 00:00) at which the report schedule was last modified.

ReportSchedules/ReportSchedule/MetaData/CreatedBy

xs:int

1

1

ID of the user, who has created this report schedule.

ReportSchedules/ReportSchedule/MetaData/CreatedByName

xs:string

1

1

Name of the user who has created the report schedule.

ReportSchedules/ReportSchedule/MetaData/ModifiedBy

xs:int

0

1

ID of the user who has modified this report schedule.

ReportSchedules/ReportSchedule/MetaData/ModifiedByName

xs:string

0

1

Name of the user who has modified the report schedule.

ReportSchedules/ReportSchedule/MetaData/OwnedByName

xs:string

0

1

Name of the user for whom the report will be generated.

ReportSchedules/ReportSchedule/MetaData/Currency

 

1

1

Represents the currency used in the report.

ReportSchedules/ReportSchedule/MetaData/Currency/@id

xs:int

1

1

ID of the currency used in the report

ReportSchedules/ReportSchedule/MetaData/Currency/Name

xs:string

1

1

Short name of the currency used in the report.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy

 

1

1

Represents the hierarchy for which the report will be generated.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/@id

xs:int

1

1

ID of the hierarchy for which the report will be generated.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Name

xs:string

1

1

Name of the hierarchy for which the report will be generated.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Description

xs:string

0

1

Description of the hierarchy for which the report will be generated.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity

 

1

unbounded

Represents the entity for which the report is generated.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/@id

xs:int

1

1

ID of the entity that will be included in the report.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Name

xs:string

1

1

Name of the entity that will be included in the report.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Description

xs:string

0

1

Description of the entity that will be included in the report.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes

 

0

1

Represents a complex expression based on custom attribute value pairs that is used to filter entities in the sub-tree under “Entity”.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/@operator

xs:string

0

1

Represents operator for the attribute criteria expression. [enum {“OR”, “AND”} ]. Default is OR.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/Attribute

 

0

unbounded

Represents simple expression using a single attribute value pair.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/Attribute/@id

xs:int

1

1

ID of the custom attribute.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/Attribute/@criteria

xs:string

0

1

Represents value matching criteria for the attribute value. [enum: { "EQUALS", "STARTS_WITH, ENDS_WITH", "CONTAINS"}]. Default is EQUALS.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/Attribute/Value

 

1

1

Represents the value of the attribute in the attribute value pair.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/Attributes/Attributes

 

0

unbounded

Attributes can be nested within attributes for complex expression.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/CostModel

 

1

unbounded

Represents the cost model set for the entity.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/CostModel/@id

xs:int

1

1

ID of the cost model for which the report will be generated.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/CostModel/Name

xs:string

1

1

Name of the cost model for which the report will be generated.

ReportSchedules/ReportSchedule/MetaData/Hierarchies/Hierarchy/Entities/Entity/CostModel/Description

xs:string

0

1

Description of the cost model for which the report will be generated.

ReportSchedules/ReportSchedule/MetaData/CostModels/CostModel

 

0

2

Represents the cost model for which the report will be generated. This element is only for the Cost Comparison report.

ReportSchedules/ReportSchedule/MetaData/CostModels/CostModel/@id

xs:int

0

2

ID of the cost model.

ReportSchedules/ReportSchedule/MetaData/CostModels/CostModel/Name

xs:string

1

1

Name of the cost model for which the report will be generated.

ReportSchedules/ReportSchedule/MetaData/CostModels/CostModel/Description

xs:string

0

1

Description of the cost model for which the report will be generated.

ReportSchedules/ReportSchedule/MetaData/ComputingResources/ComputingResource

 

1

unbounded

Represents the computing resources for which the report will be generated.

ReportSchedules/ReportSchedule/MetaData/ComputingResources/ComputingResource/@id

xs:int

1

1

ID of the computing resource

ReportSchedules/ReportSchedule/MetaData/ComputingResources/ComputingResource/Name

xs:string

1

1

Name of the computing resource

ReportSchedules/ReportSchedule/MetaData/ComputingResources/ComputingResource/Description

xs:string

1

1

Description of the computing resource

ReportSchedules/ReportSchedule/MetaData/ComputingResources/ComputingResource/Unit

xs:int

1

1

Unit of measurement applicable for the computing resource.

ReportSchedules/ReportSchedule/MetaData/ReportPeriodType

xs:string

1

1

Valid values are CUSTOM, DAILY, HALFYEARLY, MONTHLY, QUARTERLY, WEEKLY, YEARLY. If the value is HALFYEARLY, then the duration is implied as previous half of the year. If the value is QUARTERLY, then the duration is always the previous quarter.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod

 

1

1

Represents the period for which the report will be generated.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Daily

 

0

1

Represents the Daily report period.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Daily/DaysBefore

xs:int

1

1

Number of days the server needs to go back and compute the report start date. The report duration will always be one day.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Weekly

 

0

1

Represents the Weekly report period.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Weekly/StartDayOfWeek

xs:int

0

1

Start day in the week to generate the report. The report duration will always be seven days.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Monthly

 

0

1

Represents the Monthly report period.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Monthly/StartDayOfMonth

xs:int

1

1

Start day in the month to generate the report. The report duration will always be one month.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Yearly

 

0

1

Represents the Yearly report period.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Yearly/StartDayOfMonth

xs:int

1

1

Start day in a month.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Yearly/Month

xs:int

1

1

Month in the report’s start date.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Custom/

 

0

1

Represents the Custom report period.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Custom/StartTimeInMillis

xs:long

1

1

Report’s start time from 12:00 AM in milliseconds. The valid value should be between 0 and 86340000.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Custom/EndTimeInMillis

xs:long

1

1

Report’s end time from 12:00 AM in milliseconds. The valid value should be between 0 and 86340000.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Custom/DaysBefore

xs:int

1

1

Number of days the server needs to go back and compute the report start date.

ReportSchedules/ReportSchedule/MetaData/ReportPeriod/Custom/NumOfDays

xs:int

1

1

Number of days from the start date.

ReportSchedules/ReportSchedule/ScheduleDetail/FireTime

 

1

1

Represents the time at which the report schedule was triggered.

ReportSchedules/ReportSchedule/ScheduleDetail/FireTime/Hour

xs:int

1

1

The hour at which the schedule was triggered.

ReportSchedules/ReportSchedule/ScheduleDetail/FireTime/Minute

xs:int

1

1

The minute at which the schedule was triggered.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence/@type

xs:string

1

1

Indicates the frequency at which the report was generated. The valid values are DAILY, WEEKLY, MONTHLY and YEARLY.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence

 

1

1

Represents how frequently the report schedule was triggered.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence/DayOfMonth

xs:int

0

1

The day in a month when the report is triggered. This value is applicable if the report has a monthly or yearly schedule.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence/DayOfWeek

xs:int

0

1

The day in a week when the report is triggered. This value is applicable if the report has a weekly schedule.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence/RepeatInterval

xs:int

0

1

Repeat the “DAILY” schedule with the mentioned interval.

ReportSchedules/ReportSchedule/ScheduleDetail/Recurrence/Month

xs:int

0

1

The month in which the report is triggered. This is applicable to YEARLY schedule.

ReportSchedules/ReportSchedule/ScheduleDetail/Range

 

1

1

Represents the start and end dates of the period for which the schedule is triggered.

ReportSchedules/ReportSchedule/ScheduleDetail/Range/StartDate

xs:long

1

1

Time in milliseconds (from January 1, 1970 GMT 00:00) representing the schedule start date.

ReportSchedules/ReportSchedule/ScheduleDetail/Range/EndDate

xs:long

1

1

Time in milliseconds (from January 1, 1970 GMT 00:00) representing the schedule end date. If EndDate is not specified, the report schedule is triggered based on the Count parameter given below.

ReportSchedules/ReportSchedule/ScheduleDetail/Range/Count

xs:int

 

1

Number of times the report schedule is triggered.

A value of -1 means that the schedule is triggered infinite number of times.

ReportSchedules/ReportSchedule/ScheduleStatus

 

1

1

Represents the schedule status of the report schedule.

ReportSchedules/ReportSchedule/ScheduleStatus/LastRunTime

xs:long

0

1

Time in milliseconds (from January 1, 1970 GMT 00:00) when the report schedule was last run. This field will be empty for a new schedule.

ReportSchedules/ReportSchedule/ScheduleStatus/NextRunTime

xs:long

0

1

Time in milliseconds (from January 1, 1970 GMT 00:00) when the report schedule will be run next. This field will be empty if the schedule has expired.

ReportSchedules/ReportSchedule/ScheduleStatus/TaskStartTime

xs:long

1

1

Time in milliseconds (from January 1, 1970 GMT 00:00) from when the schedule is effective.

ReportSchedules/ReportSchedule/ScheduleStatus/TaskEndTime

xs:long

1

1

Time in milliseconds (from January 1, 1970 GMT 00:00) till when the schedule is effective.

ReportSchedules/ReportSchedule/ScheduleStatus/LastRunStatus

xs:string

0

1

Status of the previous run of the report schedule. Valid value is NEW, ERROR, RESCHEDULED, or SUCCESS.

NEW indicates a newly created schedule that has not been run before.

ERROR indicates that the previous run of the report schedule resulted in an error.

RESCHEDULED indicates that report was rescheduled.

SUCCESS indicates that the previous run of the report schedule was successful.

ReportSchedules/ReportSchedule/ScheduleStatus/Errors/Error

xs:int

0

unbounded

Provides details of any error in processing the request.

ReportSchedules/ReportSchedule/ScheduleStatus/Errors/Error/@majorErrorCode

xs:int

1

1

The class of the error. It represents the HTTP Status codes.

ReportSchedules/ReportSchedule/ScheduleStatus//Errors/Error/@minorErrorCode

xs:int

1

1

The API error code. For example, it can indicate that the connection to the database failed.

ReportSchedules/ReportSchedule/ScheduleStatus//Errors/Error/@message

xs:string

1

1

A one-line, human-readable message that describes the error that occurred.

ReportSchedules/ReportSchedule/Configuration

xs:complex type

0

1

Elements of this section are used in the vCenter Chargeback Manager UI to customize the look and feel of the report.

ReportSchedules/ReportSchedule/Configuration/Computation

 

0

1

Represents a complex expression that affects the computation logic of the report.

ReportSchedules/ReportSchedule/Configuration/Computation/Settings

 

0

unbounded

Every occurrence of the "Settings" element represents the configuration information for a feature.

ReportSchedules/ReportSchedule/Configuration/Computation/Settings/@type

xs:string

1

1

Type of the setting. The value currently supported is "costVariance".

ReportSchedules/ReportSchedule/Configuration/Computation/Settings/Property

 

1

unbounded

Property element that holds the property name and its value.

ReportSchedules/ReportSchedule/Configuration/Computation/Settings/Property/@name

xs:string

1

1

Represents the name of the property.

ReportSchedules/ReportSchedule/Configuration/Computation/Settings/Property/@value

xs:string

1

1

Represents the value of the property. Following are the valid properties for “costVariance”:

  • Name = enabled Values = true/false
  • Name = granularity Values = DAILY/HOURLY

ReportSchedules/ReportSchedule/Email

 

0

1

Represents the information required for sending a report schedule by email.

ReportSchedules/ReportSchedule/Email/Subject

xs:string

1

1

Subject of the email.

ReportSchedules/ReportSchedule/Email/Message

xs:string

1

1

Message body of the email.

ReportSchedules/ReportSchedule/Email/ToAddresses/EmailId

xs:string

1

1

Comma-separated email IDs of the recipients.

ReportSchedules/ReportSchedule/Email/CcAddresses/EmailId

xs:string

0

1

Comma-separated email IDs of the recipients who have been copied in the email.

A sample response is provided here.

Error Response

The following table explains the error codes displayed by the API.

Error code

Description

VCB_ERR_REP_INPUT_EMPTY_REPORT_PERIOD

The report period is not specified in the request XML for the Generate Report API.

VCB_ERR_REP_INPUT_INVALID_MD_RP_CUSTOM_DAY_IN_MILLI_SECS      

Returned if you schedule or reschedule a report with ‘Custom’ report period and the day in milliseconds element value is invalid.

VCB_ERR_REP_INPUT_INVALID_MD_RP_CUSTOM_NO_OF_DAYS             

Returned if you schedule or reschedule a report with ‘Custom’ report period and number of days element value is invalid.

VCB_ERR_REP_INPUT_INVALID_MD_RP_CUSTOM_NO_OF_DAYS_BEFORE      

Returned if you schedule or reschedule a report with ‘Custom’ report period and number of days before element value is invalid.

VCB_ERR_REP_INPUT_INVALID_MD_RP_DAILY_NO_OF_DAYS_BEFORE       

Returned if you schedule or reschedule a report with ‘Daily’ report period and number of days before element value is invalid.

VCB_ERR_REP_INPUT_INVALID_MD_RP_MONTHLY_DAY_OF_MONTH 

Returned if you schedule or reschedule a report with ‘Monthly’ report period and day of the month is invalid.

VCB_ERR_REP_INPUT_INVALID_MD_RP_WEEKLY_DAY_OF_WEEK            

Returned if you schedule or reschedule a report with ‘Weekly’ report period and if the day of the week is invalid.

VCB_ERR_REP_INPUT_INVALID_MD_RP_YEARLY_DAY_OF_MONTH           

Returned if you schedule or reschedule a report with ‘Yearly’ report period and if the day of the month is invalid.

VCB_ERR_REP_INPUT_INVALID_MD_RP_YEARLY_MONTH                  

Returned if you schedule or reschedule a report with ‘Yearly’ report period and if the value for month is invalid.

VCB_ERR_REP_INPUT_INVALID_REPORT_PERIOD_TYPE                  

Returned if the report period type is invalid while you schedule or reschedule a report with ‘Custom’ report period.

VCB_ERR_REP_INPUT_INVALID_HIERARCHY_ENTITY_ID

The hierarchy entity ID specified for the report or the report schedule is invalid.

VCB_ERR_REP_INPUT_INVALID_HIERARCHY_ID

The hierarchy ID specified for the report or the report schedule is invalid.

VCB_ERR_REP_INPUT_COST_MODEL

The cost model specified for the report or the report schedule is invalid.

VCB_ERR_REP_INPUT_INVALID_DUPLICATE_COST_MODEL

You have specified duplicate cost models while generating the Cost Comparison report.

VCB_ERR_REP_UNSUPPORTED_REPORT_PERIOD                         

You have specified an invalid report period.

VCB_ERR_REP_INPUT_INVALID_COST_MODELS_WITH_NON_UNIQUE_CURRENCY

Cost models selected while generating or scheduling a report do not have the same currency.

VCB_ERR_REST_REP_INPUT_INVALID_XML 

Request XML for the Schedule Report API is invalid.

VCB_ERR_REST_REP_XML_IO_FAILURE

Error occurred while handling the request XML for Schedule Report API.

VCB_ERR_REP_INPUT_HIERARCHY                                 

Hierarchy specified in the request XML for Generate Report API or Schedule Report API is invalid.