SiteMap table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

XML data used to control the application navigation pane.

Messages

Message	Web API Operation	SDK class or method
Create	POST /sitemaps See Create	CreateRequest or Create
Delete	DELETE /sitemaps(sitemapid) See Delete	DeleteRequest or Delete
Retrieve	GET /sitemaps(sitemapid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET /sitemaps See Query Data	RetrieveMultipleRequest or RetrieveMultiple
RetrieveUnpublishedMultiple	RetrieveUnpublishedMultiple	RetrieveUnpublishedMultipleRequest
Update	PATCH /sitemaps(sitemapid) See Update	UpdateRequest or Update

Properties

Property	Value
CollectionSchemaName	SiteMaps
DisplayCollectionName	Site Maps
DisplayName	Site Map
EntitySetName	sitemaps
IsBPFEntity	False
LogicalCollectionName	sitemaps
LogicalName	sitemap
OwnershipType	OrganizationOwned
PrimaryIdAttribute	sitemapid
PrimaryNameAttribute
SchemaName	SiteMap

Writable columns/attributes

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

• EnableCollapsibleGroups
• IsAppAware
• ShowHome
• ShowPinned
• ShowRecents
• SiteMapName
• SiteMapNameUnique
• SiteMapXml

EnableCollapsibleGroups

Added by: PowerAppsUnifiedClientInfraExtensions Solution

Property	Value
Description	Enable to allow sitemap groups to be collapsed.
DisplayName	Enable Collapsible Groups
IsValidForForm	True
IsValidForRead	True
LogicalName	enablecollapsiblegroups
RequiredLevel	SystemRequired
Type	Boolean

EnableCollapsibleGroups Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

IsAppAware

Property	Value
Description	Information about whether the site map is associated with app module.
DisplayName	IsAppAware
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	isappaware
RequiredLevel	SystemRequired
Type	Boolean

IsAppAware Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 0

ShowHome

Added by: PowerAppsUnifiedClientInfraExtensions Solution

Property	Value
Description	Enable to show the home button in the sitemap.
DisplayName	Show Home
IsValidForForm	True
IsValidForRead	True
LogicalName	showhome
RequiredLevel	SystemRequired
Type	Boolean

ShowHome Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 1

ShowPinned

Added by: PowerAppsUnifiedClientInfraExtensions Solution

Property	Value
Description	Enable to show the pinned dropdown in the sitemap.
DisplayName	Show Pinned
IsValidForForm	True
IsValidForRead	True
LogicalName	showpinned
RequiredLevel	SystemRequired
Type	Boolean

ShowPinned Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 1

ShowRecents

Added by: PowerAppsUnifiedClientInfraExtensions Solution

Property	Value
Description	Enable to show the recents dropdown in the sitemap.
DisplayName	Show Recents
IsValidForForm	True
IsValidForRead	True
LogicalName	showrecents
RequiredLevel	SystemRequired
Type	Boolean

ShowRecents Choices/Options

Value	Label	Description
1	Yes
0	No

DefaultValue: 1

SiteMapName

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

SiteMapNameUnique

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	sitemapnameunique
MaxLength	200
RequiredLevel	None
Type	String

SiteMapXml

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

Read-only columns/attributes

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

• ComponentState
• CreatedBy
• CreatedByName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• IsManaged
• ModifiedBy
• ModifiedByName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• OrganizationId
• OverwriteTime
• SiteMapId
• SiteMapIdUnique
• SiteMapXmlManaged
• SolutionId
• SupportingSolutionId
• VersionNumber

ComponentState

Property	Value
Description
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	componentstate
RequiredLevel	SystemRequired
Type	Picklist

ComponentState Choices/Options

Value	Label	Description
0	Published
1	Unpublished
2	Deleted
3	Deleted Unpublished

CreatedBy

Property	Value
Description	Shows who created the record.
DisplayName	Created By
IsValidForForm	False
IsValidForRead	True
LogicalName	createdby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedByName

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

CreatedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
DisplayName	Created On
Format	DateAndTime
IsValidForForm	False
IsValidForRead	True
LogicalName	createdon
RequiredLevel	None
Type	DateTime

CreatedOnBehalfBy

Property	Value
Description	Shows who created the record on behalf of another user.
DisplayName	Created By (Delegate)
IsValidForForm	False
IsValidForRead	True
LogicalName	createdonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

CreatedOnBehalfByName

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

CreatedOnBehalfByYomiName

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

IsManaged

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	ismanaged
RequiredLevel	SystemRequired
Type	Boolean

IsManaged Choices/Options

Value	Label	Description
1	Managed
0	Unmanaged

DefaultValue: 0

ModifiedBy

Property	Value
Description	Shows who last updated the record.
DisplayName	Modified By
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedByName

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

ModifiedOn

Property	Value
DateTimeBehavior	UserLocal
Description	Shows the date and time when the record was last updated. The date and time are displayed in the time zone selected in Microsoft Dynamics CRM options.
DisplayName	Modified On
Format	DateAndTime
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedon
RequiredLevel	None
Type	DateTime

ModifiedOnBehalfBy

Property	Value
Description	Shows who last updated the record on behalf of another user.
DisplayName	Modified By (Delegate)
IsValidForForm	False
IsValidForRead	True
LogicalName	modifiedonbehalfby
RequiredLevel	None
Targets	systemuser
Type	Lookup

ModifiedOnBehalfByName

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

ModifiedOnBehalfByYomiName

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

OrganizationId

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationid
RequiredLevel	SystemRequired
Targets	organization
Type	Lookup

OverwriteTime

Property	Value
DateTimeBehavior	UserLocal
Description
DisplayName
Format	DateOnly
IsValidForForm	False
IsValidForRead	True
LogicalName	overwritetime
RequiredLevel	SystemRequired
Type	DateTime

SiteMapId

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	sitemapid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SiteMapIdUnique

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	sitemapidunique
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SiteMapXmlManaged

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

SolutionId

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	solutionid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SupportingSolutionId

Property	Value
Description
DisplayName
IsValidForForm	False
IsValidForRead	False
LogicalName	supportingsolutionid
RequiredLevel	None
Type	Uniqueidentifier

VersionNumber

Property	Value
Description
DisplayName
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 table. Listed by SchemaName.

• lk_SiteMap_createdby
• lk_SiteMap_modifiedby
• organization_sitemap
• lk_SiteMap_createdonbehalfby
• lk_SiteMap_modifiedonbehalfby

lk_SiteMap_createdby

See the lk_SiteMap_createdby one-to-many relationship for the systemuser table/entity.

lk_SiteMap_modifiedby

See the lk_SiteMap_modifiedby one-to-many relationship for the systemuser table/entity.

organization_sitemap

See the organization_sitemap one-to-many relationship for the organization table/entity.

lk_SiteMap_createdonbehalfby

See the lk_SiteMap_createdonbehalfby one-to-many relationship for the systemuser table/entity.

lk_SiteMap_modifiedonbehalfby

See the lk_SiteMap_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.

See also

Dataverse table/entity reference
Web API Reference
sitemap EntityType