Home > Cloud Cruiser 3 > REST API reference > Translation tables > Get a translation table by ID

Get a translation table by ID

Retrieves a translation table specified by its ID.

Resource URL

GET http://<ccServerURL>/rest/v1/translations/id/<id>

Request

Parameters
  Name Type Description
URL path parameters (required) id integer The ID of the table to retrieve
URL query parameters (optional) None
Body

None

Response

Content-Type

application/xml

Body

The translation table, as XML text with a root element of type translation or JAXB type com.cloudcruiser.server.webservices.v1.dto.translate.Translation.

Schema

This XML schema describes one or more translation tables.

<xs:element name="translations" type="tns:Translations"/>
<xs:complexType name="Translations">
  <xs:sequence>
    <xs:element maxOccurs="unbounded" minOccurs="0" ref="tns:translation"/>
  </xs:sequence>
  <xs:attribute name="count" type="xs:int"/>
</xs:complexType>
<xs:element name="translation" type="tns:Translation"/>
<xs:complexType name="Translation">
  <xs:sequence>
    <xs:element name="title" type="xs:string"/>
    <xs:element minOccurs="0" name="description" type="xs:string"/>
    <xs:element maxOccurs="unbounded" name="revision" type="tns:Revision"/>
  </xs:sequence>
  <xs:attribute name="id" type="xs:int"/>
</xs:complexType>
<xs:complexType name="Revision">
  <xs:sequence>
    <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="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>

Example
URL invocation

GET http://localhost:8080/rest/v1/translations/id/2

Java invocation

Translation translation = translateServiceProxy.getTranslationById(2);

Request body

None

Response body
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<translation id="2">
  <title>alternate</title>
  <description>Alternate translation table</description>
  <revision id="10000">
    <startDate year="2013" month="11" day="25"/>
    <endDate year="2999" month="12" day="31"/>
    <detailTable entryCount="50">
      <entry order="1">
        <lowId>ak</lowId>
        <highId></highId>
        <targetId>B-AA-KKKK-11</targetId>
      </entry>
      <entry order="2">
        <lowId>al</lowId>
        <highId></highId>
        <targetId>B-AA-LLLL-11</targetId>
      </entry>
      ...
    </detailTable>
  </revision>
</translation>
Last modified

Tags

Classifications

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