Comment on page

Relationship

Discover more about the Relationship component and how to use it on the Digibee Integration Platform.

Relationship component creates relations between 1 or more entities so that searches in different bases can be made.
Important: the component doesn't support concurrent accesses while trying to update or save new relations.
Parameters
Take a look at the configuration parameters of the component. Parameters supported by Double Braces expressions are marked with (DB).
Parameter
Description
Default value
Data type
Operation
Operation to be executed (Match, Create, Update, Get By Field And Value, Translate, and Delete Exact).
Translate
String
Relation Name
Name given to the created relation.
N/A
String
Translate Path
Path through which the component searches the IDs to be translated.
relation.obj.id
String
From
Origin of the search.
teste
String
To
Destination of the search.
N/A
String
Fail On Error
If the option is enabled, the execution of the pipeline with an error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property.
True
Boolean
Operations
Match: searches a match between 2 fields and the declared value.
Create: creates a relation by the field.
Update: update an existing relation by the field.
Get by field and value: searches a relation between the field and its value.
Translate: translates an IDs list based on the path specified in "Translate Path".
Delete Exact: delete an exact relation in all the declared fields.
Important: it's necessary to declare the query inside the relation object:
{
    relation : {
        field1: value
        field2: value
    }
}

Parameter	Description	Default value	Data type
Operation	Operation to be executed (Match, Create, Update, Get By Field And Value, Translate, and Delete Exact).	Translate	String
Relation Name	Name given to the created relation.	N/A	String
Translate Path	Path through which the component searches the IDs to be translated.	relation.obj.id	String
From	Origin of the search.	teste	String
To	Destination of the search.	N/A	String
Fail On Error	If the option is enabled, the execution of the pipeline with an error will be interrupted; otherwise, the pipeline execution proceeds, but the result will show a false value for the “success” property.	True	Boolean

Last modified 18d ago