Documentation Center

MetaDataFilter

The metadata filter XML structure is used to specify metadata values that will be used as a filter.

XML structure

<xs:schema id="ISHFilterFields" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:element name="ishfields">
    <xs:complexType>
      <xs:sequence minOccurs="0" maxOccurs="unbounded">
        <xs:element ref="ishfield"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>
  <xs:simpleType name="mandatoryText">
    <xs:restriction base="xs:string">
      <xs:minLength value="1"/>
    </xs:restriction>
  </xs:simpleType>
  <xs:element name="ishfield">
    <xs:complexType>
      <xs:simpleContent>
        <xs:extension base="mandatoryText">
          <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="logical"/>
                <xs:enumeration value="version"/>
                <xs:enumeration value="lng"/>
                <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:attribute name="ishoperator" use="optional" default="equal">
            <xs:simpleType>
              <xs:restriction base="xs:string">
                <xs:enumeration value="equal"/>
                <xs:enumeration value="notequal"/>
                <xs:enumeration value="in"/>
                <xs:enumeration value="notin"/>
                <xs:enumeration value="like"/>
                <xs:enumeration value="greaterthan"/>
                <xs:enumeration value="lessthan"/>
                <xs:enumeration value="greaterthanorequal"/>
                <xs:enumeration value="lessthanorequal"/>
                <xs:enumeration value="between"/>
                <xs:enumeration value="empty"/>
                <xs:enumeration value="notempty"/>
              </xs:restriction>
            </xs:simpleType>
          </xs:attribute>
        </xs:extension>
      </xs:simpleContent>
    </xs:complexType>
  </xs:element>
</xs:schema>

Example

<ishfields>
	<ishfield name="FSYSTEM" level="logical">ABS</ishfield>
	<ishfield name="LANGUAGE" level="lng">NL</ishfield>
	<ishfield name="FSTATUS" level="lng" ishoperator="in">To be created, Under construction</ishfield>
</ishfields>
Note that:
  • Specifying multiple values that are allowed for a certain field can be done in a comma-space separated value list (see FSTATUS field in the example).
  • Starting from Webservices API 2.5 not all filter operators are supported on all field types. Check Behaviour of Metadata Filter Operators to see which operators are allowed for the different field types.