Filters
Element |
Description |
||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Filter |
The Filter element is the root of the filter criteria. It takes no attributes. You can specify the sub-elements in this table under the Filter root element. Note: All special characters must be double XML-encoded. For example, ampersand (&) must be encoded as &.
|
||||||||||||||||||
OperatorLogic |
The advanced operator logic for the filter criteria. This element uses the same syntax as the Advanced Operator Logic field in the Filters section of the Search Records page. |
||||||||||||||||||
Conditions |
Sample: <Conditions> <NumericFilterCondition> <Operator>Equals</Operator> <Field>5</Field> <ParentField>8</ParentField> <Value>22.5</Value> </NumericFilterCondition> </Conditions> Specifies the filters to use in the search. This element requires one or more of the sub-elements defined in Conditions. |
You must specify one or more Conditions sub-elements under the Filter root element.
Element |
Description |
||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ContentFilterCondition |
Sample: <ContentFilterCondition> <Level>1</Level> <Operator>Equals</Operator> <Values> <Value>1</Value> <Value>2</Value> </Values> </ContentFilterCondition> A filter condition using record content. This replicates the Filter by Record option in Search Records.
|
||||||||||||||||
DateComparison |
Sample: <DateComparisonFilterCondition> <Operator>Equals</Operator> <Field>5</Field> <ParentField>8</ParentField> <Value>1/1/2008</Value> <TimeZoneId>Central Standard Time</TimeZoneId> <IsTimeIncluded>TRUE</IsTimeIncluded> </DateComparisonFilterCondition> A filter condition that compares a date.
|
||||||||||||||||
DateRange |
Sample: <DateRangeFilterCondition> <Operator>Between</Operator> <Field>5</Field> <ParentField>8</ParentField> <BeginValue>1/1/2008</BeginValue> <EndValue>1/2/2008</EndValue> <TimeZoneId>Central Standard Time</TimeZoneId> <IsTimeIncluded>TRUE</IsTimeIncluded> </DateRangeFilterCondition> A filter condition for date ranges.
|
||||||||||||||||
DateTimeRange |
Sample: <DateTimeRangeFilterCondition> <Field>15176</Field> <BeginDate>7/7/2011</BeginDate> <BeginTime>00:00</BeginTime> <EndDate>7/14/2011</EndDate> <EndTime>15:00</EndTime> <TimeZoneId>Central Standard Time</TimeZoneId> <IsTimeIncluded>TRUE</IsTimeIncluded> </DateTimeRangeFilterCondition> A filter condition for date ranges.
|
||||||||||||||||
DateOffset |
Sample: <DateOffsetFilterCondition> <Operator>LastXDays</Operator> <Field>5</Field> <ParentField>8</ParentField> <Value>22</Value> <TimeZoneId>Central Standard Time</TimeZoneId> <IsTimeIncluded>TRUE</IsTimeIncluded> </DateOffsetFilterCondition> A filter condition before or after the current date.
|
||||||||||||||||
CurrentDate |
Sample: <CurrentDateFilterCondition> <Operator>CurrentDay</Operator> <Field>5</Field> <ParentField>8</ParentField> <TimeZoneId>Central Standard Time</TimeZoneId> <IsTimeIncluded>TRUE</IsTimeIncluded> </CurrentDateFilterCondition> A filter condition using the current date.
|
||||||||||||||||
NumericFilterCondition |
Sample: <NumericFilterCondition> <Operator>Equals</Operator> <Field>5</Field> <ParentField>8</ParentField> <Value>22.5</Value> </NumericFilterCondition> A filter condition using numeric fields.
|
||||||||||||||||
NumericRange |
Sample: <NumericRangeFilterCondition> <Operator>Contains</Operator> <Field>5</Field> <ParentField>8</ParentField> <Values> <Value>1</Value> <Value>2</Value> </Values> </NumericRangeFilterCondition> A filter condition using ranges of numbers.
|
||||||||||||||||
NumericBetween |
Sample: <NumericBetweenFilterCondition> <Operator>Between</Operator> <Field>5</Field> <ParentField>8</ParentField> <BeginValue>5.1</BeginValue> <EndValue>8.2</EndValue> </NumericBetweenFilterCondition> A filter condition specifying values within a numeric range.
|
||||||||||||||||
RecordStatus |
Sample: <RecordStatusFilterCondition> <Operator>DoesNotEqual</Operator> <Field>5</Field> <RecordStatusType>New</RecordStatusType> </RecordStatusFilterCondition> A filter condition using the record status.
|
||||||||||||||||
ValueListFilterCondition |
Sample: <ValueListFilterCondition> <Operator>Contains</Operator> <Field>5</Field> <IsNoSelectionIncluded>True <Values> <Value>1</Value> <Value>2</Value> </Values> </ValueListFilterCondition> A filter condition using a values list.
|
||||||||||||||||
UserGroup |
Sample: <UserGroupFilterCondition> <Operator>Contains</Operator> <Field>5</Field> <IsNoSelectionIncluded>True <Groups> <Group>1</Group> <Group>2</Group> </Groups> <Users> <User>1</User> <User>2</User> </Users> </UserGroupFilterCondition> A filter condition using user groups.
|
||||||||||||||||
TextFilterCondition |
Sample: <TextFilterCondition> <Operator>Contains</Operator> <Field>5</Field> <Value>Hello &amp; Goodbye</Value> </TextFilterCondition> A filter condition using text.
|
||||||||||||||||
MatrixFilterCondition |
Sample: <MatrixFilterCondition> <Operator>Contains</Operator> <Field>5</Field> <IsNoSelectionIncluded>True <Row id="1"> <Column>5</Column> <Column>6</Column> </Row> <Row id="2"> <Column>7</Column> <Column>9</Column> </Row> </MatrixFilterCondition> A filter condition using the matrix field.
|
||||||||||||||||
ReferenceFilterCondition |
Sample: <ReferenceFilterCondition> <Operator>Contains</Operator> <Field>5</Field> <IsNoSelectionIncluded>False <Level id="1"> <Content>5</Content> <Content>6</Content> </Level> <Level id="2"> <Content>7</Content> <Content>9</Content> </Level> </ReferenceFilterCondition> A filter condition using a reference field.
|
||||||||||||||||
IpAddressFilterCondition |
Sample using IPv4 address: <IpAddressFilterCondition> <Field>5</Field> <Operator>Equals</Operator> <Octet1>255</Octet1> <Octet2>1</Octet2> <Octet3>3</Octet3> <Octet4>4</Octet4> </IpAddressFilterCondition> Sample using IPv6 address: <IpAddressFilterCondition> <Field>5</Field> <Operator>Equals</Operator> <Value>2001::001a</Value> </IpAddressFilterCondition> A filter condition using IP address. To filter multiple addresses, define multiple IpAddressFilterCondition nodes and join them using the OperatorLogic element.
|
||||||||||||||||
CastFilterCondition |
Sample: <CastFilterCondition> <Operator>Contains</Operator> <Field>5</Field> <Value>12</Value> </CastFilterCondition> A filter condition using CAST fields.
|