Reltio Connect

 View Only
  • 1.  Search Connection API reference attributes

    Posted 08-08-2023 14:43

    With the Search Connections API, I can search for an individual entity and get any account entities that are connected to it.

    However, neither the individuals nor accounts will have any reference attributes on them.

    Is there way to have the search connections API include reference attributes?

    I.e., can I make one API to search for individuals to get their connected accounts, and also include the reference attributes on the accounts? The reference attributes on the account may refer to other entities.



    ------------------------------
    Joseph Hoppe
    NJ
    ------------------------------


  • 2.  RE: Search Connection API reference attributes

    Reltio Employee
    Posted 10-09-2023 16:59

    Hello Joseph,

    Unfortunately, I don't believe reference attributes are currently supported within the Search Connections API. You may want to create an enhancement request for this behavior.

    As an alternative option, you can use the "Get By Crosswalk Connection" API which offers the ability to obtain the related objects of the related object as a separate entities within the response.

    Example: Individual > Organization > Affiliated Organization

    https://docs.reltio.com/en/explore/get-going-with-apis-and-rocs-utilities/reltio-rest-apis/model-apis/relations-api/get-by-crosswalk-connection

    Here is an example Payload Request Body:

        "main": {
            "inRelations": [
                {
                    "uri": "configuration/relationTypes/OrganizationIndividual"
                }
            ]
        },
        "nested": [
            {
                "outRelations": [
                    {
                        "uri": "configuration/relationTypes/OrganizationHasAddress"
                    }
                ]
            },
            {
                "outRelations": [
                    {
                        "uri": "configuration/relationTypes/OrganizationAffiliation"
                    }
                ]
            }
        ]
    }


    ------------------------------
    Bryant Barrenechea
    Solution Architect | Professional Services
    ------------------------------



  • 3.  RE: Search Connection API reference attributes

    Posted 10-10-2023 09:06

    Hi Bryant,

    Since then, I was able to use the findConnectedParties API call to accomplish this.

    But thank you for sharing. Will keep it in mind for the future!



    ------------------------------
    Joseph Hoppe
    NJ
    ------------------------------



  • 4.  RE: Search Connection API reference attributes

    Reltio Employee
    Posted 10-11-2023 02:51

    Hi Joseph,

    You might not need it now but for future reference, with our 23.3 GA release (16th Oct) we plan to enhance the _searchConnections and _byCrosswalkConnections to return reference attributes using a new parameter returnReferenceAttributes.

    It is "false" by default - in this case the APIs would have the same behavior as now. If it is specified as "true" then all entities in the response will be populated with their reference attributes.

    Hope that helps. We will publish the documentation along with the release

    Thanks



    ------------------------------
    Saurabh Agarwal
    ------------------------------