msdyn_KPIEventData Entity Reference for Dynamics 365 Channel Integration Framework 2.0

Primary entity for a kpi event

Added by: Channel API Integration Framework Analytics Solution

Messages

Message	Web API Operation	SDK Assembly
Assign	PATCH [org URI]/api/data/v9.0/msdyn_kpieventsdata(msdyn_kpieventdataid)	AssignRequest
Create	POST [org URI]/api/data/v9.0/msdyn_kpieventsdata	CreateRequest or Create
Delete	DELETE [org URI]/api/data/v9.0/msdyn_kpieventsdata(msdyn_kpieventdataid)	DeleteRequest or Delete
GrantAccess	GrantAccess Action	GrantAccessRequest
IsValidStateTransition	IsValidStateTransition Function	IsValidStateTransitionRequest
ModifyAccess	ModifyAccess Action	ModifyAccessRequest
Retrieve	GET [org URI]/api/data/v9.0/msdyn_kpieventsdata(msdyn_kpieventdataid)	RetrieveRequest or Retrieve
RetrieveMultiple	GET [org URI]/api/data/v9.0/msdyn_kpieventsdata	RetrieveMultipleRequest or RetrieveMultiple
RetrievePrincipalAccess	RetrievePrincipalAccess Function	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccess Function	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess	RevokeAccess Action	RevokeAccessRequest
SetState	PATCH [org URI]/api/data/v9.0/msdyn_kpieventsdata(msdyn_kpieventdataid)	SetStateRequest
Update	PATCH [org URI]/api/data/v9.0/msdyn_kpieventsdata(msdyn_kpieventdataid)	UpdateRequest or Update

Entity Properties

Property	Value
CollectionSchemaName	msdyn_KPIEventDatas
DisplayCollectionName	KPI Event Data
DisplayName	KPI Event Data
EntitySetName	msdyn_kpieventsdata
IsBPFEntity	False
LogicalCollectionName	msdyn_kpieventdatas
LogicalName	msdyn_kpieventdata
OwnershipType	UserOwned
PrimaryIdAttribute	msdyn_kpieventdataid
PrimaryNameAttribute	msdyn_name
SchemaName	msdyn_KPIEventData

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

• ImportSequenceNumber
• msdyn_AdditionalData
• msdyn_cifSessionId
• msdyn_ClientSessionId
• msdyn_ConversationId
• msdyn_CustomAttribute1
• msdyn_CustomAttribute2
• msdyn_CustomAttribute3
• msdyn_CustomAttribute4
• msdyn_CustomAttribute5
• msdyn_EventTimestamp
• msdyn_ExternalCorrelationId
• msdyn_KPIEventDataId
• msdyn_KPIEventId
• msdyn_KPIEventName
• msdyn_KPIEventReason
• msdyn_Name
• msdyn_ParticipantId
• msdyn_ProviderId
• msdyn_ProviderSessionId
• msdyn_sessionId
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

ImportSequenceNumber

Property	Value
Description	Sequence number of the import that created this record.
DisplayName	Import Sequence Number
Format	None
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	importsequencenumber
MaxValue	2147483647
MinValue	-2147483648
RequiredLevel	None
Type	Integer

msdyn_AdditionalData

Property	Value
Description	Other data related to the kpi event
DisplayName	Other Data
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_additionaldata
MaxLength	2000
RequiredLevel	None
Type	String

msdyn_cifSessionId

Property	Value
Description	Unique identifier for Channel Integration Framework session
DisplayName	User Session ID
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_cifSessionId
MaxLength	100
RequiredLevel	None
Type	String

msdyn_ClientSessionId

Property	Value
Description	Client session identifier
DisplayName	Client Session ID
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_clientsessionid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_ConversationId

Property	Value
Description	Conversation Identifier
DisplayName	Conversation ID
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_conversationid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_CustomAttribute1

Property	Value
Description	Custom Attribute 1
DisplayName	Custom Attribute 1
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customattribute1
MaxLength	100
RequiredLevel	None
Type	String

msdyn_CustomAttribute2

Property	Value
Description	Custom Attribute 2
DisplayName	Custom Attribute 2
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customattribute2
MaxLength	100
RequiredLevel	None
Type	String

msdyn_CustomAttribute3

Property	Value
Description	Custom Attribute 3
DisplayName	Custom Attribute 3
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customattribute3
MaxLength	100
RequiredLevel	None
Type	String

msdyn_CustomAttribute4

Property	Value
Description	Custom Attribute 4
DisplayName	Custom Attribute 4
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customattribute4
MaxLength	100
RequiredLevel	None
Type	String

msdyn_CustomAttribute5

Property	Value
Description	Custom Attribute 5
DisplayName	Custom Attribute 5
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customattribute5
MaxLength	100
RequiredLevel	None
Type	String

msdyn_EventTimestamp

Property	Value
DateTimeBehavior	UserLocal
Description	Timestamp at which the event occurred
DisplayName	Event Timestamp
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_eventtimestamp
RequiredLevel	None
Type	DateTime

msdyn_ExternalCorrelationId

Property	Value
Description	External System Correlation ID
DisplayName	External Correlation ID
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_externalcorrelationid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_KPIEventDataId

Property	Value
Description	Unique identifier for entity instances
DisplayName	KPI Event Data ID
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_kpieventdataid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_KPIEventId

Property	Value
Description	Unique identifier for the KPI Event
DisplayName	KPI Event ID
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_kpieventid
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_KPIEventName

Property	Value
Description	Name of the associated KPI event
DisplayName	KPI Event Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_kpieventname
MaxLength	100
RequiredLevel	None
Type	String

msdyn_KPIEventReason

Property	Value
Description	Reason due to which the KPI event was created
DisplayName	KPI Event Reason
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_kpieventreason
MaxLength	100
RequiredLevel	None
Type	String

msdyn_Name

Property	Value
Description	Required name field
DisplayName	Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_name
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_ParticipantId

Property	Value
Description	Identifier of the agent for whom the event was fired
DisplayName	Participant ID
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_participantid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_ProviderId

Property	Value
Description	Unique identifier of the Provider that triggered this event
DisplayName	Provider ID
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_ProviderId
MaxLength	100
RequiredLevel	None
Type	String

msdyn_ProviderSessionId

Property	Value
Description	Unique identifier of the provider session
DisplayName	Provider Session ID
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_providersessionid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_sessionId

Property	Value
Description	Unique identifier for session
DisplayName	Session ID
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sessionId
MaxLength	100
RequiredLevel	None
Type	String

OverriddenCreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time that the record was migrated.
DisplayName	Record Created On
Format	DateOnly
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	overriddencreatedon
RequiredLevel	None
Type	DateTime

OwnerId

Added by: Active Solution Solution

Property	Value
Description	Owner ID
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	ownerid
RequiredLevel	SystemRequired
Targets	systemuser,team
Type	Owner

OwnerIdType

Added by: Active Solution Solution

Property	Value
Description	Owner Id Type
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridtype
RequiredLevel	SystemRequired
Type	EntityName

statecode

Property	Value
Description	Status of the KPI Event Data
DisplayName	Status
IsValidForCreate	False
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State

statecode Options

Value	Label	DefaultStatus	InvariantName
0	Active	1	Active
1	Inactive	2	Inactive

statuscode

Property	Value
Description	Reason for the status of the KPI Event Data
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status

statuscode Options

Value	Label	State
1	Active	0
2	Inactive	1

TimeZoneRuleVersionNumber

Property	Value
Description	For internal use only.
DisplayName	Time Zone Rule Version Number
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	timezoneruleversionnumber
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

UTCConversionTimeZoneCode

Property	Value
Description	Time zone code that was in use when the record was created.
DisplayName	UTC Conversion Time Zone Code
Format	None
IsValidForForm	False
IsValidForRead	True
LogicalName	utcconversiontimezonecode
MaxValue	2147483647
MinValue	-1
RequiredLevel	None
Type	Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningTeam
• OwningUser
• VersionNumber

CreatedBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the user who created the record.
DisplayName	Created By
IsValidForForm	True
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

CreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was created.
DisplayName	Created On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the delegate user who created the record.
DisplayName	Created By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

ModifiedBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the user who modified the record.
DisplayName	Modified By
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

ModifiedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when the record was modified.
DisplayName	Modified On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

Property	Value
Description	Unique identifier of the delegate user who modified the record.
DisplayName	Modified By (Delegate)
IsValidForForm	True
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyname
MaxLength	100
RequiredLevel	None
Type	String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfbyyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwnerIdName

Added by: Active Solution Solution

Property	Value
Description	Name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwnerIdYomiName

Added by: Active Solution Solution

Property	Value
Description	Yomi name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwningBusinessUnit

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	False
IsValidForRead	True
LogicalName	owningbusinessunit
RequiredLevel	None
Targets	businessunit
Type	Lookup

OwningTeam

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	owningteam
RequiredLevel	None
Targets	team
Type	Lookup

OwningUser

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	owninguser
RequiredLevel	None
Targets	systemuser
Type	Lookup

VersionNumber

Added by: Active Solution Solution

Property	Value
Description	Version Number
DisplayName	Version Number
IsValidForForm	False
IsValidForRead	True
LogicalName	version number
MaxValue	9223372036854775807
MinValue	-9223372036854775808
RequiredLevel	None
Type	BigInt

See also

Microsoft.CIFramework APIs

Client-side events