SiteMap entity reference

Note

Effective Nov 2020, Common Data Service has been renamed to Microsoft Dataverse.

XML data used to control the application navigation pane.

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.0/sitemaps
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/sitemaps(sitemapid)
See Delete
DeleteRequest or
Delete
Retrieve GET [org URI]/api/data/v9.0/sitemaps(sitemapid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/sitemaps
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrieveUnpublishedMultiple RetrieveUnpublishedMultiple Function RetrieveUnpublishedMultipleRequest
Update PATCH [org URI]/api/data/v9.0/sitemaps(sitemapid)
See Update
UpdateRequest or
Update

Entity 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 attributes

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

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 Options

Value Label
1 Yes
0 No

DefaultValue: False

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 attributes

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

ComponentState

Property Value
Description
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

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 Options

Value Label
1 Managed
0 Unmanaged

DefaultValue: False

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 False
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 entity. Listed by SchemaName.

lk_SiteMap_createdby

See systemuser Entity lk_SiteMap_createdby One-To-Many relationship.

lk_SiteMap_modifiedby

See systemuser Entity lk_SiteMap_modifiedby One-To-Many relationship.

organization_sitemap

See organization Entity organization_sitemap One-To-Many relationship.

lk_SiteMap_createdonbehalfby

See systemuser Entity lk_SiteMap_createdonbehalfby One-To-Many relationship.

lk_SiteMap_modifiedonbehalfby

See systemuser Entity lk_SiteMap_modifiedonbehalfby One-To-Many relationship.

See also

About entity reference
Web API reference
sitemap EntityType

Note

Can you tell us about your documentation language preferences? Take a short survey.

The survey will take about seven minutes. No personal data is collected (privacy statement).