Schema for Report Resource

The schema for the report resource contains the following elements.

Click this link to view the XSD file.

ReportsType

Name

Type

Description

Report

ReportType

Represents the report type.

ReportType

Name

Data Type

Description

MetaData

ReportMetaDataType

Represents the meta data of the report.

ComputedData

ComputedData

Represents the summary and details of the computed data.

id

xs:int

ID of the report.

ReportMetaDataType

Includes the elements of ResourceType.

Name

Data Type

Description

ReportType

xs:string

Type of report. The valid report types are COST_REPORT, COST_COMPARISON_REPORT and UTILIZATION_REPORT.

CreatedOn

xs:long

The time (in milliseconds; from January 1, 1970 GMT 00:00) at which the report is created.

ModifiedOn

xs:long

The time (in milliseconds; from January 1, 1970 GMT 00:00) at which the report was last modified. In this release vCenter Chargeback Manager, API users cannot modify a report.

ReportPeriod

ReportPeriod

Duration for which the report is generated.

CreatedBy

xs:int

ID of the user, who has created this report.

CreatedByName

UserIdType

Name of the user, who has created this report.

ModifiedBy

xs:int

ID of the user, who last modified this report.

ModifiedByName

UserIdType

Name of the user who last modified the report.

OwnedBy

xs:int

ID of the user for whom the report is generated.

OwnedByName

UserIdType

Name of the user for whom the report is generated.

Currency

CurrencyType

ID of the currency used in the report.

TotalEntities

xs:int

Total number of entities in the hierarchy (for which the report is generated) during the report period.

TotalUniqueEntities

xs:int

The number of unique entities in the hierarchy during the report period. Even if an entity is moved among multiple parent entities during the report period, the element counts only one occurrence of the entity.

TotalCost

xs:double

The total cost of the report. This element is applicable only to Cost reports.

PageCount

xs:int

Number of pages in the report. This element is populated if the report is exported, at least once, to PDF, RTF or CSV format.

Hierarchies

ReportHierarchyType

Hierarchies for which the report is generated.

CostModels

CostModelsType

Cost models for which the report is generated.

ComputingResources

ComputingResourcesType

Computing resource for which the report is generated.

ReportPeriod

Name

Type

Description

From

xs:long

The start time (in milliseconds from January 1, 1970 GMT 00:00) of the duration for which the report is generated.

To

xs:long

The end time (in milliseconds from January 1, 1970 GMT 00:00) of the duration for which the report is generated.

ComputedData

Name

Type

Description

EntitySummary

EntitySummary

Represents the summary information about an entity.

EntityDetail

EntityDetail

Represents detailed information about an entity.

EntitySummary

Name

Type

Description

Entity

ReportEntitySummaryType

Represents the report entity for which the section provides summary information.

EntityDetail

Name

Type

Description

Entity

ReportEntityDetailType

Represents the entity for which the section provides detailed information.

ReportEntitySummaryType

Name

Type

Description

Name

NameType

Name of the entity for which the report provides information.

Type

xs:int

Type of the entity for which the report provides information. For more information on the entity types, see the Appendix.

Parent

xs:int

Parent of the entity.

ChildEntityInfos

ChildEntityInfos

Represents the information about the child entities of the given entity.

CostModel

CostModel

Represents the cost model used to calculate the cost of the entity.

id

xs:int

ID of the entity.

parentReportEntityId

xs:int

Report entity ID of the parent entity for the given entity.

reportEntityId

xs:int

Unique ID of the entity in the hierarchical path for a given report.

ChildEntityInfos

Name

Type

Description

ChildEntityInfo

ChildEntityInfo

Represents the information about the child entities of the given entity.

ChildEntityInfo

Name

Type

Description

type

xs:string

Type of the child entity information. Valid values are immediateChildEntityCount and entityCountByType.

id

xs:int

ID of the child entity. This attribute is applicable only to entityCountByType.

CostModel

Name

Type

Description

Name

NameType

Name of the cost model.

EntityCost

xs:double

Cost of the entity.

TotalCost

xs:double

Total cost of the entity and its child entities.

Resources

Resources

Represents the computing resource, its usage and cost details for the given entity.

FixedCosts

FixedCosts

Represents the fixed cost for the report entity for the given report duration.

Resources

Name

Type

Description

Name

NameType

Represents the name of the cost model.

Usage

xs:double

Represents the usage details for an entity and its child entities.

Cost

xs:double

Cost of the computing resource for this report entity for the given report duration. This element will be blank for Usage report.

id

 

ID of the computing resource.

FixedCosts

Name

Type

Description

FixedCost

xs:double

Fixed cost for the entity for the given report duration.

id

xs:int

ID of the entity.

ReportEntityDetailType

Name

Type

Description

Name

NameType

Name of the entity.

Type xs:int

Type of the entity. For information on various entity types, see Appendix.

Parents Parent

Represents the parent entities of the given entity for the report duration.

id xs:int

ID of the parent entity.

Parent

Name

Type

Description

Name

NameType

Name of the parent entity.

Type

xs:int

Type of the parent entity. For information on various entity types, see Appendix.

CostModel

CostModel

Cost model used to calculate the cost.

CostModel

Name

Type

Description

Name

NameType

Represents the name of the cost model.

EntityCost

xs:double

Represents the cost for an entity.

TotalCost

xs:double

Represents the total cost for an entity and its child entities.

Messages

Messages

Represents the messages for an entity and its child entities.

Resources

Resource

Represents the resources for an entity and its child entities.

FixedCosts

FixedCosts

Represents the fixed cost for an entity and its child entities.

Messages

Name

Type

Description

Message

xs:string

Human readable message applicable for this entity.

priority

xs:string

Priority of the message. Can be INFO or CRITICAL.

Resource

Name

Type

Description

Name

NameType

Name of the computing resource

Details

Details

Represents the computing resource details.

id

xs:int

ID of the duration applicable from the given start time to the end time. For more details on the duration, see the Appendix.

Details

Name

Type

Description

Detail

Detail

Represents the details of a resource.

Detail

Name

Type

Description

StartTime

xs:long

Start time of the duration for which the Details section is applicable.

EndTime

xs:long

End of the duration for which the Details section is applicable.

AttributionPercent

xs:double

Attribution percent applicable to the computing resource from the given start time to the end time.

Duration

Duration

Duration applicable from the given start time to the end time. For more details on the duration, see the Appendix.

Cost

xs:double

Cost applicable to the computing resource from the given start time to the end time.

Slabs

Slabs

Represents the details of each base rate and rate factor set for a computing resource for a given duration.

Slabs

Name

Type

Description

Slabs

Slab

Represents the details of a base rate and rate factor set for a computing resource.

Slab

Name

Type

Description

RateFactor

RateFactor

Rate factor applicable to the computing resource from the given start time to the end time.

baseRate

xs:double

Base rate applicable to the computing resource from the given start time to the end time.

RateFactor

Name

Type

Description

Usage

xs:double

Actual usage of the computing resource from the given start time to the end time.

value

xs:double

Rate factor value for the computing resource from the given start time to the end time.

FixedCosts

Name

Type

Description

BaseRate

xs:double

Base rate applicable to the fixed cost from the given start time to the end time.

RateFactor

xs:double

Rate factor applicable to the fixed cost from the given start time to the end time.

StartTime

xs:long

Start time of the duration for which the Details section is applicable.

EndTime

xs:long

The end time of the duration for which the Details section is applicable.

AttributionPercent

xs:double

Attribution percent applicable to the fixed cost from the given start time to the end time.

Cost

xs:double

Cost applicable to the fixed cost from the given start time to the end time.

Usage

xs:double

Usage details of a given computing resource.

Resource

xs:string

The computing resource for which this utilization cost is calculated.

Duration

Duration

Duration applicable from the given start time to the end time. For more details on the duration, see the Appendix.

Duration

Name

Type

Description

id

xs:string

ID of the duration applicable from the given start time to the end time. For more details on the duration, see the Appendix.