sitemap EntityType

  • Reference
Namespace:
Microsoft.Dynamics.CRM

XML data used to control the application navigation pane.

Entity Set Path
[organization URI]/api/data/v9.2/sitemaps
Base Type
crmbaseentity
Display Name
Site Map
Primary Key
sitemapid
Operations Supported
POST GET PATCH DELETE

Properties

Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
componentstate Edm.Int32

Display Name: Component State

Read Only
Default Options
Values Label
0 Published
1 Unpublished
2 Deleted
3 Deleted Unpublished
createdon Edm.DateTimeOffset

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.

Display Name: Created On

Read Only
enablecollapsiblegroups Edm.Boolean

Enable to allow sitemap groups to be collapsed.

Display Name: Enable Collapsible Groups

Default Options
Values Label
1 Yes
0 No
isappaware Edm.Boolean

Information about whether the site map is associated with app module.

Display Name: IsAppAware

Default Options
Values Label
1 Yes
0 No
ismanaged Edm.Boolean
Read Only
Default Options
Values Label
1 Managed
0 Unmanaged
modifiedon Edm.DateTimeOffset

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.

Display Name: Modified On

Read Only
overwritetime Edm.DateTimeOffset
Read Only
showhome Edm.Boolean

Enable to show the home button in the sitemap.

Display Name: Show Home

Default Options
Values Label
1 Yes
0 No
showpinned Edm.Boolean

Enable to show the pinned dropdown in the sitemap.

Display Name: Show Pinned

Default Options
Values Label
1 Yes
0 No
showrecents Edm.Boolean

Enable to show the recents dropdown in the sitemap.

Display Name: Show Recents

Default Options
Values Label
1 Yes
0 No
sitemapid Edm.Guid
Read Only
sitemapidunique Edm.Guid
Read Only
sitemapname Edm.String
sitemapnameunique Edm.String
sitemapxml Edm.String
sitemapxmlmanaged Edm.String
Read Only
solutionid Edm.Guid
Read Only
versionnumber Edm.Int64
Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.

Name Single-valued navigation property Description
_createdby_value SiteMap_createdby

Shows who created the record.
_createdonbehalfby_value SiteMap_createdonbehalfby

Shows who created the record on behalf of another user.
_modifiedby_value SiteMap_modifiedby

Shows who last updated the record.
_modifiedonbehalfby_value SiteMap_modifiedonbehalfby

Shows who last updated the record on behalf of another user.
_organizationid_value organizationid

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
organizationid organization organization_sitemap
SiteMap_createdby systemuser systemuser_SiteMap_createdby
SiteMap_createdonbehalfby systemuser systemuser_SiteMap_createdonbehalfby
SiteMap_modifiedby systemuser systemuser_SiteMap_modifiedby
SiteMap_modifiedonbehalfby systemuser systemuser_SiteMap_modifiedonbehalfby

Operations

The following operations can be used with the sitemap entity type.

Name Binding
RetrieveUnpublishedMultiple Bound to Collection

See also