msdyn_sessiontemplate Entity Reference for Dynamics 365 Channel Integration Framework 2.0

Added by: App profile manager Solution

Messages

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

Entity Properties

Property	Value
CollectionSchemaName	msdyn_sessiontemplates
DisplayCollectionName	Session Templates
DisplayName	Session Template
EntitySetName	msdyn_sessiontemplates
IsBPFEntity	False
LogicalCollectionName	msdyn_sessiontemplates
LogicalName	msdyn_sessiontemplate
OwnershipType	UserOwned
PrimaryIdAttribute	msdyn_sessiontemplateid
PrimaryNameAttribute	msdyn_name
SchemaName	msdyn_sessiontemplate

Writable attributes

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

• ImportSequenceNumber
• IsCustomizable
• msdyn_anchortab
• msdyn_description
• msdyn_enablebuildexpression
• msdyn_entity
• msdyn_expressiondata
• msdyn_name
• msdyn_panelstate
• msdyn_sessiontemplateId
• msdyn_sessiontype
• msdyn_title
• msdyn_Type
• msdyn_UniqueName
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

ImportSequenceNumber

Added by: Basic Solution Solution

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

IsCustomizable

Added by: Basic Solution Solution

Property	Value
Description	For internal use only.
DisplayName	Is Customizable
IsValidForForm	False
IsValidForRead	True
LogicalName	iscustomizable
RequiredLevel	SystemRequired
Type	ManagedProperty

msdyn_anchortab

Property	Value
Description
DisplayName	Anchor Tab
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_anchortab
RequiredLevel	None
Targets	msdyn_applicationtabtemplate
Type	Lookup

msdyn_description

Property	Value
Description	Description of the session.
DisplayName	Description
Format	Text
IsLocalizable	True
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_description
MaxLength	2000
RequiredLevel	None
Type	Memo

msdyn_enablebuildexpression

Added by: Agent scripts Solution

Property	Value
Description	Unique value to enable or disable build expression
DisplayName	Enable build expression
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_enablebuildexpression
RequiredLevel	None
Type	Boolean

msdyn_enablebuildexpression Options

Value	Label
1	Yes
0	No

DefaultValue: False

msdyn_entity

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

msdyn_expressiondata

Added by: Agent scripts Solution

Property	Value
Description	Stores expression JSON
DisplayName	Expression data
Format	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_expressiondata
MaxLength	1048576
RequiredLevel	None
Type	Memo

msdyn_name

Property	Value
Description	The name of the session.
DisplayName	Name
FormatName	Text
IsLocalizable	True
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_name
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_panelstate

Added by: Channel Integration Framework version 2.0 Solution

Property	Value
Description
DisplayName	Communication panel mode
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_panelstate
RequiredLevel	ApplicationRequired
Type	Picklist

msdyn_panelstate Options

Value	Label
162450000	Minimized
162450001	Hidden
162450002	Docked

msdyn_sessiontemplateId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Session Template
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_sessiontemplateid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_sessiontype

Property	Value
Description
DisplayName	Type
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_sessiontype
RequiredLevel	ApplicationRequired
Type	Picklist

msdyn_sessiontype Options

Value	Label
0	Generic
1	Entity

msdyn_title

Property	Value
Description	Title of the session.
DisplayName	Title
FormatName	Text
IsLocalizable	True
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_title
MaxLength	200
RequiredLevel	None
Type	String

msdyn_Type

Property	Value
Description
DisplayName	msdyn_Type
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_type
RequiredLevel	ApplicationRequired
Type	Boolean

msdyn_Type Options

Value	Label
1	Entity
0	Generic

DefaultValue: False

msdyn_UniqueName

Property	Value
Description	Unique Name for the entity.
DisplayName	Unique Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_uniquename
MaxLength	128
RequiredLevel	SystemRequired
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 Session Template
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 Session Template
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.

• ComponentIdUnique
• ComponentState
• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• IsManaged
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• msdyn_anchortabName
• OverwriteTime
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningTeam
• OwningUser
• SolutionId
• SupportingSolutionId
• VersionNumber

ComponentIdUnique

Added by: Basic Solution Solution

Property	Value
Description	For internal use only.
DisplayName	Row id unique
IsValidForForm	False
IsValidForRead	True
LogicalName	componentidunique
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ComponentState

Added by: Basic Solution Solution

Property	Value
Description	For internal use only.
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	componentstate
RequiredLevel	SystemRequired
Type	Picklist

ComponentState Options

Value	Label
0	Published
1	Unpublished
2	Deleted
3	Deleted Unpublished

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

IsManaged

Added by: Basic Solution Solution

Property	Value
Description	Indicates whether the solution component is part of a managed solution.
DisplayName	Is Managed
IsValidForForm	False
IsValidForRead	True
LogicalName	ismanaged
RequiredLevel	SystemRequired
Type	Boolean

IsManaged Options

Value	Label
1	Managed
0	Unmanaged

DefaultValue: False

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

msdyn_anchortabName

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

OverwriteTime

Added by: Basic Solution Solution

Property	Value
DateTimeBehavior	UserLocal
Description	For internal use only.
DisplayName	Record Overwrite Time
Format	DateAndTime
IsValidForForm	False
IsValidForRead	True
LogicalName	overwritetime
RequiredLevel	SystemRequired
Type	DateTime

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

SolutionId

Added by: Basic Solution Solution

Property	Value
Description	Unique identifier of the associated solution.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	True
LogicalName	solutionid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SupportingSolutionId

Added by: Basic Solution Solution

Property	Value
Description	For internal use only.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	False
LogicalName	supportingsolutionid
RequiredLevel	None
Type	Uniqueidentifier

VersionNumber

Added by: Active Solution Solution

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

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

msdyn_applicationtabtemplate_sessiontemplate_anchortab

See msdyn_applicationtabtemplate Entity msdyn_applicationtabtemplate_sessiontemplate_anchortab One-To-Many relationship.

Many-To-Many Relationships

Relationship details provided where the msdyn_sessiontemplate entity is the first entity in the relationship. Listed by SchemaName.

• msdyn_sessiontemplate_applicationtab
• msdyn_appconfiguration_sessiontemplate

msdyn_sessiontemplate_applicationtab

IntersectEntityName: msdyn_sessiontemplate_applicationtab

Entity 1

Property	Value
IntersectAttribute	msdyn_sessiontemplateid
IsCustomizable	False
LogicalName	msdyn_sessiontemplate
NavigationPropertyName	msdyn_sessiontemplate_applicationtab
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order:

Entity 2

Property	Value
LogicalName	msdyn_applicationtabtemplate
IntersectAttribute	msdyn_applicationtabtemplateid
NavigationPropertyName	msdyn_sessiontemplate_applicationtab
AssociatedMenuConfiguration	Behavior: DoNotDisplay Group: Details Label: Order:

msdyn_appconfiguration_sessiontemplate

See msdyn_appconfiguration Entity msdyn_appconfiguration_sessiontemplate Many-To-Many Relationship.

Related information

Microsoft.CIFramework APIs
Client-side events