Filter Constraints
Example query with an array of filters on a standard field and a custom field definition and its value, and a sorting order
{
"filterConstraints":[
{
"filterSelection":"CREATION_DATE",
"filterElement":"BETWEEN",
"value":"2015-01-01",
"secondValue":"2015-06-20"
},
{
"filterSelection":"MY_CUSTOM_FIELD",
"filterElement":"EQUALS",
"dataItemType":"CLIENT",
"dataFieldType":"CUSTOM",
"value":"BIG spenders"
}
],
"sortDetails":{
"sortingColumn":"lastModifiedDate",
"sortingOrder":"DESCENDING"
}
}
filterContraints array
| Parameter | Value |
|---|---|
| filterSelection | The field on which the constraint will be applied. For custom fields, the custom field definition encoded key must be provided. |
| filterElement | The constraint operator. Available filter elements can be found below. |
| value | The constraint value. Required for filter elements with one or two values. |
| secondValue | The constraint second value. Required for filter elements with two values. |
| dataItemType | The entity where the field on which to apply the constraint is located. If the field is located in the same entity with the entity being searched, this field is optional. Possible values:
|
| dataFieldType | NATIVE(default)/CUSTOM for custom field definition searches |
sortDetails object
| Parameter | Value |
|---|---|
| sortingColumn | The name of the column on which the order is going to take place |
| sortingOrder | The order in which your results should be presented, either ASCENDING or DESCENDING |