 |
Consumption Analytics Documentation |
|
Consumption Analytics Documentation |
Retrieves a lookup table specified by its title.
This method of retrieving a lookup table by its title is used with Cloud Cruiser version 4.0. For version 4.1 and later, use the title query parameter of the general get method. For more information, see Get lookup tables.
GET http://<ccServerURL>/rest/v2/lookups/title/<title>
| Name | Type | Description | |
|---|---|---|---|
| URL path parameters (required) | title | string | The title of the table to retrieve |
None
application/xml
The contents of the lookup table, as XML text with a root element of type lookup or JAXB type com.cloudcruiser.server.webservices.v2.dto.Lookup.lookup.
For Cloud Cruiser 4.1 and later, this XML schema describes one or more lookup tables.
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="http://www.cloudcruiser.com/webservices/v2/Common" xmlns:tns="http://www.cloudcruiser.com/webservices/v2/Lookup"attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://www.cloudcruiser.com/webservices/v2/Lookup">
<xs:import namespace="http://www.cloudcruiser.com/webservices/v2/Common"/>
<xs:element name="lookupTable" type="tns:LookupTable"/>
<xs:element name="lookupTableList" type="tns:LookupTableList"/>
<xs:element name="revision" type="tns:Revision"/>
<xs:element name="revisions" type="tns:Revisions"/>
<xs:complexType name="DetailTable">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="entry" type="tns:DetailEntry"/>
</xs:sequence>
<xs:attribute name="entryCount" type="xs:int"/>
</xs:complexType>
<xs:complexType name="DetailEntry">
<xs:sequence>
<xs:element minOccurs="0" name="expression" type="xs:string"/>
<xs:element minOccurs="0" name="lowId" type="xs:string"/>
<xs:element minOccurs="0" name="highId" type="xs:string"/>
<xs:element name="targetId" type="xs:string"/>
</xs:sequence>
<xs:attribute name="order" type="xs:short"/>
</xs:complexType>
<xs:complexType name="LookupTable">
<xs:sequence>
<xs:element name="title" type="xs:string"/>
<xs:element minOccurs="0" name="description" type="xs:string"/>
<xs:element ref="tns:revisions"/>
</xs:sequence>
<xs:attribute name="id" type="xs:int"/>
</xs:complexType>
<xs:complexType name="Revisions">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:revision"/>
</xs:sequence>
</xs:complexType>
<xs:complexType name="Revision">
<xs:sequence>
<xs:element name="LookupTable">
<xs:complexType>
<xs:sequence/>
<xs:attribute name="title" type="xs:string" use="required"/>
<xs:attribute name="id" type="xs:int" use="required"/>
</xs:complexType>
</xs:element>
<xs:element name="startDate" type="ns1:Date"/>
<xs:element name="endDate" type="ns1:Date"/>
<xs:element name="detailTable" type="tns:DetailTable"/>
</xs:sequence>
<xs:attribute name="id" type="xs:int"/>
</xs:complexType>
<xs:complexType name="LookupTableList">
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:lookupTable"/>
</xs:sequence>
<xs:attribute name="totalTables" type="xs:int"/>
<xs:attribute name="retrievedTables" type="xs:int"/>
</xs:complexType>
</xs:schema>
GET http://localhost:8080/rest/v2/lookups/title/san2
None
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<lookup
xmlns="http://www.cloudcruiser.com/webservices/v2/Lookup" id="6">
<title>san2</title>
<description></description>
<revision id="8">
<startDate year="2011" month="12" day="1"/>
<endDate year="2999" month="12" day="31"/>
<detailTable entryCount="6">
<entry order="1">
<lowId>a</lowId>
<highId></highId>
<targetId>B-AA-KKKK-11</targetId>
</entry>
<entry order="2">
<lowId>b</lowId>
<highId></highId>
<targetId>B-AA-LLLL-11</targetId>
</entry>
<entry order="3">
<lowId>c</lowId>
<highId></highId>
<targetId>B-AA-MMMM-11</targetId>
</entry>
<entry order="4">
<lowId>d</lowId>
<highId></highId>
<targetId>B-AA-NNNN-11</targetId>
</entry>
<entry order="5">
<lowId>e</lowId>
<highId></highId>
<targetId>B-AA-OOOO-11</targetId>
</entry>
<entry order="6">
<lowId></lowId>
<highId>z</highId>
<targetId>B-BB-KKKK-11</targetId>
</entry>
</detailTable>
</revision>
</lookup>