Documentation Center

Folder Metadata XML

When the metadata is retrieved from a folder, the following XML structure with the metadata of the folder is returned.

XML structure

<xs:schema id="ISHFolder" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="ishfolder">
    <xs:complexType>
      <xs:choice maxOccurs="unbounded">
        <xs:element ref="ishfields" minOccurs="1" maxOccurs="1"/>
      </xs:choice>
      <xs:attribute name="ishfolderref" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:long">
            <xs:minInclusive value="0"/>
            <xs:maxInclusive value="9999999999"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>
      <xs:attribute name="ishfoldertype" use="required">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="ISHNone"/>
            <xs:enumeration value="ISHModule"/>
            <xs:enumeration value="ISHMasterDoc"/>
            <xs:enumeration value="ISHLibrary"/>
            <xs:enumeration value="ISHTemplate"/>
            <xs:enumeration value="ISHIllustration"/>
            <xs:enumeration value="ISHPublication"/>
            <xs:enumeration value="ISHReference"/>
            <xs:enumeration value="ISHQuery"/>
          </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">
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:maxLength value="255"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
          <xs:attribute name="level" use="required">
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:enumeration value="none"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
          <xs:attribute name="ishvaluetype" use="optional">
            <xs:simpleType>
              <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:attribute>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>
</xs:schema>

Example

<ishfolder ishfolderref="3222" ishfoldertype="ISHNone">
  <ishfields>
    <ishfield name="FNAME" level="none">General</ishfield>
    <ishfield name="FDOCUMENTTYPE" level="none">None</ishfield>
    <ishfield name="CREATED-ON" level="none">05/04/2002 15:45:06</ishfield>
    <ishfield name="MODIFIED-ON" level="none">25/06/2008 13:42:32</ishfield>
    <ishfield name="FISHQUERY" level="none" />
    <ishfield name="FUSERGROUP" level="none" />
    <ishfield name="READ-ACCESS" level="none" />
  </ishfields>
</ishfolder>