Documentation Center

Annotation ObjectList XML Structure

The XML structure containing a list of annotations (and replies).

XML structure

<?xml version="1.0" encoding="utf-8" ?>
<xs:schema id="ISHObjects-Annotation" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="ishobjects">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="ishobject"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <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="ishannotationref" use="required" type="CardId"/>
      <xs:attribute name="ishreplyref" use="optional" type="CardId"/>
      <xs:attribute name="ishtype" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="ISHNotFound"/>
            <xs:enumeration value="ISHAnnotation"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
    </xs:complexType>
  </xs:element>
  <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:attribute name="name" use="required" type="ElementName"/>
          <xs:attribute name="level" use="required" type="IshLevel"/>
          <xs:attribute name="ishvaluetype" use="optional" type="IshValueType"/>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>
  <xs:simpleType name ="IshLevel">
    <xs:restriction base="xs:string">
      <xs:enumeration value="annotation"/>
      <xs:enumeration value="reply"/>
    </xs:restriction>
  </xs:simpleType>
  <xs:simpleType name="IshValueType">
    <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:simpleType name="ElementName">
    <xs:restriction base="xs:string">
      <xs:minLength value="1"/>
      <xs:maxLength value="255" />
    </xs:restriction>
  </xs:simpleType>
</xs:schema>

Example

<ishobjects>
    <ishobject ishtype='ISHAnnotation' ishref='GUID-667E6C27-BC54-4B38-A7BB-AE841ADACBB5' ishannotationref='1245'>
        <ishfields>
            <ishfield name='CREATED-ON' level='annotation'>01/02/2019 10:05:36</ishfield>
            <ishfield name='MODIFIED-ON' level='annotation'>01/02/2019 10:05:36</ishfield>
            <ishfield name='FISHLASTMODIFIEDON' level='annotation'>02/02/2019 08:30:40</ishfield>
            <ishfield name='FISHLASTMODIFIEDBY' level='annotation'>Admin</ishfield>
            <ishfield name='FISHANNOTATIONTYPE' level='annotation'>General</ishfield>
            <ishfield name='FISHANNOTATIONTEXT' level='annotation'>Oracle 12.2 is supported and Oracle 12.1 is deprecated</ishfield>
            <ishfield name='FISHANNOTPROPOSEDCHNGTXT' level='annotation'>Replace 'Oracle 12.1' with 'Oracle 12.2'</ishfield>
            <ishfield name='FISHANNOTRESOLUTIONTEXT' level='annotation'>'Oracle 12.1' is replaced by 'Oracle 12.2'</ishfield>
            <ishfield name='FISHCONTENTOBJLOGICALID' level='annotation'>GUID-667E6C27-BC54-4B38-A7BB-AE841ADACBB4</ishfield>
            <ishfield name='FISHCONTENTOBJECTVERSION' level='annotation'>16</ishfield>
            <ishfield name='FISHCONTENTOBJECTLANGUAGE' level='annotation'>en</ishfield>
            <ishfield name='FISHREVISIONID' level='annotation'>GUID-617E6C27-BC54-4B38-A7BB-AC95KADACFF6</ishfield>
            <ishfield name='FISHPUBLOGICALID' level='annotation'>GUID-8BDFFB06-C520-464D-8BBF-D855D9D6A003</ishfield>
            <ishfield name='FISHPUBVERSION' level='annotation'>1.1.2</ishfield>
            <ishfield name='FISHANNOTATIONSTATUS' level='annotation' ishvaluetype='element'>VANNOTATIONSTATUSRESOLVED</ishfield>
            <ishfield name='FISHANNOTATIONADDRESS' level='annotation'>....</ishfield>
        </ishfields>
    </ishobject>
    <ishobject ishtype='ISHAnnotation' ishref='GUID-667E6C27-BC54-4B38-A7BB-AE841ADACBB6' ishannotationref='4589' ishreplyref='8956'>
        <ishfields>
            <ishfield name='CREATED-ON' level='annotation'>08/03/2019 08:30:00</ishfield>
            <ishfield name='MODIFIED-ON' level='annotation'/>
            <ishfield name='FISHLASTMODIFIEDON' level='annotation'/>
            <ishfield name='FISHLASTMODIFIEDBY' level='annotation'/>
            <ishfield name='FISHANNOTATIONTEXT' level='annotation'>In all Oracle entries you see big version numbers, and the latter is only 12.2... we need more accuracy on the test version</ishfield>
            <ishfield name='FISHANNOTATIONCREATOR' level='annotation' ishvaluetype='value'>Dave De Meyer</ishfield>
            <ishfield name='FISHCONTENTOBJLOGICALID' level='annotation'>GUID-667E6C27-BC54-4B38-A7BB-AE841ADACBB4</ishfield>
            <ishfield name='FISHCONTENTOBJECTVERSION' level='annotation'>16</ishfield>
            <ishfield name='FISHCONTENTOBJECTLANGUAGE' level='annotation'>en</ishfield>
            <ishfield name='FISHREVISIONID' level='annotation'>GUID-617E6C27-BC54-4B38-A7BB-AC95KADACFF6</ishfield>
            <ishfield name='FISHPUBLOGICALID' level='annotation'>GUID-8BDFFB06-C520-464D-8BBF-D855D9D6A003</ishfield>
            <ishfield name='FISHPUBVERSION' level='annotation'>1.1.2</ishfield>
            <ishfield name='FISHANNOTATIONSTATUS' level='annotation' ishvaluetype='element'>VANNOTATIONSTATUSUNSHARED</ishfield>
            <ishfield name='FISHANNOTATIONADDRESS' level='annotation'>....</ishfield>
            <ishfield name='CREATED-ON' level='reply'>10/03/2019 08:30:00</ishfield>
            <ishfield name='MODIFIED-ON' level='reply'/>
            <ishfield name='FISHANNOTATIONTEXT' level='reply'>Can you give me what the correct value should be?</ishfield>
            <ishfield name='FISHANNOTATIONCREATOR' level='reply' ishvaluetype='value'>Yves Pierrot</ishfield>
        </ishfields>
    </ishobject>
</ishobjects>