Home > 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>​

Request

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

None

Response

Content-Type

application/xml

Body

The report names, as XML text with a root element of type reportNames or JAXB type com.cloudcruiser.server.webservices.v1.dto.report.ReportNames.

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.

Schema

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="http://www.w3.org/2001/XMLSchema" xmlns="http://www.cloudcruiser.com/webservices/v2/Report" xmlns:ns1="http://www.cloudcruiser.com/webservices/v2/Common" attributeFormDefault="unqualified"elementFormDefault="qualified" targetNamespace="http://www.cloudcruiser.com/webservices/v2/Report">
  <xs:import/>
  <xs:import namespace="http://www.cloudcruiser.com/webservices/v2/Common"/>
    <xs:element name="reportInput">
      <xs:complexType>
        <xs:sequence>
          <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:complexType>
              <xs:sequence>
                <xs:element maxOccurs="unbounded" name="param">
                  <xs:complexType>
                    <xs:sequence/>
                    <xs:attribute name="key" type="xs:string" use="required"/>
                    <xs:attribute name="value" type="xs:string" use="required"/>
                  </xs:complexType>
                </xs:element>
              </xs:sequence>
            </xs:complexType>
          </xs:element>
        </xs:sequence>
      </xs:complexType>
    </xs:element>
    <xs:element name="reportNames">
      <xs:complexType>
        <xs:sequence>
          <xs:element maxOccurs="unbounded" minOccurs="0" name="reportName" type="xs:string"/>
        </xs:sequence>
        <xs:attribute name="totalCount" type="xs:int"/>
        <xs:attribute name="retrievedCount" type="xs:int"/>
      </xs:complexType>
    </xs:element>
</xs:schema>

Example

URL invocation

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

Response body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<reportNames 
    xmlns="http://www.cloudcruiser.com/webservices/v2/Report" totalCount="9" retrievedCount="2">
    <reportName>InvoiceWithTiers</reportName>
    <reportName>Invoice_ResourceDetail</reportName>
</reportNames>
Last modified

Tags

Classifications

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