Filter Set

Set Object¶

KEY	VALUE TYPE	VALUE DESCRIPTION
_id	String	A unique resource ID for the set.
created	String	The timestamp that indicates when the set was created.
createdBy	String	The consumer who created the set.
lastModified	String	The timestamp that indicates when the set was last modified.
lastModifiedBy	String	The consumer who last updated the set.
active	Boolean	Specifies if the set will be processed by the platform.
name	String	Identifies the set in a human readable way and is unique inside a contract.
contractId	String	A resource ID that specifies to which contract the set belongs.
rules	Array	The filter rules that determine if a content item is rejected or accepted. Each element is a rule object.
or	Boolean	Specifies if all rules must be evaluated before determining if a content item should be rejected or if we can stop processing the rules as soon the first rule evaluates to true, rejecting the content item. The first happens when the or property is set to true. The latter happens when the or property is set to false, this is the default behavior.
preCondition	Object	A rule object that must evaluate to true before the filter rules will be evaluated. The entire set will be skipped when the precondition evaluates to false.

Rule Object¶

KEY	VALUE TYPE	VALUE DESCRIPTION
operator	String	The kind of logic used by the rule. See the operator overview for more information.
field	String	The content item property used by the rule to apply operator logic against.
value	String or Number or Array	Optional. The value a rule uses to evaluate a content item. This may be an array of values when in or patternin are used as operators, alternatively a list can be used in combination with these operators. If the operator is exists, then no value must be given. See the using in operators and what is a list sections for more information.
listId	String	Optional. A resource ID that specifies which list is used. See the what is a list and using in operators sections for more information.
not	Boolean	Flips the value the rule evaluates to. For example, when a rule evaluates to true and the not property is set to true, the rule will then evaluate to false. A use case might be whitelisting. For more information see the how to whitelist section. This property is set to false by default.