Nested Attributes

Learn about handling Nested Attributes' parameters.

The enableNestedPartialOverride parameter must be set to true. Additionally, the values of keyAttributeURIs and matchFieldURIs, specified in the business configuration for the Nested attribute, affect the generated changes, and the results of partial override with DCR.

The Reference attribute type enables you to use attributes from one entity type on another entity type. Promoting attribute reuse saves you time. It streamlines the definition of relationships between entity types in your data model. For more information on the Reference attribute type, see section Reference attribute type.

The following sequence is followed for partial override with DCR over a Nested attribute:

If keyAttributeURIs is set in L3, the system looks for required Nested attribute using keyAttributeURIs.
1. If it is found: the sub-attributes of the nested attribute can be changed, removed or added, which creates DELETE_ATTRIBUTE + INSERT_ATTRIBUTE, DELETE_ATTRIBUTE and INSERT_ATTRIBUTE changes in DCR accordingly. The system then searches among the other nested attribute values for a match by the set of attributes, specified in matchFieldURIs. If it is found, the values are merged, and the DELETE_ATTRIBUTE change is generated for one of the merged values.
2. If it is not found: a new value is added to the nested attribute. The INSERT_ATTRIBUTE change is generated.
3. If it is not set in a request: a new value is inserted to the nested attribute. The INSERT_ATTRIBUTE change is generated.
If only matchFieldURIs is set in L3: the system tries to find matches with other values of the nested attribute inside the entity. If it is found, the values are merged, and the INSERT_ATTRIBUTE change for sub-attributes different from the existing ones is generated.
If both keyAttributeURIs and matchFieldURIs are not set in L3: a new value is inserted to the nested attribute and the INSERT_ATTRIBUTE change is generated. In this case, inheritance should be considered.

Multi-nested Attributes

The nested sub-attributes of a nested attribute (multi-nested attribute) are considered as its other sub-attributes, they also depend on the specified keyAttributesURIs and matchFieldURIs for the first level nested attribute.

When keyAttributeURIs is specified for Nested Level1

keyAttributesURIs and matchFieldURIs configuration

For License:

"keyAttributeURIs": [
"configuration/entityTypes/HCP/attributes/License/attributes/Number"
],
"matchFieldURIs": [
"configuration/entityTypes/HCP/attributes/License/attributes/Number"
]

For License.LicenseDates:

"matchFieldURIs": [
"configuration/entityTypes/HCP/attributes/License/attributes/LicenseDates/attributes/ExpirationDate"
]

Initial Entity

[
    {
        "type": "configuration/entityTypes/HCP",
        "attributes": {
            "FirstName": [
                {
                    "value": "FirstNameValue1"
                }
            ],
            "License": [
                {
                    "value": {
                        "Category": [
                            {
                                "value": "CategoryValue1"
                            }
                        ],
                        "Number": [
                            {
                                "value": "NumberValue1"
                            }
                        ],
                        "LicenseDates": [
                            {
                                "value": {
                                    "ExpirationDate": [
                                        {
                                            "value": "2022-01-15"
                                        }
                                    ],
                                    "IssueDate": [
                                        {
                                            "value": "2020-09-13"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        },
        "crosswalks": [
            {
                "type": "configuration/sources/HMS",
                "value": "123"
            }
        ]
    }
]

Request for Partial Override with DCR

[
    {
        "type": "configuration/entityTypes/HCP",
        "attributes": {
            "License": [
                {
                    "value": {
                        "Number": [
                            {
                                "value": "NumberValue1"
                            }
                        ],
                        "LicenseDates": [
                            {
                                "value": {
                                    "ExpirationDate": [
                                        {
                                            "value": "2022-01-20"
                                        }
                                    ],
                                    "IssueDate": [
                                        {
                                            "value": "2020-09-13"
                                        }
                                    ]
                                }
                            }
                        ]
                    }
                }
            ]
        },
        "crosswalks": [
            {
                "type": "configuration/sources/HMS",
                "value": "123"
            }
        ]
    }
]

Response

{
    "uri": "changeRequests/4kdWV9ea",
    "createdBy": "ReltioUser",
    "createdTime": 1606338867093,
    "updatedBy": "ReltioUser",
    "updatedTime": 1606338867093,
    "changes": {
        "entities/1dDd4eKJ": [
            {
                "id": "4kdWVDuq",
                "type": "INSERT_ATTRIBUTE",
                "createdTime": 1606338867093,
                "createdBy": "ReltioUser",
                "attributePath": "License/2Ty8MesjT/LicenseDates",
                "newValue": {
                    "value": {
                        "ExpirationDate": [
                            {
                                "value": "2022-01-20"
                            }
                        ],
                        "IssueDate": [
                            {
                                "value": "2020-09-13"
                            }
                        ]
                    }
                },
                "crosswalk": {
                    "type": "configuration/sources/HMS",
                    "value": "123",
                    "dataProvider": true
                },
                "attributeType": "configuration/entityTypes/HCP/attributes/License/attributes/LicenseDates"
            },
            {
                "id": "4kdWVIB6",
                "type": "DELETE_ATTRIBUTE",
                "createdTime": 1606338867093,
                "createdBy": "ReltioUser",
                "attributePath": "License/2Ty8MesjT/LicenseDates/2Ty8Mf5WF",
                "oldValue": {
                    "value": {
                        "ExpirationDate": [
                            {
                                "value": "2022-01-15"
                            }
                        ],
                        "IssueDate": [
                            {
                                "value": "2020-09-13"
                            }
                        ]
                    }
                },
                "crosswalk": {
                    "type": "configuration/sources/HMS",
                    "value": "123",
                    "dataProvider": true
                },
                "attributeType": "configuration/entityTypes/HCP/attributes/License/attributes/LicenseDates"
            }
        ]
    },
    "type": "configuration/changeRequestTypes/someChangeRequestType",
    "state": "AWAITING_REVIEW"
}

The Entity after DCR is applied

{
    "uri": "entities/1dDd4eKJ",
    "type": "configuration/entityTypes/HCP",
    "createdBy": "ReltioUser",
    "createdTime": 1606338843982,
    "updatedBy": "ReltioUser",
    "updatedTime": 1606339035782,
    "attributes": {
        "FirstName": [
            {
                "type": "configuration/entityTypes/HCP/attributes/FirstName",
                "ov": true,
                "value": "FirstNameValue1",
                "uri": "entities/1dDd4eKJ/attributes/FirstName/2Ty8MeoTD"
            }
        ],
        "License": [
            {
                "label": "NumberValue1, state",
                "value": {
                    "Category": [
                        {
                            "type": "configuration/entityTypes/HCP/attributes/License/attributes/Category",
                            "ov": true,
                            "value": "CategoryValue1",
                            "uri": "entities/1dDd4eKJ/attributes/License/2Ty8MesjT/Category/2Ty8Mewzj"
                        }
                    ],
                    "Number": [
                        {
                            "type": "configuration/entityTypes/HCP/attributes/License/attributes/Number",
                            "ov": true,
                            "value": "NumberValue1",
                            "uri": "entities/1dDd4eKJ/attributes/License/2Ty8MesjT/Number/2Ty8Mf1Fz"
                        }
                    ],
                    "LicenseDates": [
                        {
                            "label": "",
                            "value": {
                                "ExpirationDate": [
                                    {
                                        "type": "configuration/entityTypes/HCP/attributes/License/attributes/LicenseDates/attributes/ExpirationDate",
                                        "ov": true,
                                        "value": "2022-01-20",
                                        "uri": "entities/1dDd4eKJ/attributes/License/2Ty8MesjT/LicenseDates/2NWvAYPTY/ExpirationDate/2NWvAYTjo"
                                    }
                                ],
                                "IssueDate": [
                                    {
                                        "type": "configuration/entityTypes/HCP/attributes/License/attributes/LicenseDates/attributes/IssueDate",
                                        "ov": true,
                                        "value": "2020-09-13",
                                        "uri": "entities/1dDd4eKJ/attributes/License/2Ty8MesjT/LicenseDates/2NWvAYPTY/IssueDate/2NWvAYY04"
                                    }
                                ]
                            },
                            "ov": true,
                            "uri": "entities/1dDd4eKJ/attributes/License/2Ty8MesjT/LicenseDates/2NWvAYPTY"
                        }
                    ]
                },
                "ov": true,
                "uri": "entities/1dDd4eKJ/attributes/License/2Ty8MesjT"
            }
        ]
    },
    "isFavorite": false,
    "crosswalks": [
        {
            "uri": "entities/1dDd4eKJ/crosswalks/2Ty8MfIJ1",
            "type": "configuration/sources/HMS",
            "value": "123",
            "reltioLoadDate": "2020-11-25T21:17:15.782Z",
            "createDate": "2020-11-25T21:14:03.982Z",
            "updateDate": "2020-11-25T21:14:03.982Z",
            "attributes": [
                "entities/1dDd4eKJ/attributes/License/2Ty8MesjT/Category/2Ty8Mewzj",
                "entities/1dDd4eKJ/attributes/License/2Ty8MesjT/LicenseDates/2NWvAYPTY",
                "entities/1dDd4eKJ/attributes/License/2Ty8MesjT/Number/2Ty8Mf1Fz",
                "entities/1dDd4eKJ/attributes/License/2Ty8MesjT/LicenseDates/2NWvAYPTY/ExpirationDate/2NWvAYTjo",
                "entities/1dDd4eKJ/attributes/FirstName/2Ty8MeoTD",
                "entities/1dDd4eKJ/attributes/License/2Ty8MesjT",
                "entities/1dDd4eKJ/attributes/License/2Ty8MesjT/LicenseDates/2NWvAYPTY/IssueDate/2NWvAYY04"
            ],
            "singleAttributeUpdateDates": {}
        }
    ],
    "analyticsAttributes": {},
    "label": "FirstNameValue1",
    "secondaryLabel": ""
}

When keyAttributeURIs is not specified for Nested Level1