RelationshipLink Type Definition

[This topic is pre-release documentation and is subject to change.]

A Relationship Link represents an explicit connection between a Relationship and an Interaction type. A relationship can be created or updated by the data that originates in an interaction and flows through a relationship link.

Relationship link types can be programmatically managed through either the ARM Type Modeling APIs or the Hub Type Modeling APIs.

Properties

Property names appended with asterisks* are required.

RelationshipLinkDefinition properties:

Property JSON type Description
displayName Dictionary<string,string> The localized display name
description Dictionary<string,string> The localized description
interactionType* string Interaction entity type associated with the link
linkName* string Name of the link (readonly)
mappings RelationshipLinkFieldMapping[ ] Associations between Interaction and Relationship properties (see below)
profilePropertyReferences* ParticipantPropertyReference[ ] Property references for the Profile of the Relationship (see below)
provisioningState string ["Provisioning" | "Succeeded" | "Expiring" | "Deleting" | "HumanIntervention" | "Failed" ]
relatedProfilePropertyReferences* ParticipantPropertyReference[ ] Property references for the Related Profile of the Relationship (see below)
relationshipName* string Relationship associated with the link
relationshipGuidId string (GUID) Relationship guid id (readonly)
tenantId string Hub name


RelationshipLinkFieldMapping properties

Property JSON type Description
interactionFieldName* string Property name in the Interaction type
linkType string [ "UpdateAlways" | "CopyIfNull" ]
relationshipFieldName* string Name of the Relationship metadata


ParticipantPropertyReference properties

Property JSON type Description
interactionPropertyName* string Interaction property that maps to the Profile property
profilePropertyName* string Profile property that maps to the Interaction property

JSON example

{
    "description": {
        "en-us": "Link Description"
    },
    "displayName": {
        "en-us": "Link DisplayName"
    },
    "interactionType": "testInteraction4332",
    "linkName": "testlink002",
    "profilePropertyReferences": [{
        "interactionPropertyName": "profile1",
        "profilePropertyName": "ProfileId"
    }],
    "provisioningState": "Provisioning",
    "relatedProfilePropertyReferences": [{
        "interactionPropertyName": "profile1",
        "profilePropertyName": "ProfileId"
    }],
    "relationshipName": "testProfile2326994",
    "tenantId": "sdktesthub"
}