OrganizationUI Entity Reference

Entity customizations including form layout and icons. Includes current and past versions.

Messages

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

Entity Properties

Property Value
CollectionSchemaName OrganizationUIs
DisplayCollectionName Organization UI Settings
DisplayName Organization UI
EntitySetName organizationuis
IsBPFEntity False
LogicalCollectionName organizationuis
LogicalName organizationui
OwnershipType None
PrimaryIdAttribute formid
PrimaryNameAttribute
SchemaName OrganizationUI

Writable attributes

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

FieldXml

Property Value
Description For internal use only.
DisplayName
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName fieldxml
MaxLength 1073741823
RequiredLevel None
Type Memo

FormId

Property Value
Description Unique identifier of the record type form.
DisplayName
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName formid
RequiredLevel SystemRequired
Type Uniqueidentifier

FormXml

Property Value
Description XML representation of the form layout.
DisplayName
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName formxml
MaxLength 1073741823
RequiredLevel None
Type Memo

GridIcon

Property Value
Description Binary representation of the icon used in record type grid views.
DisplayName
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName gridicon
MaxLength 1073741823
RequiredLevel None
Type Memo

IsCustomizable

Property Value
Description Information that specifies whether this component can be customized.
DisplayName Customizable
IsValidForForm False
IsValidForRead True
LogicalName iscustomizable
RequiredLevel SystemRequired
Type ManagedProperty

LargeEntityIcon

Property Value
Description Binary representation of the large icon used in the record type form.
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName largeentityicon
MaxLength 1073741823
RequiredLevel None
Type String

ObjectTypeCode

Property Value
Description Code that represents the record type.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName objecttypecode
RequiredLevel None
Type EntityName

OutlookShortcutIcon

Property Value
Description Binary representation of the large icon used in the Microsoft Dynamics 365 client for Outlook for this record type.
DisplayName
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName outlookshortcuticon
MaxLength 1073741823
RequiredLevel None
Type Memo

PreviewColumnsetXml

Property Value
Description For internal use only.
DisplayName
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName previewcolumnsetxml
MaxLength 1073741823
RequiredLevel None
Type Memo

PreviewXml

Property Value
Description For internal use only.
DisplayName
Format TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName previewxml
MaxLength 1073741823
RequiredLevel None
Type Memo

Version

Property Value
Description For internal use only.
DisplayName
Format None
IsValidForForm False
IsValidForRead True
LogicalName version
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

Read-only attributes

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

ComponentState

Property Value
Description For internal use only.
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

FormIdUnique

Property Value
Description Unique identifier of the form used when synchronizing customizations for the Microsoft Dynamics 365 client for Outlook.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName formidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

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

OrganizationId

Property Value
Description Unique identifier of the organization.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel SystemRequired
Targets organization
Type Lookup

OrganizationIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

OverwriteTime

Property Value
DateTimeBehavior UserLocal
Description For internal use only.
DisplayName Record Overwrite Time
Format DateOnly
IsValidForForm False
IsValidForRead True
LogicalName overwritetime
RequiredLevel SystemRequired
Type DateTime

SolutionId

Property Value
Description Unique identifier of the associated solution.
DisplayName Solution
IsValidForForm False
IsValidForRead True
LogicalName solutionid
RequiredLevel SystemRequired
Type Uniqueidentifier

SupportingSolutionId

Property Value
Description For internal use only.
DisplayName Solution
IsValidForForm False
IsValidForRead False
LogicalName supportingsolutionid
RequiredLevel None
Type Uniqueidentifier

VersionNumber

Property Value
Description Represents a version of customizations to be synchronized with the Microsoft Dynamics 365 client for Outlook.
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_organizationui_organizationid

See organization Entity lk_organizationui_organizationid One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
Microsoft.Dynamics.CRM.organizationui