Documentation Center

TranslationJob ObjectList XML Structure

The XML structure containing a list of translation jobs.

XML structure

<?xml version="1.0" encoding="utf-8" ?>
<xs:schema id="ISHObjects-TranslationJob" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:simpleType name="MandatoryText">
    <xs:restriction base="xs:string">
      <xs:minLength value="1"/>
    </xs:restriction>
  </xs:simpleType>
  <xs:simpleType name="ElementName">
    <!-- The element name of an object (Field, Lov, Card,...) -->
    <xs:restriction base="MandatoryText">
      <xs:maxLength value="255" />
    </xs:restriction>
  </xs:simpleType>
  <xs:simpleType name="IshValueType">
    <!-- The requested type of the fieldvalue -->
    <xs:restriction base="xs:string">
      <xs:enumeration value=""/>
      <xs:enumeration value="value"/>
      <xs:enumeration value="element"/>
      <xs:enumeration value="id"/>
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="ishfields">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="ishfield"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:element name="ishfield">
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base="xs:string">
          <xs:attributeGroup ref="FieldAttributeGroup"/>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>
  <xs:attributeGroup name="FieldAttributeGroup">
    <xs:attribute name="name" use="required" type="ElementName"/>
    <xs:attribute name="level" use="required" type="IshLevel"/>
    <xs:attribute name="ishvaluetype" use="optional" type="IshValueType"/>
  </xs:attributeGroup>
  <xs:simpleType name ="IshLevel">
    <!-- The level of the ishfield -->
    <xs:restriction base="xs:string">
      <xs:enumeration value="none"/>
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="ishobjects">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="ishobject"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:simpleType name="LogicalId">
    <!-- The element name of the logical level of the object -->
    <xs:restriction base="ElementName"/>
  </xs:simpleType>
  <xs:simpleType name="CardId">
    <!-- The unique identifier of the card -->
    <xs:restriction base="xs:long">
      <xs:minInclusive value="0"/>
      <xs:maxInclusive value="9999999999"/>
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="ishobject">
    <xs:complexType>
      <xs:choice>
        <xs:element ref="ishfields" minOccurs="0" maxOccurs="1"/>
      </xs:choice>
      <xs:attribute name="ishref" use="required" type="LogicalId"/>
      <xs:attribute name="ishtranslationjobref" use="required" type="CardId"/>
      <xs:attribute name="ishtype" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="ISHNotFound"/>
            <xs:enumeration value="ISHTranslationJob"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
    </xs:complexType>
  </xs:element>
</xs:schema>
      

Example

<?xml version="1.0" encoding="utf-16"?>
<ishobjects>
  <ishobject ishref="GUID-84D9378C-DE91-4BA8-A9D7-9B22720B60CE" ishtype="ISHTranslationJob" ishtranslationjobref="12634">
    <ishfields>
      <ishfield name="FNAME" level="none" xml:space="preserve" ishvaluetype="value">My translation job</ishfield>
      <ishfield name="FDESCRIPTION" level="none" xml:space="preserve" ishvaluetype="value">Description of the job</ishfield>
      <ishfield name="FISHTRANSJOBSTATUS" level="none" xml:space="preserve" ishvaluetype="element">VTRANSJOBSTATUSREADYFORTRANSLATION</ishfield>
      <ishfield name="FISHTRANSJOBSENTOUTBY" level="none" xml:space="preserve" ishvaluetype="element">VUSERADMIN</ishfield>
      <ishfield name="FISHTRANSJOBSRCLNG" level="none" xml:space="preserve" ishvaluetype="value">en</ishfield>
      <ishfield name="FISHTRANSJOBTRANSTEMPLID" level="none" xml:space="preserve" ishvaluetype="value">1020:1001</ishfield>
      <ishfield name="FISHTRANSJOBREQUIREDDATE" level="none" xml:space="preserve" ishvaluetype="value">01/01/2013 00:00:00</ishfield>
      <ishfield name="FISHTRANSJOBINCLTRANSLTD" level="none" xml:space="preserve" ishvaluetype="element">TRUE</ishfield>
      <ishfield name="FISHTRANSJOBTARGETFIELDS" level="none" xml:space="preserve" ishvaluetype="value">
&lt;ishfields&gt;
    &lt;ishfield name='FCOMMENTS' level='lng'&gt;Some comments&lt;/ishfield&gt;
    &lt;ishfield name='FTRANSLATOR' level='lng'&gt;admin&lt;/ishfield&gt;
&lt;/ishfields&gt;</ishfield>
      <ishfield name="FISHTRANSJOBPROGRESSID" level="none" xml:space="preserve" ishvaluetype="value" />
      <ishfield name="FISHPUSHTRANSPROGRESSIDS" level="none" xml:space="preserve" ishvaluetype="value" />
      <ishfield name="FISHTRANSJOBTYPE" level="none" xml:space="preserve" ishvaluetype="element">VTRANSJOBTYPEWS</ishfield>
      <ishfield name="FISHLEASEDBY" level="none" xml:space="preserve" ishvaluetype="value" />
      <ishfield name="FISHLEASEDON" level="none" xml:space="preserve" ishvaluetype="value" />
      <ishfield name="CREATED-ON" level="none" xml:space="preserve" ishvaluetype="value">05/11/2012 17:24:28</ishfield>
      <ishfield name="MODIFIED-ON" level="none" xml:space="preserve" ishvaluetype="value">05/11/2012 17:24:29</ishfield>
      <ishfield name="FISHMAXIMUMPROGRESS" level="none" xml:space="preserve" ishvaluetype="value" />
      <ishfield name="FISHCURRENTPROGRESS" level="none" xml:space="preserve" ishvaluetype="value" />
    </ishfields>
  </ishobject>
</ishobjects>