Home > Cloud Cruiser 4 > REST API reference > Lookup tables > Import a lookup table from CSV

Import a lookup table from CSV

Creates or updates a lookup table specified by title by importing data in CSV format as a new effective date range.

Resource URL

In version 4.0: POST http://<ccServerURL>/rest/v2/lookups/import/<title>

In version 4.1 and later: POST http://<ccServerURL>/rest/v2/lookups/import

Request

Parameters
Version 4.0
Version 4.1 and later

For Cloud Cruiser 4.1, use the following parameters:

  Name Type Description
Header parameters (optional) updateDuplicates boolean Specifies whether to update duplicate table revisions if a lookup table with the same title already exists. Default is false.
title string The title of the lookup table to create or update.
description string The description to set for the lookup table.
startDate string The starting date for the new effective date range of the table, in yyyyMMdd format. Default is today's date.
endDate string The ending date for the new effective date range of the table, in yyyyMMdd format. Default is 29991231.
Content-Type

text/csv

Body

The lookup table, in Lookup table CSV file format.

Response

Content-Type

application/xml

Body

The results of the import, as XML text with a root element of type itemImportResult or JAXB type com.cloudcruiser.server.webservices.v2.dto.common.ItemImportResult​. The results specify which records were created, updated, and duplicate.

Schema

Version 4.0
Version 4.1 and later

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>

Example

URL invocation

POST http://localhost:8080/rest/v2/lookups/import

Java invocation
Request body
,,001,Micro VM
,,002,Small VM
,,004,Medium VM
,,008,Large VM
,,,Extra Large VM
Response body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<itemImportResult xmlns="http://www.cloudcruiser.com/webservices/v2/Common">
  <importedSummary>
    <totalItems>5</totalItems>
    <newItems>5</newItems>
    <duplicateItems>0</duplicateItems>
    <updatedItems>0</updatedItems>
  </importedSummary>
  <newItemNames>
    <newItemName></newItemName>
    <newItemName></newItemName>
    <newItemName></newItemName>
    <newItemName></newItemName>
    <newItemName></newItemName>
  </newItemNames>
</itemImportResult>
Last modified

Tags

Classifications

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