Site Map (SiteMap) table/entity reference

XML data used to control the application navigation pane.

Messages

The following table lists the messages for the Site Map (SiteMap) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?
Web API Operation SDK for .NET
Create
Event: False
POST /sitemaps
See Create
Create records
Delete
Event: True
DELETE /sitemaps(sitemapid)
See Delete
Delete records
Retrieve
Event: False
GET /sitemaps(sitemapid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: False
GET /sitemaps
See Query data
Query data
RetrieveUnpublishedMultiple
Event: False
RetrieveUnpublishedMultiple RetrieveUnpublishedMultipleRequest
Update
Event: False
PATCH /sitemaps(sitemapid)
See Update
Update records
Upsert
Event: False
PATCH /sitemaps(sitemapid)
See Upsert a table row
UpsertRequest

Properties

The following table lists selected properties for the Site Map (SiteMap) table.

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

Writable columns/attributes

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

EnableCollapsibleGroups

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
GlobalChoiceName sitemap_enablecollapsiblegroups
DefaultValue False
True Label Yes
False Label No

IsAppAware

Property Value
Description Information about whether the site map is associated with app module.
DisplayName IsAppAware
IsValidForForm False
IsValidForRead True
LogicalName isappaware
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName sitemap_isappaware
DefaultValue False
True Label Yes
False Label No

ShowHome

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
GlobalChoiceName sitemap_showhome
DefaultValue True
True Label Yes
False Label No

ShowPinned

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
GlobalChoiceName sitemap_showpinned
DefaultValue True
True Label Yes
False Label No

ShowRecents

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
GlobalChoiceName sitemap_showrecents
DefaultValue True
True Label Yes
False Label No

SiteMapName

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

SiteMapNameUnique

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

SiteMapXml

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

Read-only columns/attributes

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

ComponentState

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

ComponentState Choices/Options

Value Label
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
Type Lookup
Targets systemuser

CreatedOn

Property Value
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
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

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
Type Lookup
Targets systemuser

IsManaged

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName ismanaged
RequiredLevel SystemRequired
Type Boolean
GlobalChoiceName ismanaged
DefaultValue False
True Label Managed
False Label Unmanaged

ModifiedBy

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

ModifiedOn

Property Value
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
IsValidForForm False
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateAndTime
ImeMode Inactive
SourceTypeMask 0

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
Type Lookup
Targets systemuser

OrganizationId

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

OverwriteTime

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime
CanChangeDateTimeBehavior False
DateTimeBehavior UserLocal
Format DateOnly
ImeMode Inactive
SourceTypeMask 0

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
IsValidForForm False
IsValidForRead True
LogicalName sitemapxmlmanaged
RequiredLevel None
Type String
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 1073741823

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
RequiredLevel None
Type BigInt
MaxValue 9223372036854775807
MinValue -9223372036854775808

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

lk_SiteMap_createdby

One-To-Many Relationship: systemuser lk_SiteMap_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName SiteMap_createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_SiteMap_createdonbehalfby

One-To-Many Relationship: systemuser lk_SiteMap_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName SiteMap_createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_SiteMap_modifiedby

One-To-Many Relationship: systemuser lk_SiteMap_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName SiteMap_modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_SiteMap_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_SiteMap_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName SiteMap_modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

organization_sitemap

One-To-Many Relationship: organization organization_sitemap

Property Value
ReferencedEntity organization
ReferencedAttribute organizationid
ReferencingAttribute organizationid
ReferencingEntityNavigationPropertyName organizationid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

See also

Dataverse table/entity reference
Dataverse Web API Reference
sitemap