Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

[Property]="Text"

[Property]=Numeric Value

...

Identify the Columns to Filter on

Populate the property name value that corresponds with metadata content column.

Code Block
{
"transfer" : {
"metadata_map": {
                "schemas": [
                    {
                        "mappings": [
                            {
                                "source": {
                                    "property": {
                                        "name": "LName",
                                        "type": "string"
                                    }
                                },
                                "destination": {
                                    "property": {
                                        "name": "LName",
                                        "type": "string"
                                    }
                                }
                            }
                        ]
                    }
                ]
            }
}
}

...

Filter Using REST API

If the target platform does not support metadata, the filter or text definition for the given connection will be ignored.

...

Operator (filter:op)

Description

Equivalent TextText Operators

Filter Example

Text Example

Code Block
eq

equals

Code Block
=
Code Block
"filter": { 
  "name": "ProtectionLevel", 
  "op": "eq", 
  "value": "Sensitive" 
}

"[ProtectionLevel]=\"Sensitive\""

Code Block
ne

not equals

Code Block
<> or !=
Code Block
"filter": { 
  "name": "ProtectionLevel", 
  "op": "ne", 
  "value": "Sensitive" 
}

"[ProtectionLevel]!=\"Sensitive\""

Code Block
lt

less than

Code Block
<
Code Block
"filter": { 
  "name": "ProtectionLevel", 
  "op": "lt", 
  "value": 100 
}

"[ProtectionLevel]<100"

Code Block
le

less than or equal to

Code Block
<=

"filter": {
  "name": "ProtectionLevel", 
  "op": "le",
  "value": 100
}

"[ProtectionLevel]<=100"

Code Block
gt

greater than

Code Block
>

"filter": {
  "name": "ProtectionLevel", 
  "op": "gt",
  "value": 100
}

"[ProtectionLevel]>100"

Code Block
ge

greater than or equal to

Code Block
>=

"filter": {
  "name": "ProtectionLevel", 
  "op": "ge",
  "value": 100
}

"[ProtectionLevel]>=100"

Code Block
starts_with

starts with

= with * appended to the end of the value

"filter": {
  "name": "Author", 
  "op": "starts_with",
  "value": "John"
}

"text": "[Author]=\"John*\""

Code Block
not_starts_with

does not start with

<> or !=

"filter": {
  "name": "Author", 
  "op": "not_starts_with",
  "value": "John"
}

"text": "[Author]!=\"John*\""

Code Block
ends_with

ends with

= with * prepended to the beginning of the value

"filter": {
  "name": "Author", 
  "op": "ends_with",
  "value": "Anderson"
}

"text": "[Author]=\"*Anderson\""

Code Block
not_ends_with

does not end with

<> or !=

"filter": {
  "name": "Author", 
  "op": "not_ends_with",
  "value": "Anderson"
}

"text": "[Author]!=\"*Anderson\""

Code Block
contains

contains

Code Block
=

"filter": {
  "name": "Author", 
  "op": "contains",
  "value": "John"
}

"text": "[Author]=\"*John*\""

Code Block
not_contains

does not contain

<> or !=

"filter": {
  "name": "Author", 
  "op": "not_contains",
  "value": "John"
}

"text": "[Author]!=\"*John*\""

Code Block
in

includes all the values

Code Block
IN

"filter": {
  "name": "ProtectionLevel", 
  "op": "in",
  "value": ["Not Sensitive"]
}

"text": "[ProtectionLevel] IN (\"Not Sensitive\")"

Code Block
not_in

does not include all the values

Code Block
NOT IN

"filter": {
  "name": "ProtectionLevel", 
  "op": "not_in",
  "value": ["Sensitive", "Highly Sensitive"]
}

"text": "[ProtectionLevel] NOT IN (\"Sensitive\", \"Highly Sensitive\")"

Code Block
empty

the value is empty

<>"*" or !="*"

"filter": {
  "name": "Author", 
  "op": "empty",
  "value": ""
}

"text": "[Author]!=\"*\""

Code Block
not_empty

the value is not empty

Code Block
="*" 

"filter": {
  "name": "Author", 
  "op": "not_empty",
  "value": ""
}

"text": "[Author]=\"*\""

...

Code Block
{
	...
	"transfer": {
		...
		"filter": {
			"source": [{
					"action": "exclude",
					"rules": [{
						"text": "[ProtectionLevel]=\"Sensitive\"",
						"type": "filter_metadata"					
					}],
					"type": "filter_rule"
				}
			]
		}
	}
	...
}

...

Populate the property name value that corresponds with metadata content column.

Code Block
{
"transfer" : {
"metadata_map": {
                "schemas": [
                    {
                        "mappings": [
                            {
                                "source": {
      
                             "property": {
                                        "name": "LName",
                                        "type": "string"
                                    }
                                },
                                "destination": {
                                    "property": {
                                        "name": "LName",
                                        "type": "string"
                                    }
                                }
                            }
                        ]
                    }
                ]
            }
}
}

...