Compartir a través de

EntityTypeDefinition interface

  • Reference
Package:
@azure/arm-customerinsights

Describes an entity.

Extends
MetadataDefinitionBase

Properties

apiEntitySetName

The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.
entityType

Type of entity.
fields

The properties of the Profile.
instancesCount

The instance count.
lastChangedUtc

The last changed time for the type definition. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.
schemaItemTypeLink

The schema org link. This helps ACI identify and suggest semantic models.
tenantId

The hub name. NOTE: This property will not be serialized. It can only be populated by the server.
timestampFieldName

The timestamp property name. Represents the time when the interaction or profile update happened.
typeName

The name of the entity.

Inherited Properties

attributes

The attributes for the Type.
description

Localized descriptions for the property.
displayName

Localized display names for the property.
largeImage

Large Image associated with the Property or EntityType.
localizedAttributes

Any custom localized attributes for the Type.
mediumImage

Medium Image associated with the Property or EntityType.
smallImage

Small Image associated with the Property or EntityType.

Property Details

apiEntitySetName

The api entity set name. This becomes the odata entity set name for the entity Type being referred in this object.

apiEntitySetName?: string

Property Value

string

entityType

Type of entity.

entityType?: EntityTypes

Property Value

EntityTypes

fields

The properties of the Profile.

fields?: PropertyDefinition[]

Property Value

PropertyDefinition[]

instancesCount

The instance count.

instancesCount?: number

Property Value

number

lastChangedUtc

The last changed time for the type definition. NOTE: This property will not be serialized. It can only be populated by the server.

lastChangedUtc?: Date

Property Value

Date

provisioningState

Provisioning state. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

The schema org link. This helps ACI identify and suggest semantic models.

schemaItemTypeLink?: 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

timestampFieldName

The timestamp property name. Represents the time when the interaction or profile update happened.

timestampFieldName?: string

Property Value

string

typeName

The name of the entity.

typeName?: string

Property Value

string

Inherited Property Details

attributes

The attributes for the Type.

attributes?: {[propertyName: string]: string[]}

Property Value

{[propertyName: string]: string[]}

Inherited From MetadataDefinitionBase.attributes

description

Localized descriptions for the property.

description?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From MetadataDefinitionBase.description

displayName

Localized display names for the property.

displayName?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From MetadataDefinitionBase.displayName

largeImage

Large Image associated with the Property or EntityType.

largeImage?: string

Property Value

string

Inherited From MetadataDefinitionBase.largeImage

localizedAttributes

Any custom localized attributes for the Type.

localizedAttributes?: {[propertyName: string]: {[propertyName: string]: string}}

Property Value

{[propertyName: string]: {[propertyName: string]: string}}

Inherited From MetadataDefinitionBase.localizedAttributes

mediumImage

Medium Image associated with the Property or EntityType.

mediumImage?: string

Property Value

string

Inherited From MetadataDefinitionBase.mediumImage

smallImage

Small Image associated with the Property or EntityType.

smallImage?: string

Property Value

string

Inherited From MetadataDefinitionBase.smallImage