Consumption Analytics Documentation

Home > Documentation for older versions > Cloud Cruiser 4 > REST API reference > Reports > Get report names

Get report names

Retrieves all the standard report names available in your Cloud Cruiser system or only the report names matching a pattern specified as a regular expression.

Resource URL

GET http://<ccServerURL>/rest/v2/reports/names?pattern=<pattern>​


  Name Type Description
URL query parameters (optional) pattern string A regular expression. When specified, only reports whose names match this pattern are returned.






The report names, as XML text with a root element of type reportNames or JAXB type

The names returned are internal names that do not match the names in the Standard Reports page of the Cloud Cruiser Portal, but you should be able to map one to the other. The internal names can use old terminology such as resource and identifier.


Version 4.2.6 and earlier
Version 4.2.7 and later

For Cloud Cruiser 4.2.7 and later, this XML schema defines input for running standard reports and generating a list of reports.

<xs:schema xmlns:xs="" xmlns="" xmlns:ns1="" attributeFormDefault="unqualified"elementFormDefault="qualified" targetNamespace="">
  <xs:import namespace=""/>
    <xs:element name="reportInput">
          <xs:element name="reportName" type="xs:string"/>
          <xs:element minOccurs="0" name="format" type="xs:string"/>
          <xs:element minOccurs="0" name="dateRange" type="xs:string"/>
          <xs:element minOccurs="0" name="locale" type="xs:string"/>
          <xs:element minOccurs="0" name="accountLevel" type="xs:short"/>
          <xs:element minOccurs="0" name="accountView" type="xs:short"/>
          <xs:element minOccurs="0" name="accountFieldValues" type="xs:string"/>
          <xs:element minOccurs="0" name="accountingYear" type="xs:string"/>
          <xs:element minOccurs="0" name="accountingPeriod" type="xs:string"/>
          <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:element maxOccurs="unbounded" name="param">
                    <xs:attribute name="key" type="xs:string" use="required"/>
                    <xs:attribute name="value" type="xs:string" use="required"/>
    <xs:element name="reportNames">
          <xs:element maxOccurs="unbounded" minOccurs="0" name="reportName" type="xs:string"/>
        <xs:attribute name="totalCount" type="xs:int"/>
        <xs:attribute name="retrievedCount" type="xs:int"/>


URL invocation

GET http://localhost:8080/rest/v2/reports/names?pattern=Invoice.*

Response body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    xmlns="" totalCount="9" retrievedCount="2">
Last modified



This page has no classifications.

 (c) Copyright 2017-2020 Hewlett Packard Enterprise Development LP