DisplayString Entity Reference

Customized messages for an entity that has been renamed.

Messages

Message Web API Operation SDK Assembly
Retrieve GET [org URI]/api/data/v9.0/displaystrings(displaystringid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/displaystrings
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
Update PATCH [org URI]/api/data/v9.0/displaystrings(displaystringid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName DisplayStrings
DisplayCollectionName Display Strings
DisplayName Display String
EntitySetName displaystrings
IsBPFEntity False
LogicalCollectionName displaystrings
LogicalName displaystring
OwnershipType OrganizationOwned
PrimaryIdAttribute displaystringid
PrimaryNameAttribute
SchemaName DisplayString

Writable attributes

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

CustomComment

Property Value
Description Comment for a customized display string.
DisplayName Comment
FormatName TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName customcomment
MaxLength 500
RequiredLevel None
Type String

CustomDisplayString

Property Value
Description Customized display string.
DisplayName Custom Display String
FormatName TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName customdisplaystring
MaxLength 750
RequiredLevel None
Type String

DisplayStringId

Property Value
Description Unique identifier of the display string.
DisplayName Custom Display String Id
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName displaystringid
RequiredLevel SystemRequired
Type Uniqueidentifier

LanguageCode

Property Value
Description Language code of the display string.
DisplayName Language Code
Format Locale
IsValidForForm False
IsValidForRead True
LogicalName languagecode
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

CreatedBy

Property Value
Description Unique identifier of the user who created the display string.
DisplayName Created By
IsValidForForm False
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

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

CreatedByYomiName

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

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the display string was created.
DisplayName Created On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel SystemRequired
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the displaystring.
DisplayName Created By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

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

CreatedOnBehalfByYomiName

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

DisplayStringIdUnique

Property Value
Description For internal use only.
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName displaystringidunique
RequiredLevel SystemRequired
Type Uniqueidentifier

DisplayStringKey

Property Value
Description For internal use only.
DisplayName Resource Key
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName displaystringkey
MaxLength 200
RequiredLevel SystemRequired
Type String

FormatParameters

Property Value
Description Parameters used for formatting the display string.
DisplayName Format Parameters
Format None
IsValidForForm False
IsValidForRead True
LogicalName formatparameters
MaxValue 2147483647
MinValue -2147483648
RequiredLevel SystemRequired
Type Integer

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

ModifiedBy

Property Value
Description Unique identifier of the user who last modified the display string.
DisplayName Modified By
IsValidForForm False
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

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

ModifiedByYomiName

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

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the display string was last modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel SystemRequired
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who last modified the displaystring.
DisplayName Modified By (Delegate)
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

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

ModifiedOnBehalfByYomiName

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

OrganizationId

Property Value
Description Unique identifier of the organization associated with the display string.
DisplayName Organization
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

PublishedDisplayString

Property Value
Description Published display string.
DisplayName Published Display String
FormatName TextArea
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName publisheddisplaystring
MaxLength 750
RequiredLevel None
Type String

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
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

DisplayString_AsyncOperations

Same as asyncoperation entity DisplayString_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName DisplayString_AsyncOperations
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

DisplayString_BulkDeleteFailures

Same as bulkdeletefailure entity DisplayString_BulkDeleteFailures Many-To-One relationship.

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName DisplayString_BulkDeleteFailures
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

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.

organization_custom_displaystrings

See organization Entity organization_custom_displaystrings One-To-Many relationship.

lk_DisplayStringbase_createdby

See systemuser Entity lk_DisplayStringbase_createdby One-To-Many relationship.

lk_DisplayStringbase_modifiedby

See systemuser Entity lk_DisplayStringbase_modifiedby One-To-Many relationship.

lk_DisplayStringbase_modifiedonbehalfby

See systemuser Entity lk_DisplayStringbase_modifiedonbehalfby One-To-Many relationship.

lk_DisplayStringbase_createdonbehalfby

See systemuser Entity lk_DisplayStringbase_createdonbehalfby One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
displaystring EntityType