Filter Data XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace None
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations have no namespace.
  • By default, local attribute declarations have no namespace.
Documentation This schema is for filtering the results of a data request.

Declared Namespaces

Prefix Namespace
xml http://www.w3.org/XML/1998/namespace
xsd http://www.w3.org/2001/XMLSchema
Schema Component Representation
<xsd:schema>
...
</xsd:schema>
top

Global Declarations

Element: request

Name request
Type filterdatarequest
Nillable no
Abstract no
Documentation Root element. Specifies a data request.
XML Instance Representation
<request>
Start All [1]
<objectstore> xsd:string </objectstore> [1] ?
<folderid> guidString </folderid> [1] ?
<filterclauses> filterclausesType </filterclauses> [1] ?
End All
</request>
Schema Component Representation
<xsd:element name="request" type="filterdatarequest"/>
top

Global Definitions

Complex Type: contentcriteriaType

Super-types: None
Sub-types: None
Name contentcriteriaType
Abstract no
Documentation Specifies the criteria for a content search.
XML Instance Representation
<...>
Start All [1]
<contentstring> xsd:string </contentstring> [1] ?
<join> joinType </join> [1] ?
End All
</...>
Schema Component Representation
<xsd:complexType name="contentcriteriaType">
<xsd:all>
<xsd:element name="contentstring" type="xsd:string"/>
<xsd:element name="join" type="joinType"/>
</xsd:all>
</xsd:complexType>
top

Complex Type: filterclassType

Super-types: None
Sub-types: None
Name filterclassType
Abstract no
Documentation Specifies a filter class.
XML Instance Representation
<...>
Start All [1]
<classname> xsd:string </classname> [1] ?
<includesubclasses> yesnoType </includesubclasses> [1] ?
<join> joinType </join> [1] ?
End All
</...>
Schema Component Representation
<xsd:complexType name="filterclassType">
<xsd:all>
<xsd:element name="classname" type="xsd:string"/>
<xsd:element name="includesubclasses" type="yesnoType"/>
<xsd:element name="join" type="joinType"/>
</xsd:all>
</xsd:complexType>
top

Complex Type: filterclauseType

Super-types: None
Sub-types: None
Name filterclauseType
Abstract no
Documentation Specifies a filter for a specific object type.
XML Instance Representation
<...>
Start All [1]
<from> fromType </from> [1] ?
<selectprops> selectpropsType </selectprops> [1] ?
<propertycriteria> propertycriteriaType </propertycriteria> [0..1] ?
<filterclass> filterclassType </filterclass> [0..1] ?
<contentcriteria> contentcriteriaType </contentcriteria> [0..1] ?
<maxresults> xsd:integer </maxresults> [0..1] ?
End All
</...>
Schema Component Representation
<xsd:complexType name="filterclauseType">
<xsd:all>
<xsd:element name="from" type="fromType"/>
<xsd:element name="selectprops" type="selectpropsType"/>
<xsd:element name="propertycriteria" type="propertycriteriaType" minOccurs="0"/>
<xsd:element name="filterclass" type="filterclassType" minOccurs="0"/>
<xsd:element name="contentcriteria" type="contentcriteriaType" minOccurs="0"/>
<xsd:element name="maxresults" type="xsd:integer" minOccurs="0"/>
</xsd:all>
</xsd:complexType>
top

Complex Type: filterclausesType

Super-types: None
Sub-types: None
Name filterclausesType
Abstract no
Documentation Specifies a collection of filterclause elements.
XML Instance Representation
<...>
Start All [1]
<filterclause> filterclauseType </filterclause> [1] ?
End All
</...>
Schema Component Representation
<xsd:complexType name="filterclausesType">
<xsd:all>
<xsd:element name="filterclause" type="filterclauseType"/>
</xsd:all>
</xsd:complexType>
top

Complex Type: filterdatarequest

Super-types: None
Sub-types: None
Name filterdatarequest
Abstract no
Documentation Root element. Specifies a data request.
XML Instance Representation
<...>
Start All [1]
<objectstore> xsd:string </objectstore> [1] ?
<folderid> guidString </folderid> [1] ?
<filterclauses> filterclausesType </filterclauses> [1] ?
End All
</...>
Schema Component Representation
<xsd:complexType name="filterdatarequest">
<xsd:all>
<xsd:element name="objectstore" type="xsd:string"/>
<xsd:element name="folderid" type="guidString"/>
<xsd:element name="filterclauses" type="filterclausesType"/>
</xsd:all>
</xsd:complexType>
top

Complex Type: filterpropertyType

Super-types: None
Sub-types: None
Name filterpropertyType
Abstract no
Documentation Specifies a filter parameter for an object property.
XML Instance Representation
<...>
Start All [1]
<symname> xsd:string </symname> [1] ?
<datatype> valueType </datatype> [1] ?
<operator> opType </operator> [1] ?
<join> joinType </join> [1] ?
<value> xsd:string </value> [1] ?
<sortby> ... </sortby> [0..1] ?
<beginclause> ... </beginclause> [0..1] ?
<endclause> ... </endclause> [0..1] ?
End All
</...>
Schema Component Representation
<xsd:complexType name="filterpropertyType">
<xsd:all>
<xsd:element name="symname" type="xsd:string"/>
<xsd:element name="datatype" type="valueType"/>
<xsd:element name="operator" type="opType"/>
<xsd:element name="join" type="joinType"/>
<xsd:element name="value" type="xsd:string"/>
<xsd:element name="sortby" minOccurs="0"/>
<xsd:element name="beginclause" minOccurs="0"/>
<xsd:element name="endclause" minOccurs="0"/>
</xsd:all>
</xsd:complexType>
top

Complex Type: propertycriteriaType

Super-types: None
Sub-types: None
Name propertycriteriaType
Abstract no
Documentation Specifies a collection of filter properties.
XML Instance Representation
<...>
<filterproperty> filterpropertyType </filterproperty> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="propertycriteriaType">
<xsd:sequence>
<xsd:element name="filterproperty" type="filterpropertyType"/>
</xsd:sequence>
</xsd:complexType>
top

Complex Type: selectpropsType

Super-types: None
Sub-types: None
Name selectpropsType
Abstract no
Documentation Specifies a list of properties that will be returned.
XML Instance Representation
<...>
<selectprop> xsd:string </selectprop> [1] ?
</...>
Schema Component Representation
<xsd:complexType name="selectpropsType">
<xsd:sequence>
<xsd:element name="selectprop" type="xsd:string"/>
</xsd:sequence>
</xsd:complexType>
top

Simple Type: fromType

Super-types: xsd:string < fromType (by restriction)
Sub-types: None
Name fromType
Content
  • Base XSD Type: string
  • value comes from list: {'DOCUMENT'|'FOLDER'|'CUSTOMOBJECT'}
Documentation Specifies a filter's object type (i.e., Common, Document, Folder, or Custom Object).
Schema Component Representation
<xsd:simpleType name="fromType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="DOCUMENT"/>
<xsd:enumeration value="FOLDER"/>
<xsd:enumeration value="CUSTOMOBJECT"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: guidString

Super-types: xsd:string < guidString (by restriction)
Sub-types: None
Name guidString
Content
  • Base XSD Type: string
  • pattern = \{[0-9a-fA-F]8\-([0-9a-fA-F]{4}\-){3}[0-9a-fA-F]{12}\
Documentation Specifies the format for a string that represents a GUID.
Schema Component Representation
<xsd:simpleType name="guidString">
<xsd:restriction base="xsd:string">
<xsd:pattern value="\{[0-9a-fA-F]8\-([0-9a-fA-F]{4}\-){3}[0-9a-fA-F]{12}\"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: joinType

Super-types: xsd:string < joinType (by restriction)
Sub-types: None
Name joinType
Content
  • Base XSD Type: string
  • value comes from list: {'and'|'or'|''}
Documentation Specifies the join type (AND or OR).
Schema Component Representation
<xsd:simpleType name="joinType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="and"/>
<xsd:enumeration value="or"/>
<xsd:enumeration value=""/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: opType

Super-types: xsd:string < opType (by restriction)
Sub-types: None
Name opType
Content
  • Base XSD Type: string
  • value comes from list: {'isnull'|'isnotnull'|'eq'|'lt'|'gt'|'lte'|'gte'|'in'|'neq'|'like'}
Documentation Specifies an operator type (e.g., equals).
Schema Component Representation
<xsd:simpleType name="opType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="isnull"/>
<xsd:enumeration value="isnotnull"/>
<xsd:enumeration value="eq"/>
<xsd:enumeration value="lt"/>
<xsd:enumeration value="gt"/>
<xsd:enumeration value="lte"/>
<xsd:enumeration value="gte"/>
<xsd:enumeration value="in"/>
<xsd:enumeration value="neq"/>
<xsd:enumeration value="like"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: valueType

Super-types: xsd:string < valueType (by restriction)
Sub-types: None
Name valueType
Content
  • Base XSD Type: string
  • value comes from list: {'typebinary'|'typeboolean'|'typedate'|'typedouble'|'typeguid'|'typelong'|'typeobject'|'typestring'}
Documentation Specifies a value type (e.g., string or binary).
Schema Component Representation
<xsd:simpleType name="valueType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="typebinary"/>
<xsd:enumeration value="typeboolean"/>
<xsd:enumeration value="typedate"/>
<xsd:enumeration value="typedouble"/>
<xsd:enumeration value="typeguid"/>
<xsd:enumeration value="typelong"/>
<xsd:enumeration value="typeobject"/>
<xsd:enumeration value="typestring"/>
</xsd:restriction>
</xsd:simpleType>
top

Simple Type: yesnoType

Super-types: xsd:string < yesnoType (by restriction)
Sub-types: None
Name yesnoType
Content
  • Base XSD Type: string
  • value comes from list: {'yes'|'no'}
Documentation Specifies a "yes" or "no" value.
Schema Component Representation
<xsd:simpleType name="yesnoType">
<xsd:restriction base="xsd:string">
<xsd:enumeration value="yes"/>
<xsd:enumeration value="no"/>
</xsd:restriction>
</xsd:simpleType>
top