RelationshipLinkResourceFormat interface
The relationship link resource format.
- Extends
Properties
description | Localized descriptions for the Relationship Link. |
display |
Localized display name for the Relationship Link. |
interaction |
The InteractionType associated with the Relationship Link. |
link |
The name of the Relationship Link. NOTE: This property will not be serialized. It can only be populated by the server. |
mappings | The mappings between Interaction and Relationship fields. |
profile |
The property references for the Profile of the Relationship. |
provisioning |
Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server. |
related |
The property references for the Related Profile of the Relationship. |
relationship |
The relationship guid id. NOTE: This property will not be serialized. It can only be populated by the server. |
relationship |
The Relationship associated with the Link. |
tenant |
The hub name. NOTE: This property will not be serialized. It can only be populated by the server. |
Inherited Properties
id | Resource ID. NOTE: This property will not be serialized. It can only be populated by the server. |
name | Resource name. NOTE: This property will not be serialized. It can only be populated by the server. |
type | Resource type. NOTE: This property will not be serialized. It can only be populated by the server. |
Property Details
description
Localized descriptions for the Relationship Link.
description?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
displayName
Localized display name for the Relationship Link.
displayName?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
interactionType
The InteractionType associated with the Relationship Link.
interactionType?: string
Property Value
string
linkName
The name of the Relationship Link. NOTE: This property will not be serialized. It can only be populated by the server.
linkName?: string
Property Value
string
mappings
The mappings between Interaction and Relationship fields.
mappings?: RelationshipLinkFieldMapping[]
Property Value
profilePropertyReferences
The property references for the Profile of the Relationship.
profilePropertyReferences?: ParticipantProfilePropertyReference[]
Property Value
provisioningState
Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: string
Property Value
string
relatedProfilePropertyReferences
The property references for the Related Profile of the Relationship.
relatedProfilePropertyReferences?: ParticipantProfilePropertyReference[]
Property Value
relationshipGuidId
The relationship guid id. NOTE: This property will not be serialized. It can only be populated by the server.
relationshipGuidId?: string
Property Value
string
relationshipName
The Relationship associated with the Link.
relationshipName?: string
Property Value
string
tenantId
The hub name. NOTE: This property will not be serialized. It can only be populated by the server.
tenantId?: string
Property Value
string
Inherited Property Details
id
Resource ID. NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
Inherited From ProxyResource.id
name
Resource name. NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From ProxyResource.name
type
Resource type. NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From ProxyResource.type