RecommendedDocument Entity Reference

Document Suggestions

Messages

Message Web API Operation SDK Assembly
RetrieveMultiple GET [org URI]/api/data/v9.0/recommendeddocuments
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple

Entity Properties

Property Value
CollectionSchemaName RecommendedDocuments
DisplayCollectionName Document Suggestions
DisplayName Document Suggestions
EntitySetName recommendeddocuments
IsBPFEntity False
LogicalCollectionName recommendeddocuments
LogicalName recommendeddocument
OwnershipType OrganizationOwned
PrimaryIdAttribute recommendeddocumentid
PrimaryNameAttribute title
SchemaName RecommendedDocument

Writable attributes

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

AssociatedRecordName

Property Value
Description Shows the associated record name of the recommended document.
DisplayName Associated Record Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName associatedrecordname
MaxLength 160
RequiredLevel None
Type String

Author

Property Value
Description Shows the name of the author of the recommended document.
DisplayName Author
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName author
MaxLength 256
RequiredLevel None
Type String

ExternalDocumentId

Property Value
Description Shows the external document.
DisplayName External Document ID
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName externaldocumentid
MaxLength 100
RequiredLevel SystemRequired
Type String

ExternalModifiedBy

Property Value
Description Shows who last updated the document record.
DisplayName Modified by
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName externalmodifiedby
MaxLength 256
RequiredLevel None
Type String

RecommendedDocumentId

Property Value
Description Shows the recommended document record.
DisplayName Recommended Document
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName recommendeddocumentid
RequiredLevel SystemRequired
Type Uniqueidentifier

RegardingObjectId

Property Value
Description Choose the parent record that the recommended document record is associated with.
DisplayName Regarding
IsValidForForm False
IsValidForRead True
LogicalName regardingobjectid
RequiredLevel None
Targets
Type Lookup

RegardingObjectIdName

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

RegardingObjectTypeCode

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName regardingobjecttypecode
RequiredLevel None
Type EntityName

Source

Property Value
Description Shows the source storage of the recommended document.
DisplayName Source
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName source
MaxLength 256
RequiredLevel None
Type String

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Title

Property Value
Description Type a title for the entity.
DisplayName Title
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName title
MaxLength 160
RequiredLevel SystemRequired
Type String

TransactionCurrencyId

Property Value
Description Shows the exchange rate for the currency associated with the recommended document with respect to the base currency.
DisplayName Currency
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

UTCConversionTimeZoneCode

Property Value
Description Shows the time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

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

AbsoluteUrl

Property Value
Description Type the URL where the recommended document is located.
DisplayName Absolute URL
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName absoluteurl
MaxLength 200
RequiredLevel None
Type String

ContentType

Property Value
Description Select the document content type.
DisplayName Content Type
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName contenttype
MaxLength 200
RequiredLevel None
Type String

CreatedBy

Property Value
Description Shows the user who created the record.
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 SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Shows the date and time when the record was created. The date and time are displayed in the time zone selected in Microsoft Dynamics 365 options.
DisplayName Created On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Shows who created the record on behalf of another user.
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 SystemRequired
Type String

EditUrl

Property Value
Description Shows the Edit URL of the recommended document.
DisplayName Edit Web App URL
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName editurl
MaxLength 200
RequiredLevel None
Type String

ExchangeRate

Property Value
Description Shows the exchange rate for the currency associated with the recommended document with respect to the base currency.
DisplayName ExchangeRate
IsValidForForm False
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

FileSize

Property Value
Description Shows the file size.
DisplayName File Size
Format None
IsValidForForm False
IsValidForRead True
LogicalName filesize
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

FileType

Property Value
Description Shows the file type.
DisplayName File Type
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName filetype
MaxLength 200
RequiredLevel None
Type String

FullName

Property Value
Description Shows the full name of the recommended document.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName fullname
MaxLength 160
RequiredLevel None
Type String

IconClassName

Property Value
Description Stores the Icon Class name of the recommended document.
DisplayName Icon Class Name
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName iconclassname
MaxLength 160
RequiredLevel None
Type String

Location

Property Value
Description Shows the location of the recommended document.
DisplayName Path
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName location
MaxLength 200
RequiredLevel None
Type String

ModifiedBy

Property Value
Description Shows who last updated the record.
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 SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description 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 365 options.
DisplayName Modified On
Format DateAndTime
IsValidForForm False
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Shows who last updated the record on behalf of another user.
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 SystemRequired
Type String

OrganizationId

Property Value
Description Shows the organization.
DisplayName Organization ID
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
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

ReadUrl

Property Value
Description Shows the Read URL of the recommended document.
DisplayName Read Web App URL
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName readurl
MaxLength 200
RequiredLevel None
Type String

TransactionCurrencyIdName

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

Version

Property Value
Description Shows the recommended document version.
DisplayName Recommended Document Version
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName version
MaxLength 200
RequiredLevel None
Type String

VersionNumber

Property Value
Description
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_recommendeddocument_createdby

See systemuser Entity lk_recommendeddocument_createdby One-To-Many relationship.

lk_recommendeddocument_createdonbehalfby

See systemuser Entity lk_recommendeddocument_createdonbehalfby One-To-Many relationship.

lk_recommendeddocument_modifiedby

See systemuser Entity lk_recommendeddocument_modifiedby One-To-Many relationship.

lk_recommendeddocument_modifiedonbehalfby

See systemuser Entity lk_recommendeddocument_modifiedonbehalfby One-To-Many relationship.

organization_recommendeddocument

See organization Entity organization_recommendeddocument One-To-Many relationship.

TransactionCurrency_recommendeddocument

See transactioncurrency Entity TransactionCurrency_recommendeddocument One-To-Many relationship.

See also

About the Entity Reference
Programming reference for Dynamics 365 Customer Engagement
Web API Reference
recommendeddocument EntityType