ExtFilter
This Script is part of the Community Common Scripts Pack.#
Filter values with complex conditions.
You can make filters with comlex and combination conditions for the context data at any level of the tree.
Script Data#
| Name | Description |
|---|---|
| Script Type | python |
| Tags | transformer, entirelist, general |
Inputs#
| Argument Name | Description |
|---|---|
| value | The value to filter/transform. |
| path | Context path to which to filter |
| operator | The operation name to filter/transform. |
| filter | The filter. |
| ctx_demisto | Enable to access the context data |
| ctx_inputs | Enable to access the input parameters to sub playbooks and use ${inputs.} |
| ctx_lists | Enable to access the list data and use ${list.} |
| ctx_incident | Enable to access the incident context and use ${incident.} |
Filter Syntax for expressions, conditions and transformers#
dict-expression#
and logical operator for each expression.
e.g.
(<value> ends with ".exe") && (<value> starts with "x")
array-expression#
Logical operations for each expression. and by default.
e.g.
(<value> ends with ".exe") && (<value> starts with "x")
or
(<value> ends with ".exe") || (<value> starts with "x")
not (<value> ends with ".exe")
((<value> ends with ".exe") || (<value> ends with ".pdf")) and (<value> starts with "x")
condition#
Evaluates child nodes of each dictionary element.
e.g.
<value>.Domain ends with ".com"
(<value>.Domain ends with ".com") && (<value>.IP starts with "192.168.")
array-condition#
Logical operations for each condition. and by default.
e.g.
(<value>.Domain ends with ".com") || (<value>.IP starts with "192.168.")
not ((<value>.Domain ends with ".com") || (<value>.IP starts with "192.168."))
transformers#
Run each transformer in order.
e.g.
base64: encode -> digest
base64: encode -> digest (Python 3.7 or above)
Note:
The order depends on python runtime in a dict-expression. Python 3.6 or less doesn't guarantee dictionary keys order.
DT (Demisto Transform Language)#
In filters written in JSON like expressions, conditions, transformers or <value>, you can set values with DT expressions for keys and values.
When you use DT, you must set ctx_demisto, ctx_inputs, ctx_lists and ctx_incident of the parameters for the data to which DT accesses.
| Parameter | Data Source | Value | Description |
|---|---|---|---|
| ctx_demisto | From Previous Tasks | . | Enable to access the context data |
| ctx_inputs | From Previous Tasks | inputs | Enable to access the input parameters to sub playbooks and use ${inputs.} |
| ctx_lists | From Previous Tasks | list | Enable to access the list data and use ${list.} |
| ctx_incident | From Previous Tasks | incident | Enable to access the incident context and use ${incident.} |
NOTE: ${list.} doesn't work in XSOAR 6.0 in transformer.
local prefix (${local.}) and . prefix (${..}) can be available for additional DT references.
${local} refers the root value of the target, and ${local.<name>} refers the value property located at the relateve path to the root.
${..} refers the current value of the target, and ${.<name>} refers the value property located at the relateve path to the current value.
No parameters set is required for using ${local.} and ${..}.
Example 1#
Example 2#
Example 3#
Example 4#
Example 5#
Example 6#
Operators#
Available operators
is transformed withis filtered withvalue is filtered withkeepsdoesn't keepisisn't===!==equals==doesn't equal!=greater or equal>=greater than>less or equal<=less thanin rangestarts withstarts with caselessdoesn't start withdoesn't start with caselessends withends with caselessdoesn't end withdoesn't end with caselessincludesincludes caselessdoesn't includedoesn't include caselessfindsfinds caselessdoesn't finddoesn't find caselessmatchesmatches caselessdoesn't matchdoesn't match caselesswildcard: matcheswildcard: matches caselesswildcard: doesn't matchwildcard: doesn't match caselessregex: matchesregex: matches caselessregex: doesn't matchregex: doesn't match caselessinin caselessnot innot in caselessin listin caseless listnot in listnot in caseless listcontainscontains caselessdoesn't containdoesn't contain caselesswildcard: containswildcard: contains caselesswildcard: doesn't containwildcard: doesn't contain caselessregex: containsregex: contains caselessregex: doesn't containregex: doesn't contain caselessmatches any line ofmatches any caseless line ofdoesn't match any line ofdoesn't match any caseless line ofmatches any string ofmatches any caseless string ofdoesn't match any string ofdoesn't match any caseless string ofwildcard: matches any string ofwildcard: matches any caseless string ofwildcard: doesn't match any string ofwildcard: doesn't match any caseless string ofregex: matches any string ofregex: matches any caseless string ofregex: doesn't match any string ofregex: doesn't match any caseless string ofcontains any line ofcontains any caseless line ofdoesn't contain any line ofdoesn't contain any caseless line ofcontains any string ofcontains any caseless line ofdoesn't contain any string ofdoesn't contain any caseless line ofwildcard: contains any string ofwildcard: contains any caseless line ofwildcard: doesn't contain any string ofwildcard: doesn't contain any caseless line ofregex: contains any string ofregex: contains any caseless line ofregex: doesn't contain any string ofregex: doesn't contain any caseless line ofmatches expressions ofmatches conditions ofvalue matches expressions ofvalue matches conditions ofjson: encode arrayjson: encodejson: decodebase64: encodebase64: decodedigestis replaced withis updated withappendsif-then-elseswitch-casecollects valuescollects keysflattens with valuesflattens with keysabortemail-header: decoderegex: replaceis individually transformed withis collectively transformed with
Operator: is transformed with#
Transforms elements with `transformers` given in a filter. See `Filter Syntax` for the details of `transformers`.
Filter Format:
transformers
Example 1#
Input#
Filter#
Operator: is transformed with
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: is transformed with
Path: File
Filter:
Output#
Example 3#
Input#
Filter#
Operator: is transformed with
Path:
Filter:
Output#
Operator: is filtered with#
Evaluates each element of an array with given conditions and returns a set of the elements matched. The value is handled as an array which has only one element when its data type is `dictionary`. See `Filter Syntax` for the details of `conditions`.
Filter Format:
conditions
Example 1#
Input#
Filter#
Operator: is filtered with
Path:
Filter:
Output#
Operator: value is filtered with#
Evaluates each value of dictionary elements or each element for values whose data type is not `dictionary`, and returns a set of the elements matched to expressions given in a filter. See `Filter Syntax` for the details of `expressions`.
Filter Format:
expressions
Example 1#
Input#
Filter#
Operator: value is filtered with
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: value is filtered with
Path: Score
Filter:
Output#
Operator: keeps#
Evaluates each element of an array with keys given and returns a set of the elements which only retains the keys given and corresponding values. The value is handled as an array which has only one element when its data type is `dictionary`.
Filter Format:
expressions
Example 1#
Input#
Filter#
Operator: keeps
Path:
Filter:
Output#
Operator: doesn't keeps#
Evaluates each element of an array with keys given and returns a set of the elements which are excluded the keys given. The value is handled as an array which has only one element when its data type is `dictionary`.
Filter Format:
expressions
Example 1#
Input#
Filter#
Operator: doesn't keeps
Path:
Filter:
Output#
Operator: is#
This operator works with a sub operator specified as filter.
Sub Operator: empty#
Returns a set of elements which is empty.
Example 1#
Input#
Filter#
Operator: is
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: is
Path:
Filter:
Output#
Sub Operator: null#
Returns a set of elements which is `null`.
Example 1#
Input#
Filter#
Operator: is
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: is
Path:
Filter:
Output#
Sub Operator: string#
Returns a set of elements whose data type is `string`.
Example 1#
Input#
Filter#
Operator: is
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: is
Path:
Filter:
Output#
Sub Operator: integer#
Returns a set of elements whose data type is `integer`.
Example 1#
Input#
Filter#
Operator: is
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: is
Path:
Filter:
Output#
Sub Operator: integer string#
Returns a set of elements whose data type is `string` and whose value is integer. The value that includes decimal point is evaluated as not integer.
Example 1#
Input#
Filter#
Operator: is
Path:
Filter:
Output#
Sub Operator: any integer#
Returns a set of elements matched with `string` or `integer string` operator.
Example 1#
Input#
Filter#
Operator: is
Path:
Filter:
Output#
Sub Operator: existing key#
Operator: isn't#
This operator works with a sub operator specified as filter.
Sub Operator: empty#
Returns a set of elements which is not empty.
Example 1#
Input#
Filter#
Operator: isn't
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: isn't
Path:
Filter:
Output#
Sub Operator: null#
Returns a set of elements which is not `null`.
Example 1#
Input#
Filter#
Operator: isn't
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: isn't
Path:
Filter:
Output#
Sub Operator: string#
Returns a set of elements whose data type is not `string`.
Example 1#
Input#
Filter#
Operator: isn't
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: isn't
Path:
Filter:
Output#
Sub Operator: integer#
Returns a set of elements whose date type is not `integer`.
Example 1#
Input#
Filter#
Operator: isn't
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: isn't
Path:
Filter:
Output#
Sub Operator: integer string#
Returns a set of elements whose data type is not `string` or whose value is not integer. The value that includes decimal point is evaluated as not integer.
Example 1#
Input#
Filter#
Operator: isn't
Path:
Filter:
Output#
Sub Operator: any integer#
Returns a set of elements which are neither `string` or `integer string`.
Example 1#
Input#
Filter#
Operator: isn't
Path:
Filter:
Output#
Sub Operator: existing key#
Operator: ===#
Returns a set of elements which exactly matches to a value given in a filter. It doesn't match when the data types are different.
Filter Format:
<value>
Example 1#
Input#
Filter#
Operator: ===
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: ===
Path:
Filter:
Output#
Operator: !==#
Returns a set of elements which doesn't match the data type or the value of a value given in a filter.
Filter Format:
<value>
Example 1#
Input#
Filter#
Operator: !==
Path:
Filter:
Output#
Operator: equals, ==#
Returns a set of elements which is equal to a value given in a filter. The value is implicitly converted from its data type to another in a comparison between different data types. `==` is an alias name for `equals`.
Filter Format:
<value>
Example 1#
Input#
Filter#
Operator: equals
Path:
Filter:
Output#
Operator: doesn't equal, !=#
Returns a set of elements which is not equal to a value given in a filter. The value is implicitly converted from its data type to another in a comparison between different data types. `!=` is an alias name for `doesn't equal`.
Filter Format:
<value>
Example 1#
Input#
Filter#
Operator: doesn't equal
Path:
Filter:
Output#
Operator: greater or equal, >=#
Returns a set of elements which is greater or equal to a value given in a filter. The value is implicitly converted from its data type to number in a comparison. This operator evaluates to false for either or both of the data which cannot convert to number. `>=` is an alias name for `greater or equal`.
Filter Format:
<value>
Example 1#
Input#
Filter#
Operator: greater or equal
Path:
Filter:
Output#
Operator: greater than, >#
Returns a set of elements which is greater than a value given in a filter. The value is implicitly converted from its data type to number in a comparison. This operator evaluates to false for either or both of the data which cannot convert to number. `>` is an alias name for `greater than`.
Filter Format:
<value>
Example 1#
Input#
Filter#
Operator: greater than
Path:
Filter:
Output#
Operator: less or equal, <=#
Returns a set of elements which is less or equal to a value given in a filter. The value is implicitly converted from its data type to number in a comparison. This operator evaluates to false for either or both of the data which cannot convert to number. `<=` is an alias name for `less or equal`.
Filter Format:
<value>
Example 1#
Input#
Filter#
Operator: less or equal
Path:
Filter:
Output#
Operator: less than, <#
Returns a set of elements which is less than a value given in a filter. The value is implicitly converted from its data type to number in a comparison. This operator evaluates to false for either or both of the data which cannot convert to number. `<` is an alias name for `less than`.
Filter Format:
<value>
Example 1#
Input#
Filter#
Operator: less than
Path:
Filter:
Output#
Operator: in range#
Returns a set of elements which is greater or equal to `min` and less or equal to `max` given in a range. The value is implicitly converted from its data type to number in a comparison. This operator evaluates to false for either or both of the data which cannot convert to number.
Filter Format:
min,max
Example 1#
Input#
Filter#
Operator: in range
Path:
Filter:
Output#
Operator: starts with#
Returns a set of elements which starts with a string given in a filter.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: starts with
Path:
Filter:
Output#
Operator: starts with caseless#
Returns a set of elements which starts with a string given in a filter. It performs case-insensitive matching.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: starts with caseless
Path:
Filter:
Output#
Operator: doesn't start with#
Returns a set of elements which doesn't start with a string given in a filter.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't start with
Path:
Filter:
Output#
Operator: doesn't start with caseless#
Returns a set of elements which doesn't start with a string given in a filter. It performs case-insensitive matching.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't start with caseless
Path:
Filter:
Output#
Operator: ends with caseless#
Returns a set of elements which ends with a string given in a filter. It performs case-insensitive matching.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: ends with caseless
Path:
Filter:
Output#
Operator: doesn't end with#
Returns a set of elements which doesn't end with a string given in a filter.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't end with
Path:
Filter:
Output#
Operator: doesn't end with caseless#
Returns a set of elements which doesn't end with a string given in a filter. It performs case-insensitive matching.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't end with caseless
Path:
Filter:
Output#
Operator: includes#
Returns a set of elements of which a string given in a filter is a substring. The searching only works for `string` data types. It evaluates to unmatched for a element that either or both of the data types is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: includes
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: includes
Path:
Filter:
Output#
Operator: includes caseless#
Returns a set of elements of which a string given in a filter is a substring. It performs case-insensitive seaching, and only works for `string` data types. It evaluates to unmatched for a element that either or both of the data types is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: includes caseless
Path:
Filter:
Output#
Operator: doesn't include#
Returns a set of elements of which a string given in a filter is not a substring. The searching only works for `string` data types. It evaluates to unmatched for a element that either or both of the data types is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't include
Path:
Filter:
Output#
Operator: doesn't include caseless#
Returns a set of elements of which a string given in a filter is not a substring. It performs case-insensitive seaching, and only works for `string` data types. It evaluates to unmatched for a element that either or both of the data types is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't include caseless
Path:
Filter:
Output#
Operator: finds#
Returns the entire target value if a string given in a filter is a substring of any of the elements, `null` otherwise. The searching is performed for a single `string` element or each `string` element of an array.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: finds
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: finds
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: finds
Path:
Filter:
Output#
Operator: finds caseless#
Returns the entire target value if a string given in a filter is a substring of any of the elements, `null` otherwise. The searching is performed for a single `string` element or each `string` element of an array with case-insensitive matching.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: finds caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: finds caseless
Path:
Filter:
Output#
Operator: doesn't find#
Returns an entire target value if a string given in a filter is not a substring of any of the elements, `null` otherwise. The searching is performed for a single `string` element or each `string` element of an array.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't find
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't find
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: doesn't find
Path:
Filter:
Output#
Operator: doesn't find caseless#
Returns an entire target value if a string given in a filter is not a substring of any of the elements, `null` otherwise. The searching is performed for a single `string` element or each `string` element of an array with case-insensitive matching.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't find caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't find caseless
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: doesn't find caseless
Path:
Filter:
Output#
Operator: matches#
Returns a set of elements which is equal to a string given in a filter. The matching is peformed between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: matches
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: matches
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: matches
Path:
Filter:
Output#
Operator: matches caseless#
Returns a set of elements which matches a string given in a filter. The matching is peformed case-insensitively and between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: matches caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: matches caseless
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: matches caseless
Path:
Filter:
Output#
Operator: doesn't match#
Returns a set of elements which is not equal to a string given in a filter. The matching is peformed between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't match
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't match
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: doesn't match
Path:
Filter:
Output#
Operator: doesn't match caseless#
Returns a set of elements which doesn't match a string given in a filter. The matching is peformed case-insensitively and between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't match caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't match caseless
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: doesn't match caseless
Path:
Filter:
Output#
Operator: wildcard: matches#
Returns a set of elements which matches a wildcard pattern given in a filter. The matching is peformed between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: wildcard: matches
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: matches
Path:
Filter:
Output#
Operator: wildcard: matches caseless#
Returns a set of elements which matches a wildcard pattern given in a filter. The matching is peformed case-insensitively and between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: wildcard: matches caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: matches caseless
Path:
Filter:
Output#
Operator: wildcard: doesn't match#
Returns a set of elements which doesn't match a wildcard pattern given in a filter. The matching is peformed between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: wildcard: doesn't match
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: doesn't match
Path:
Filter:
Output#
Operator: wildcard: doesn't match caseless#
Returns a set of elements which doesn't match a wildcard pattern given in a filter. The matching is peformed case-insensitively and between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: wildcard: doesn't match caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: doesn't match caseless
Path:
Filter:
Output#
Operator: regex: matches#
Returns a set of elements which matches a regular expression pattern given in a filter. The matching is peformed between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: regex: matches
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: matches
Path:
Filter:
Output#
Operator: regex: matches caseless#
Returns a set of elements which matches a regular expression pattern given in a filter. The matching is peformed case-insensitively and between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: regex: matches caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: matches caseless
Path:
Filter:
Output#
Operator: regex: doesn't match#
Returns a set of elements which doesn't match a regular expression pattern given in a filter. The matching is peformed between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: regex: doesn't match
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: doesn't match
Path:
Filter:
Output#
Operator: regex: doesn't match caseless#
Returns a set of elements which doesn't match a regular expression pattern given in a filter. The matching is peformed case-insensitively and between `string` data types. It doesn't match for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: regex: doesn't match caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: doesn't match caseless
Path:
Filter:
Output#
Operator: in#
Returns a set of a element which matches a element of the values given.
Filter Format:
list
Example 1#
Input#
Filter#
Operator: in
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: in
Path:
Filter:
Output#
Operator: in caseless#
Returns a set of a element which matches a element of the values given. The matching is peformed case-insensitively for `string` elements.
Filter Format:
list
Example 1#
Input#
Filter#
Operator: in caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: in caseless
Path:
Filter:
Output#
Operator: not in#
Returns a set of a element which doesn't match any element of the values given.
Filter Format:
list
Example 1#
Input#
Filter#
Operator: not in
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: not in
Path:
Filter:
Output#
Operator: not in caseless#
Returns a set of a element which doesn't match any element of the values given. The matching is peformed case-insensitively for `string` elements.
Filter Format:
list
Example 1#
Input#
Filter#
Operator: not in caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: not in caseless
Path:
Filter:
Output#
Operator: in list#
Returns a set of elements which matches any of strings of a comma separated list. The matching always evaluates to false for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: in list
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: in list
Path:
Filter:
Output#
Operator: in caseless list#
Returns a set of elements which matches any of strings of a comma separated list. The matching is peformed case-insensitively, and always evaluates to false for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: in caseless list
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: in caseless list
Path:
Filter:
Output#
Operator: not in list#
Returns a set of elements which doesn't match any of strings of a comma separated list. The matching always evaluates to false for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: not in list
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: not in list
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: not in list
Path:
Filter:
Output#
Operator: not in caseless list#
Returns a set of elements which doesn't match any of strings of a comma separated list. The matching is peformed case-insensitively, and always evaluates to false for a element whose data type is not `string`.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: not in caseless list
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: not in caseless list
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: not in caseless list
Path:
Filter:
Output#
Operator: contains#
Returns an entire value if any of the elements matches a string given in a filter, `null` otherwise.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: contains
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: contains
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: contains
Path:
Filter:
Output#
Operator: contains caseless#
Returns an entire value if any of the elements matches a string given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: contains caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: contains caseless
Path:
Filter:
Output#
Operator: doesn't contain#
Returns an entire value if all of the elements doesn't match a string given in a filter, `null` otherwise.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't contain
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't contain
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: doesn't contain
Path:
Filter:
Output#
Operator: doesn't contain caseless#
Returns an entire value if all of the elements doesn't match a string given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't contain caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't contain caseless
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: doesn't contain caseless
Path:
Filter:
Output#
Operator: wildcard: contains#
Returns an entire value if any of the elements matches a wildcard pattern given in a filter, `null` otherwise.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: wildcard: contains
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: contains
Path:
Filter:
Output#
Operator: wildcard: contains caseless#
Returns an entire value if any of the elements matches a wildcard pattern given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: wildcard: contains caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: contains caseless
Path:
Filter:
Output#
Operator: wildcard: doesn't contain#
Returns an entire value if all of the elements doesn't match a wildcard pattern given in a filter, `null` otherwise.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: wildcard: doesn't contain
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: doesn't contain
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: wildcard: doesn't contain
Path:
Filter:
Output#
Operator: wildcard: doesn't contain caseless#
Returns an entire value if all of the elements doesn't match a wildcard pattern given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: wildcard: doesn't contain caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: doesn't contain caseless
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: wildcard: doesn't contain caseless
Path:
Filter:
Output#
Operator: regex: contains#
Returns an entire value if any of the elements matches a regular expression given in a filter, `null` otherwise.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: regex: contains
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: contains
Path:
Filter:
Output#
Operator: regex: contains caseless#
Returns an entire value if any of the elements matches a regular expression given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: regex: contains caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: contains caseless
Path:
Filter:
Output#
Operator: regex: doesn't contain#
Returns an entire value if all of the elements doesn't match a regular expression given in a filter, `null` otherwise.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: regex: doesn't contain
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: doesn't contain
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: regex: doesn't contain
Path:
Filter:
Output#
Operator: regex: doesn't contain caseless#
Returns an entire value if all of the elements doesn't match a regular expression given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: regex: doesn't contain caseless
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: doesn't contain caseless
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: regex: doesn't contain caseless
Path:
Filter:
Output#
Operator: matches any line of#
Returns a set of elements which matches any line of a text given in a filter.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: matches any line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: matches any line of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: matches any line of
Path:
Filter:
Output#
Operator: matches any caseless line of#
Returns a set of elements which matches any line of a text given in a filter. The matching is peformed case-insensitively.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: matches any caseless line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: matches any caseless line of
Path:
Filter:
Output#
Operator: doesn't match any line of#
Returns a set of elements which doesn't match any line of a text given in a filter.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't match any line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't match any line of
Path:
Filter:
Output#
Operator: doesn't match any caseless line of#
Returns a set of elements which doesn't match any line of a text given in a filter. The matching is peformed case-insensitively.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't match any caseless line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't match any caseless line of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: doesn't match any caseless line of
Path:
Filter:
Output#
Operator: matches any string of#
Returns a set of elements which matches any strings given in a filter.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: matches any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: matches any string of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: matches any string of
Path:
Filter:
Output#
Example 4#
Input#
Filter#
Operator: matches any string of
Path:
Filter:
Output#
Operator: matches any caseless string of#
Returns a set of elements which matches any strings given in a filter. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: matches any caseless string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: matches any caseless string of
Path:
Filter:
Output#
Operator: doesn't match any string of#
Returns a set of elements which doesn't match any strings given in a filter.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: doesn't match any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't match any string of
Path:
Filter:
Output#
Operator: doesn't match any caseless string of#
Returns a set of elements which doesn't match any strings given in a filter. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: doesn't match any caseless string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't match any caseless string of
Path:
Filter:
Output#
Operator: wildcard: matches any string of#
Returns a set of elements which matches any wildcard patterns given in a filter.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: wildcard: matches any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: matches any string of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: wildcard: matches any string of
Path:
Filter:
Output#
Example 4#
Input#
Filter#
Operator: wildcard: matches any string of
Path:
Filter:
Output#
Operator: wildcard: matches any caseless string of#
Returns a set of elements which matches any wildcard patterns given in a filter. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: wildcard: matches any caseless string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: matches any caseless string of
Path:
Filter:
Output#
Operator: wildcard: doesn't match any string of#
Returns a set of elements which doesn't match any wildcard patterns given in a filter.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: wildcard: doesn't match any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: doesn't match any string of
Path:
Filter:
Output#
Operator: wildcard: doesn't match any caseless string of#
Returns a set of elements which doesn't match any wildcard patterns given in a filter. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: wildcard: doesn't match any caseless string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: doesn't match any caseless string of
Path:
Filter:
Output#
Operator: regex: matches any string of#
Returns a set of elements which matches any regular expression patterns given in a filter.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: regex: matches any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: matches any string of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: regex: matches any string of
Path:
Filter:
Output#
Example 4#
Input#
Filter#
Operator: regex: matches any string of
Path:
Filter:
Output#
Operator: regex: matches any caseless string of#
Returns a set of elements which matches any regular expression patterns given in a filter. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: regex: matches any caseless string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: matches any caseless string of
Path:
Filter:
Output#
Operator: regex: doesn't match any string of#
Returns a set of elements which doesn't match any regular expression patterns given in a filter.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: regex: doesn't match any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: doesn't match any string of
Path:
Filter:
Output#
Operator: regex: doesn't match any caseless string of#
Returns a set of elements which doesn't match any regular expression patterns given in a filter. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: regex: doesn't match any caseless string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: doesn't match any caseless string of
Path:
Filter:
Output#
Operator: contains any line of#
Returns an entire value if any of the elements matches any line of a text given in a filter, `null` otherwise.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: contains any line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: contains any line of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: contains any line of
Path:
Filter:
Output#
Operator: contains any caseless line of#
Returns an entire value if any of the elements matches any line of a text given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: contains any caseless line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: contains any caseless line of
Path:
Filter:
Output#
Operator: doesn't contain any line of#
Returns an entire value if all of the elements doesn't match any line of a text given in a filter, `null` otherwise.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't contain any line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't contain any line of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: doesn't contain any line of
Path:
Filter:
Output#
Operator: doesn't contain any caseless line of#
Returns an entire value if all of the elements doesn't match any line of a text given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
string
Example 1#
Input#
Filter#
Operator: doesn't contain any caseless line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't contain any caseless line of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: doesn't contain any caseless line of
Path:
Filter:
Output#
Operator: contains any string of#
Returns an entire value if any of the elements matches any strings given in a filter, `null` otherwise.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: contains any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: contains any string of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: contains any string of
Path:
Filter:
Output#
Example 4#
Input#
Filter#
Operator: contains any string of
Path:
Filter:
Output#
Operator: contains any caseless line of#
Returns an entire value if any of the elements matches any strings given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: contains any caseless line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: contains any caseless line of
Path:
Filter:
Output#
Operator: doesn't contain any string of#
Returns an entire value if all of the elements doesn't match any strings given in a filter, `null` otherwise.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: doesn't contain any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't contain any string of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: doesn't contain any string of
Path:
Filter:
Output#
Operator: doesn't contain any caseless line of#
Returns an entire value if all of the elements doesn't match any strings given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: doesn't contain any caseless line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: doesn't contain any caseless line of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: doesn't contain any caseless line of
Path:
Filter:
Output#
Operator: wildcard: contains any string of#
Returns an entire value if any of the elements matches any wildcard patterns given in a filter, `null` otherwise.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: wildcard: contains any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: contains any string of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: wildcard: contains any string of
Path:
Filter:
Output#
Example 4#
Input#
Filter#
Operator: wildcard: contains any string of
Path:
Filter:
Output#
Operator: wildcard: contains any caseless string of#
Returns an entire value if any of the elements matches any wildcard patterns given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: wildcard: contains any caseless string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: contains any caseless string of
Path:
Filter:
Output#
Operator: wildcard: doesn't contain any string of#
Returns an entire value if all of the elements doesn't match any wildcard patterns given in a filter, `null` otherwise.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: wildcard: doesn't contain any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: doesn't contain any string of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: wildcard: doesn't contain any string of
Path:
Filter:
Output#
Operator: wildcard: doesn't contain any caseless line of#
Returns an entire value if all of the elements doesn't match any wildcard patterns given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: wildcard: doesn't contain any caseless line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: wildcard: doesn't contain any caseless line of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: wildcard: doesn't contain any caseless line of
Path:
Filter:
Output#
Operator: regex: contains any string of#
Returns an entire value if any of the elements matches any regular expression patterns given in a filter, `null` otherwise.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: regex: contains any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: contains any string of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: regex: contains any string of
Path:
Filter:
Output#
Example 4#
Input#
Filter#
Operator: regex: contains any string of
Path:
Filter:
Output#
Operator: regex: contains any caseless string of#
Returns an entire value if any of the elements matches any regex patterns given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: regex: contains any caseless string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: contains any caseless string of
Path:
Filter:
Output#
Operator: regex: doesn't contain any string of#
Returns an entire value if all of the elements doesn't match any regex patterns given in a filter, `null` otherwise.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: regex: doesn't contain any string of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: doesn't contain any string of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: regex: doesn't contain any string of
Path:
Filter:
Output#
Operator: regex: doesn't contain any caseless line of#
Returns an entire value if all of the elements doesn't match any regex patterns given in a filter, `null` otherwise. The matching is peformed case-insensitively.
Filter Format:
<JSON string> or <JSON array of string>
Example 1#
Input#
Filter#
Operator: regex: doesn't contain any caseless line of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: doesn't contain any caseless line of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: regex: doesn't contain any caseless line of
Path:
Filter:
Output#
Operator: matches expressions of#
Returns the result of a value filtered by `expressions` given. See `Filter Syntax` for the details of `expressions`.
Filter Format:
expressions
Example 1#
Input#
Filter#
Operator: matches expressions of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: matches expressions of
Path: Domain
Filter:
Output#
Operator: matches conditions of#
Returns the result of a value filtered by `conditions` given. See `Filter Syntax` for the details of `conditions`.
Filter Format:
conditions
Example 1#
Input#
Filter#
Operator: matches conditions of
Path: Events
Filter:
Output#
Example 2#
Input#
Filter#
Operator: matches conditions of
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: matches conditions of
Path:
Filter:
Output#
Example 4#
Input#
Filter#
Operator: matches conditions of
Path:
Filter:
Output#
Operator: value matches expressions of#
Evaluates each value of dictionary elements or each element for values whose data type is not `dictionary`, and returns a set of the elements matched to expressions given in a filter. See `Filter Syntax` for the details of `expressions`.
Filter Format:
expressions
Example 1#
Input#
Filter#
Operator: value matches expressions of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: value matches expressions of
Path: Communication
Filter:
Output#
Operator: value matches conditions of#
Evaluates each value of dictionary elements, and returns a set of the elements matched to conditions given in a filter. See `Filter Syntax` for the details of `conditions`.
Filter Format:
conditions
Example 1#
Input#
Filter#
Operator: value matches conditions of
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: value matches conditions of
Path:
Filter:
Output#
Operator: json: encode array#
Returns an string in JSON which is encoded the entire value.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|---|---|
| indent | int | The number of spaces per indent (Default: None) |
Example 1#
Input#
Filter#
Operator: json: encode array
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: json: encode array
Path:
Filter:
Output#
Operator: json: encode#
Encodes each element and returns a set of JSON-encoded string.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|---|---|
| indent | int | The number of spaces per indent (Default: None) |
Example 1#
Input#
Filter#
Operator: json: encode
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: json: encode
Path:
Filter:
Output#
Operator: json: decode#
Returns a set of JSON decoded-values from the each element.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|
(parameter is currently not required)
Example 1#
Input#
Filter#
Operator: json: decode
Path:
Filter:
Output#
Operator: base64: encode#
Encodes each element and returns a set of BASE64-encoded string.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|
(parameter is currently not required)
Example 1#
Input#
Filter#
Operator: base64: encode
Path:
Filter:
Output#
Operator: base64: decode#
Returns a set of BASE64 decoded-values from the each element.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|
(parameter is currently not required)
Example 1#
Input#
Filter#
Operator: base64: decode
Path:
Filter:
Output#
Operator: digest#
Create a set of secure hash value for each element.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|---|---|
| algorithm | string | Secure hash algorithm (Default: sha256). See python hashlib for algorithm names. |
Example 1#
Input#
Filter#
Operator: digest
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: digest
Path:
Filter:
Output#
Operator: is replaced with#
Replaces an entire value with a value given in a filter.
Filter Format:
<JSON value>
Example 1#
Input#
Filter#
Operator: is replaced with
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: is replaced with
Path:
Filter:
Output#
Operator: is updated with#
If both of the data types are `dicrionary`, all the elements given in a filter are added to the value. All the values are replaced with the value given the existing key. Otherwise, it is simply replaced with a value given in a filter.
Filter Format:
<JSON value>
Example 1#
Input#
Filter#
Operator: is updated with
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: is updated with
Path:
Filter:
Output#
Operator: appends#
Appends all the elements given in a filter to the value.
Filter Format:
<JSON value>
Example 1#
Input#
Filter#
Operator: appends
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: appends
Path:
Filter:
Output#
Operator: if-then-else#
Evaluates each element with `if` condition, and returns a set of the results of `then` or `else` operations. If `if` condition is not given or returns any value, `then` operation is executed, otherwise `else` operation is executed.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|---|---|
| if | expressions | (Optional) if condition |
| then | expressions | Conditions to execute if if condition is not given or returns any value. |
| else | expressions | (Optional) Conditions to execute if if returns null. |
| lhs | expressions | (Optional) The value used for the if condition instead of the current element. |
Example 1#
Input#
Filter#
Operator: if-then-else
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: if-then-else
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: if-then-else
Path:
Filter:
Output#
Example 4#
Input#
Filter#
Operator: if-then-else
Path:
ctx_demisto: (in dictionaly, not string)
Filter:
Output#
Operator: switch-case#
Performs expressions for the label whose `expressions` matches the value. If any of `expressions` doesn't match the value, `default` operation is executed.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|---|---|
| switch | dict[<label>, expressions] | (Optional) Patterns of conditions. |
| default | expressions | (Optional) Conditions to execute if it doesn't match all the switch conditions. |
| <label> | expressions | (Optional) Conditions to execute if it matches the conditions given in the label. |
Example 1#
Input#
Filter#
Operator: switch-case
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: switch-case
Path:
Filter:
Output#
Operator: collects values#
Returns a set of <value> of each element. A value is <value> for `dict`, otherwise element itself.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|
(parameter is currently not required)
Example 1#
Input#
Filter#
Operator: collects values
Path:
Filter: {}
Output#
Example 2#
Input#
Filter#
Operator: collects values
Path:
Filter: {}
Output#
Operator: collects keys#
Returns a set of <key> of each `dict` element.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|
(parameter is currently not required)
Example 1#
Input#
Filter#
Operator: collects keys
Path:
Filter: {}
Output#
Operator: flattens with values#
Returns a set of <value> of all the elements in the tree.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|
(parameter is currently not required)
Example 1#
Input#
Filter#
Operator: flattens with values
Path:
Filter: {}
Output#
Operator: flattens with keys#
Returns a set of <key> of all the `dict` elements in the tree.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|
(parameter is currently not required)
Example 1#
Input#
Filter#
Operator: flattens with keys
Path:
Filter: {}
Output#
Operator: abort#
Raises an exception and exit with the value filtered at the operator. This operator is available for troubleshooting and debugging.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|
(parameter is currently not required)
Example 1#
Filter#
Operator: abort
Path:
Filter:
Operator: email-header: decode#
Returns an string which is decoded with the email header encoding manner.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|
(parameter is currently not required)
Example 1#
Input#
Filter#
Operator: email-header: decode
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: email-header: decode
Path:
Filter:
Output#
Operator: regex: replace#
Evaluates the pattern matching, and returns the data given in "matched" or "unmatched" according to the result. Returns the data given in "matched" if matched, "unmatch" otherwise.
Filter Format:
dict[str,Any]
| Parameter | Data Type | Description |
|---|---|---|
| pattern | str | A pattern text in regex. |
| matched | Any | The data to return when matched. capture groups such as \1 are supported. |
| unmatched | Any | (Optional) The data to return when unmatched. If not specified, the value given will return. |
| caseless | bool | (Optional) true if the matching performs in case-insensitive, false means case-sensitive. The default value is false. |
| dotall | bool | (Optional) . (single dot) matches any of charactors excluding new line charactors by default. true if it matches any of the charactors including them. The default value is false. See re.DOTALL |
| multiline | bool | (Optional) true if the matching performs in multi-line mode, false otherwise. The default value is false. See re.MULTILINE |
Example 1#
Input#
Filter#
Operator: regex: replace
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: regex: replace
Path:
Filter:
Output#
Example 3#
Input#
Filter#
Operator: regex: replace
Path:
Filter:
Output#
Operator: is individually transformed with#
Transform each element with `transformers` given in a filter. See `Filter Syntax` for the details of `transformers`.
Filter Format:
transformers
Example 1#
Input#
Filter#
Operator: is individually transformed with
Path:
Filter:
Output#
Example 2#
Input#
Filter#
Operator: is individually transformed with
Path: File
Filter:
Output#
Example 3#
Input#
Filter#
Operator: is individually transformed with
Path:
Filter:
Output#
Example 4#
Input#
Filter#
Operator: is individually transformed with
Path:
Filter:
Output#
Operator: is collectively transformed with#
Transform elements with `transformers` given in a filter. The elements are handled and transformed as one value at the first level if the type of it is array. See `Filter Syntax` for the details of `transformers`.
Filter Format:
transformers
Example 1#
Input#
Filter#
Operator: is collectively transformed with
Path:
Filter: