...
Long | Short | Definition | Multivalued |
---|---|---|---|
equals | eq | Equals to | yes |
notequals | neq | Not equals to | yes |
empty | e | Void or null | no |
notempty | ne | Non void and non null | no |
in | in | Belongs to | yes |
notin | nin | Does not belong to | yes |
startswith | sw | Starts with | yes |
notstartswith | nsw | Does not start with | yes |
endswith | ew | Ends with | yes |
notendswith | new | Does not end with | yes |
contains | ct | Contains | yes |
notcontains | nct | Does not contain | yes |
...
all
All fields match the rule.
Attribute:
type: all
exclude: true or false
Example:
Code Block { "type": "all", "exclude": true }
exported
All fields the end point configuration exports match the rule
Attributes:
type: exported
exclude: true or false
Example:
Code Block { "type": "exported", "exclude": false }
name
The rule selects the fields whose name corresponds to the value of the value attribute
Attributes:
type: exported
value: the name of the field to select
exclude: true or false
Example:
Code Block { "type": "name", "value": "created" }
type
The rule matching is done using the type of the field
Attributes:
type: type
value: a type selector
exclude: true or false
Types
boolean: child to nature activated
date: any date (types date or dater)
datetime: datetime
string: string (types data or sentence)
binary: types file or image
child: type child
id: any single id (types identifier or child)
collection: type collection
number: any number (types integer, decimal or money)
relational: any relational type (child, childmulti…)
prelational: any relational type (child, childmulti…) except boolean
plaintext: any plain text (types data, sentence or text)
anytext: any text (types data, sentence, text or html)
status: a workflow field
anytree: a general tree field (tag arbo_field or thesaurus/broaderterm)
tree: a tree field (tag arbo_field)
thesaurus: a thesaurus field
listable: a field configured to be in datalist
viewable: a field configured to be in dataview
indexed: an indexed field
editable: an editable field (to be editable in dataedit)
mandatory: a mandatory field
groupable: a groupable field
i18nfor: a field that is a translation
i18n: a field that has translations
attachment: a binary or image field that is attachment
identifier: id field
identity: a field with the type identity
data or word: a field with the type data
sentence: a field with the type sentence
integer: a field with the type integer
decimal: a field with the type decimal
money : a field with type money
html: a field with the type html
file: a field with the type file
image: a field with the type image
text: a field with the type text
Example:
Code Block { "type": "type", "value": "child" }
tag
The rule selects the fields with the specified tag
Attributes:
type: exported
value: the tag
exclude: true or false
Example:
Code Block { "type": "tag", "value": "rest_api_query/allowed" }
nature
The rule selects the fields with the specified nature (implies, necessarily, a relational field).
Attributes:
type: exported
value: the nature
exclude: true or false
Example:
Code Block { "type": "nature", "value": "assetformat" }
naturetag
The rule selects the fields with a nature that has the specified tag (implies, necessarily, a relational field).
Attributes:
type: exported
value: the tag of nature
exclude: true or false
Example:
Code Block { "type": "naturetag", "value": "damobject" }
lang
The rule selects the fields with the specified language (implies, necessarily, a translation field).
Attributes:
type: exported
value: the code of the language (ISO 639-1)
exclude: true or false
Example:
Code Block { "type": "lang", "value": "en" }
i18nfor
The rule selects the fields that are a translation for the specified field
Attributes:
type: exported
value: name of translated field
exclude: true or false
Example:
Code Block { "type": "i18nfor", "value": "name" }
and
Combine several rules with the and operator (all rules must match)
Attributes:
type: and
value: a rule array
exclude: true or false
Example:
Code Block { "type": "and", "value": [ { "type":"exported" }, { "type":"type", "value":"string" ] ] }
or
Combine several rules with the or operator (one rule has to match)
Attributes:
type: and
value: a rule array
exclude: true or false
Example:
Code Block { "type": "or", "value": [ { "type":"name", "value":"created" }, { "type":"name", "value":"modified" } ] }
not
Negate the matching function of a rule.
Attributes:
type: not
value: a rule
exclude: true or false
Example:
Code Block { "type": "not", "value": { "type":"name", "value":"name" }, "exclude":true }
examples
Not any rules: all fields prohibited
...