Cloud Cruiser became HPE Consumption Analytics on Nov. 1st. You'll still see the old name in places while we update this site.

 

 

Consumption Analytics Documentation

Home > Cloud Cruiser 3 > REST API reference > Reports > XML schemas > reportInput schema

reportInput schema

Table of contents
No headers

This XML schema describes the input for running a standard report.

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://www.cloudcruiser.com/webservices/v1/Report" targetNamespace="http://www.cloudcruiser.com/webservices/v1/Report">
<xs:element name="reportInput" type="tns:ReportInput"/>
<xs:complexType name="ReportInput">
  <xs:sequence>
    <!‐‐ Required element, may use getReportNames API to retrieve/query ‐‐>
    <!‐‐ the available report names. ‐‐>
    <xs:element name="reportName" type="xs:string"/>
    <!‐‐ Required element ‐‐>
    <xs:element name="userGroupName" type="xs:string"/>
    <!‐‐ The valid values are "PDF", "XLS" and "CSV". The default is "PDF". ‐‐>
    <xs:element minOccurs="0" name="format" type="reportJobFormatType"/>
    <!‐‐ See dateRangeType for valid values. The default is "PREVPERIOD" ‐‐>
    <!‐‐ If accountingYear or accountingPeriod is set, dateRange cannot be set. ‐‐>
    <xs:element minOccurs="0" name="dateRange" type="dateRangeType"/>
    <!‐‐ The default value is 0 ‐‐>
    <xs:element minOccurs="0" name="accountLevel" type="xs:short"/>
    <!‐‐ The default value is 0 ‐‐>
    <xs:element minOccurs="0" name="accountStructure" type="xs:short"/>
    <!‐‐ The default value is "lowest" ‐‐>
    <xs:element minOccurs="0" name="accountRangeStart" type="xs:string"/>
    <!‐‐ The default value is "highest" ‐‐>
    <xs:element minOccurs="0" name="accountRangeEnd" type="xs:string"/>
    <!‐‐ accountingYear/accountingPeriod and dateRange cannot be set at the same time
    <xs:element minOccurs="0" name="accountingYear" type="xs:string"/>
    <xs:element minOccurs="0" name="accountingPeriod" type="xs:string"/>
    <!‐‐ The default value is 1 ‐‐>
    <xs:element minOccurs="0" name="accountingDay" type="xs:short"/>
    <xs:element minOccurs="0" name="customStartDate" type="ns1:Date"/>
    <xs:element minOccurs="0" name="customEndDate" type="ns1:Date"/>
    <xs:element minOccurs="0" name="extraParameters">
  </xs:sequence>
</xs:complexType>
<xs:simpleType name="reportJobFormatType">
  <xs:restriction base="xs:string">
    <xs:enumeration value="PDF"/>
    <xs:enumeration value="XLS"/>
    <xs:enumeration value="CSV"/>
    </xs:restriction>
</xs:simpleType>
<xs:simpleType name="dateRangeType">
  <xs:restriction base="xs:string">
    <xs:enumeration value="ALL"/>
    <xs:enumeration value="CURRPERIOD"/>
    <xs:enumeration value="PREVPERIOD"/>
    <xs:enumeration value="CURRMON"/>
    <xs:enumeration value="MONTHTODATE"/>
    <xs:enumeration value="PREVMON"/>
    <xs:enumeration value="CURRYEAR"/>
    <xs:enumeration value="YEARTODATE"/>
    <xs:enumeration value="PREVYEAR"/>
    <xs:enumeration value="TODAY"/>
    <xs:enumeration value="PREVTODAY"/>
    <xs:enumeration value="CURRWEEK"/>
    <xs:enumeration value="WEEKTODATE"/>
    <xs:enumeration value="PREVWEEK"/>
    <xs:enumeration value="CUSTOM"/>
  </xs:restriction>
</xs:simpleType>
</xs:schema>
Last modified

Tags

Classifications

This page has no classifications.
© Copyright 2018 Hewlett Packard Enterprise Development LP