Skip to main content

Customfilterconstraint

Represents a custom filter constraint.

customFieldIdstring

The custom field id, which is needed to correlate the CUSTOM filter constraint to a custom field.

dataFieldEntityTypestringrequired

The custom filter constraint data field entity type.

dataFieldTypestringrequired

Represents a data field type of a custom filter constraint.

Possible values: [NATIVE, CUSTOM]

dataFieldValuestring

The custom filter constraint data field value.

dataTypestringrequired

Represents a data type of a custom filter constraint.

Possible values: [BIG_DECIMAL, DATE, DATE_UTC, DATE_TIME, ENUM, KEY, LONG, MONEY, PERCENT, NUMBER, OBJECT, STRING, BOOLEAN, JAVA_BLOB]

filterElementstringrequired

Represents a filter element of a custom filter constraint.

Possible values: [EQUALS, EQUALS_CASE_SENSITIVE, DIFFERENT_THAN, MORE_THAN, MORE_THAN_OR_EQUALS, LESS_THAN, LESS_THAN_OR_EQUALS, BETWEEN, IN, ON, AFTER, AFTER_INCLUSIVE, BEFORE, BEFORE_INCLUSIVE, STARTS_WITH, STARTS_WITH_CASE_SENSITIVE, TODAY, THIS_WEEK, THIS_MONTH, THIS_YEAR, LAST_DAYS, EMPTY, NOT_EMPTY]

groupNumberinteger<int32>

The custom filter constraint group number.

idstring

The custom filter constraint ID, which must be unique.

indexinteger<int32>

The custom filter constraint index.

secondValuestring

The custom filter constraint second value.

valuestringrequired

The custom filter constraint value, which must be not null.

Customfilterconstraint
{
"customFieldId": "string",
"dataFieldEntityType": "string",
"dataFieldType": "NATIVE",
"dataFieldValue": "string",
"dataType": "BIG_DECIMAL",
"filterElement": "EQUALS",
"groupNumber": 0,
"id": "string",
"index": 0,
"secondValue": "string",
"value": "string"
}