navigationsetting EntityType
Navigation Setting: A setting page or group of pages available for configuration within an app. A record representing a group of pages is regarded as the parent navigation setting of one or more other records. For internal use only.
- Entity set path:
- [organization URI]/api/data/v9.2/navigationsettings
- Base type:
- crmbaseentity
- Display name:
- Navigation Setting
- Primary key:
- navigationsettingid
- Primary name column:
- name
- Operations supported:
- POST GET PATCH DELETE
Properties
Properties represent fields of data stored in the entity. Some properties are read-only.
| Name | Type | Details | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| advancedsettingorder | Edm.Int32 |
Enter the position of this NavigationSetting as it should appear within its group in the Advanced Setup menu. Display name: AdvancedOrder |
||||||||||
| appconfigidunique | Edm.Guid |
For system use only. Display name: AppConfigIdUnique |
||||||||||
| componentstate | Edm.Int32 |
For internal use only. 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
|
||||||||||
| description | Edm.String |
Type a description that describes that Navigation Setting in detail. Display name: Description |
||||||||||
| groupname | Edm.String |
Type the name of the group represented by this Navigation Setting record. Display name: Group Name |
||||||||||
| iconresourceid | Edm.Guid |
The web resource identifier of the icon to be used for a navigation setting area or sub area. Display name: IconResourceId |
||||||||||
| importsequencenumber | Edm.Int32 |
Unique identifier of the data import or data migration that created this record. Display name: Import Sequence Number Read only
|
||||||||||
| introducedversion | Edm.String |
Version in which the similarity rule is introduced. Display name: Introduced Version |
||||||||||
| ismanaged | Edm.Boolean |
For internal use only. Display name: Is Managed 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
|
||||||||||
| name | Edm.String |
Type a title or name that describes the Navigation Setting so it can be identified in Dynamics CRM views. Display name: Name |
||||||||||
| navigationsettingid | Edm.Guid |
Identifies a single setting page or group of pages configured for use in a single app. Display name: NavigationSettingId |
||||||||||
| navigationsettingidunique | Edm.Guid |
For system use only. Display name: NavigationSettingIdUnique |
||||||||||
| objecttypecode | Edm.Int32 |
Enter the Object Type Code of the entity associated whose page this Navigation Setting record represents. Display name: EntityObjectTypeCode |
||||||||||
| overriddencreatedon | Edm.DateTimeOffset |
Date and time that the record was migrated. Display name: Record Created On Read only
|
||||||||||
| overwritetime | Edm.DateTimeOffset |
For internal use only. Display name: Record Overwrite Time Read only
|
||||||||||
| pageurl | Edm.String |
Type the URL which locates the page associated with this Navigation Setting record. Display name: Page Url |
||||||||||
| parentnavigationsettingid | Edm.Guid |
The Navigation Setting record that represents the group that this record belongs to. Display name: Parent Navigation Setting Id |
||||||||||
| privileges | Edm.Int32 |
Enter the Privilege Mask for the entity associated with this navigation setting page that will be the minimum requirement for the page to be made available to a user. Display name: Privileges |
||||||||||
| progressstate | Edm.Boolean |
Select the setup completion level for this Navigation Setting page. Display name: Progress State
Default options
|
||||||||||
| quicksettingorder | Edm.Int32 |
Enter the position of this NavigationSetting as it should appear in the Quick Setup menu. Display name: QuickOrder |
||||||||||
| resourceid | Edm.Guid |
The Web Resource that will be associated with this Navigation Setting record. Display name: Resource Id |
||||||||||
| settingtype | Edm.Int32 |
Select the type of group this Navigation Setting record represents. This determines which of the three in-app customization menus will contain this group. Display name: Group Type
Default options
|
||||||||||
| solutionid | Edm.Guid |
Unique identifier of the associated solution. Display name: Solution 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 |
|---|---|---|
| _appconfigid_value | navigationsetting_appconfig |
Enter the App Config record that this Navigation Setting is associated with. |
| _createdby_value | navigationsetting_createdby |
Shows who created the record. |
| _createdonbehalfby_value | navigationsetting_createdonbehalfby |
Shows who created the record on behalf of another user. |
| _modifiedby_value | navigationsetting_modifiedby |
Shows who last updated the record. |
| _modifiedonbehalfby_value | navigationsetting_modifiedonbehalfby |
Shows who last updated the record on behalf of another user. |
| _organizationid_value | organization_navigationsetting_navigationsetting |
System-populated field that identifies the organization that owns this Navigation Setting record. |
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 |
|---|---|---|
| navigationsetting_appconfig | appconfig | appconfig_navigationsetting |
| navigationsetting_createdby | systemuser | systemuser_navigationsetting_createdby |
| navigationsetting_createdonbehalfby | systemuser | systemuser_navigationsetting_createdonbehalfby |
| navigationsetting_modifiedby | systemuser | systemuser_navigationsetting_modifiedby |
| navigationsetting_modifiedonbehalfby | systemuser | systemuser_navigationsetting_modifiedonbehalfby |
| organization_navigationsetting_navigationsetting | organization | organization_navigationsetting |
Operations
The following operations can be used with the navigationsetting entity type.
| Name | Binding |
|---|---|
| RetrieveUnpublishedMultiple | Bound to Collection |