sitemap EntityType
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
|
||||||||||
| 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
|
||||||||||
| isappaware | Edm.Boolean |
Information about whether the site map is associated with app module. Display name: IsAppAware
Default options
|
||||||||||
| ismanaged | Edm.Boolean |
Read only
Default options
|
||||||||||
| 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
|
||||||||||
| showpinned | Edm.Boolean |
Enable to show the pinned dropdown in the sitemap. Display name: Show Pinned
Default options
|
||||||||||
| showrecents | Edm.Boolean |
Enable to show the recents dropdown in the sitemap. Display name: Show Recents
Default options
|
||||||||||
| 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 |