Property description
The selectByRelations stream selects the related objects based on the relation type.
Minimal JSON
{
"key": "",
"type": "selectByRelations",
"relationTypeKeys": [ ]
}Nested properties
| Property | Description | Values | Mandatory |
|---|---|---|---|
key | Unique key of the stream. | string | Yes |
type | selectByRelations | string | Yes |
relationTypeKeys | Keys of the relation types that the object participates in, which are used as criteria to filter out related objects. | array of string | Yes |
keepCurrent | Determines whether the automation also selects the current object along with its related objects. For more information, see Keep current example. | boolean | No |
keepOrigin | Determines whether the object ID from which the select started is remembered. | boolean | No |
objectTypeKeys | Keys of object types that can be selected. | array of strings | No |
Keep current example
We have the following relations with A being the starting point:
"keepCurrent": true
- First automation result: [A, B, C] = We select the object and all its related objects.
"keepCurrent": false
- First automation result: [B, C] = We discard [A] and only return the related objects [B, C].