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.0/navigationsettings
Base Type
crmbaseentity
Display Name
Navigation Setting
Primary Key
navigationsettingid
Primary Key Attribute
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
Value 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
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
Value 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
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
Value Label
1 Visited
0 Not Visited
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
Value Label
0 Advanced Setup
1 Basic Setup
2 Advanced Setup Summary
3 Basic Setup Summary
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 Retrieve data about lookup properties.

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
RetrieveUnpublished Entity
RetrieveUnpublishedMultiple Collection

Solutions

The following solutions include the navigationsetting entity type.

Name Description
System Solution Internal CRM System Solution

See also