Accelerate the Value of Data

Get by crosswalk connection

Learn about using this API to view the relationships a given crosswalk may have as either a start or end entity.

The body of the request specifies the search parameters. The main section in the request refers to the connections that the crosswalk itself is connected to. The nested section in the request searches for entity connections found using the main section of the request.

Request

POST {TenantURL}/entities/_byCrosswalkConnections/{crosswalkValue}?type={sourceType}
Table 1. Parameters
ParametersName Required Description
HeadersAuthorizationYes Information about authentication access token in format "Bearer <accessToken>". For more information, see Authentication API.
QuerycrosswalkValueYesThe ID of this object in the source system defined in the property type. This property is required only for entities.

For example, an entity comes from the Facebook source system and its identifier in Facebook is id3562. For this entity, the crosswalk has a configuration/sources/Facebook type with a id3562 value and a https://www.facebook.com/id3562 URL.

sourceTypeYesThe source type of the crosswalk. This is a reference to the source configuration by its URI. A crosswalk can have only one source.
sourceTableNoThe value of the sourceTable parameter of the crosswalk.
optionsNoUse the searchByOv value to search for an attribute using their OV value in the response.

Sample Request and Response

POST {TenantURL}/entities/_byCrosswalkConnections/{crosswalkValue}?type={sourceType}
Headers: Authorization: Bearer c3f28fdd-e082-4f90-8840-9896914eaf41
{
    "main": {
        "inRelations": [
            "configuration/relationTypes/HasAddress"
        ]
    },
    "nested": [
        {
            "outRelations": [
                "configuration/relationTypes/HasAddress"
            ]
        },
        {
            "inRelations": [
                "configuration/relationTypes/Parent"
            ]
        }
    ]
}
{
    "entities": [
        {
            "uri": "entities/1",
            "type": "configuration/entityTypes/Individual",
            "createdBy": "jon",
            "createdTime": 1665431046919,
            "updatedBy": "jon",
            "updatedTime": 1665431046919,
            "attributes": {
                "FirstName": [
                    {
                        "type": "configuration/entityTypes/Individual/attributes/FirstName",
                        "ov": true,
                        "value": "Doe",
                        "uri": "entities/1/attributes/FirstName/0"
                    }
                ]
            },
            "crosswalks": [
                {
                    "uri": "entities/1/crosswalks/5",
                    "type": "configuration/sources/MDM",
                    "value": "1",
                    "reltioLoadDate": "2022-10-10T19:44:06.919Z",
                    "createDate": "2022-10-10T19:44:06.919Z",
                    "updateDate": "2022-10-10T19:44:06.919Z",
                    "attributes": [
                        "entities/1/attributes/FirstName/0"
                    ],
                    "singleAttributeUpdateDates": {}
                }
            ]
        },
        {
            "uri": "entities/A2",
            "type": "configuration/entityTypes/Location",
            "createdBy": "jon",
            "createdTime": 1665431046919,
            "updatedBy": "jon",
            "updatedTime": 1665431046919,
            "attributes": {
                "Street": [
                    {
                        "type": "configuration/entityTypes/Location/attributes/Street",
                        "ov": true,
                        "value": "Dorian 10",
                        "uri": "entities/A2/attributes/Street/59"
                    }
                ]
            },
            "crosswalks": [
                {
                    "uri": "entities/A2/crosswalks/60",
                    "type": "configuration/sources/MDM",
                    "value": "A2",
                    "reltioLoadDate": "2022-10-10T19:44:06.919Z",
                    "createDate": "2022-10-10T19:44:06.919Z",
                    "updateDate": "2022-10-10T19:44:06.919Z",
                    "attributes": [
                        "entities/A2/attributes/Street/59"
                    ],
                    "singleAttributeUpdateDates": {}
                },
                {
                    "uri": "entities/A2/crosswalks/61",
                    "type": "configuration/sources/Reltio",
                    "value": "A2",
                    "reltioLoadDate": "2022-10-10T19:44:06.919Z",
                    "createDate": "2022-10-10T19:44:06.919Z",
                    "updateDate": "2022-10-10T19:44:06.919Z",
                    "attributes": [
                        "entities/A2/attributes/Street/59"
                    ],
                    "singleAttributeUpdateDates": {}
                }
            ]
        },
        {
            "uri": "entities/2",
            "type": "configuration/entityTypes/Individual",
            "createdBy": "jon",
            "createdTime": 1665431046919,
            "updatedBy": "jon",
            "updatedTime": 1665431046919,
            "attributes": {
                "FirstName": [
                    {
                        "type": "configuration/entityTypes/Individual/attributes/FirstName",
                        "ov": true,
                        "value": "Victor",
                        "uri": "entities/2/attributes/FirstName/7"
                    }
                ]
            },
            "crosswalks": [
                {
                    "uri": "entities/2/crosswalks/12",
                    "type": "configuration/sources/MDM",
                    "value": "2",
                    "reltioLoadDate": "2022-10-10T19:44:06.919Z",
                    "createDate": "2022-10-10T19:44:06.919Z",
                    "updateDate": "2022-10-10T19:44:06.919Z",
                    "attributes": [
                        "entities/2/attributes/FirstName/7"
                    ]
                }
            ]
        }
    ],
    "relations": [
        {
            "uri": "relations/PA1",
            "type": "configuration/relationTypes/Parent",
            "startObject": {
                "objectURI": "entities/2"
            },
            "endObject": {
                "objectURI": "entities/1"
            }
        },
        {
            "uri": "relations/HA1",
            "type": "configuration/relationTypes/HasAddress",
            "startObject": {
                "objectURI": "entities/1"
            },
            "endObject": {
                "objectURI": "entities/A2"
            }
        }
    ]
}