ColumnSet XML Schema

CRM 1.0

This is a parameter that is passed into many API methods that retrieve data from the Microsoft CRM database. The following describes the schema for this parameter:

ColumnSetXml := 
   <columnset
      (page='page-number')? 
      (count='items-per-page')? >
      ( ColumnXml | OrderXml | FilterXml ) *
   </columnset>

ColumnXml := 
   <column>column-name</column>

OrderXml := AscendXml | DescendXml

AscendXml :=
   <ascend>column-name</ascend>

DescendXml :=
   <descend>column-name</descend>

FilterXml := NullFilterXml | SingleFilterXml | MultipleFilterXml

NullFilterXml :=
   <filter
      column='column-name' 
      operator=('null' | 'not-null') />

SingleFilterXml :=
   <filter
      column='column-name' 
      (attribute='attribute-name')?
      operator=('eq' | 'neq' | 'like' ) 
      value='value-data' />

MultipleFilterXml :=
   <filter
      column='column-name' 
      (attribute='attribute-name')?
      operator='in' 
      value='(value-data)(,value-data)+' />

The following table shows the valid operators for filter.

Operator Description
eq Attribute equals value
neq Attribute does not equal value
like Attribute matches the pattern specified by value
null Attribute has a null value
not-null Attribute does not have a null value


© 2005 Microsoft Corporation. All rights reserved.


Show: