msdyn_kmfederatedsearchconfig entity reference

Note

Effective Nov 2020, Common Data Service has been renamed to Microsoft Dataverse.

Added by: Knowledge Management Online Features Solution

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/msdyn_kmfederatedsearchconfigs(msdyn_kmfederatedsearchconfigid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/msdyn_kmfederatedsearchconfigs
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.0/msdyn_kmfederatedsearchconfigs(msdyn_kmfederatedsearchconfigid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
Retrieve GET [org URI]/api/data/v9.0/msdyn_kmfederatedsearchconfigs(msdyn_kmfederatedsearchconfigid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/msdyn_kmfederatedsearchconfigs
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/msdyn_kmfederatedsearchconfigs(msdyn_kmfederatedsearchconfigid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/msdyn_kmfederatedsearchconfigs(msdyn_kmfederatedsearchconfigid)
See Update
UpdateRequest or
Update

Entity properties

Property Value
CollectionSchemaName msdyn_kmfederatedsearchconfigs
DisplayCollectionName Search providers (Preview)
DisplayName Search provider
EntitySetName msdyn_kmfederatedsearchconfigs
IsBPFEntity False
LogicalCollectionName msdyn_kmfederatedsearchconfigs
LogicalName msdyn_kmfederatedsearchconfig
OwnershipType UserOwned
PrimaryIdAttribute msdyn_kmfederatedsearchconfigid
PrimaryNameAttribute msdyn_name
SchemaName msdyn_kmfederatedsearchconfig

Writable attributes

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

ConnectionId

Property Value
Description Unique identifier when you create a connector in Microsoft search, please check the documentation above.
DisplayName Connection Id
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName connectionid
MaxLength 1073
RequiredLevel None
Type String

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

IsDefault

Property Value
Description
DisplayName Is Default
IsValidForForm True
IsValidForRead True
LogicalName isdefault
RequiredLevel None
Type Boolean

IsDefault Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_Description

Property Value
Description This field specifies the description of Search provider record
DisplayName Description
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_description
MaxLength 2000
RequiredLevel None
Type Memo

msdyn_kmfederatedsearchconfigId

Property Value
Description Unique identifier for entity instances
DisplayName Search Provider Id
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_kmfederatedsearchconfigid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_Name

Property Value
Description The name of the search provider
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_name
MaxLength 100
RequiredLevel ApplicationRequired
Type String

Organization

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

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

OwnerId

Added by: Active Solution Solution

Property Value
Description Owner Id
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Added by: Active Solution Solution

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

SearchType

Property Value
Description
DisplayName Search Type
IsValidForForm True
IsValidForRead True
IsValidForUpdate False
LogicalName searchtype
RequiredLevel ApplicationRequired
Type Picklist

SearchType Options

Value Label
100000000 Cross-Organizational Search
100000001 Sharepoint
100000002 Microsoft Search Connector

SharepointURL

Property Value
Description
DisplayName Sharepoint URL
FormatName Url
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName sharepointurl
MaxLength 100
RequiredLevel None
Type String

statecode

Property Value
Description Status of the kmfederatedsearchconfig
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

statuscode

Property Value
Description Reason for the status of the kmfederatedsearchconfig
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Options

Value Label State
1 Active 0
2 Inactive 1

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

UTCConversionTimeZoneCode

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

CreatedBy

Added by: Active Solution Solution

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

CreatedByName

Added by: Active Solution Solution

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

CreatedByYomiName

Added by: Active Solution Solution

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 Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

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

CreatedOnBehalfByName

Added by: Active Solution Solution

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

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

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

ModifiedBy

Added by: Active Solution Solution

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

ModifiedByName

Added by: Active Solution Solution

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

ModifiedByYomiName

Added by: Active Solution Solution

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 Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

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

ModifiedOnBehalfByName

Added by: Active Solution Solution

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

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

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

OwnerIdName

Added by: Active Solution Solution

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Added by: Active Solution Solution

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Added by: Active Solution Solution

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Added by: Active Solution Solution

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Added by: Active Solution Solution

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

VersionNumber

Added by: Active Solution Solution

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

msdyn_kmfederatedsearchconfig_SyncErrors

Added by: System Solution Solution

Same as syncerror entity msdyn_kmfederatedsearchconfig_SyncErrors Many-To-One relationship.

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

msdyn_kmfederatedsearchconfig_DuplicateMatchingRecord

Added by: System Solution Solution

Same as duplicaterecord entity msdyn_kmfederatedsearchconfig_DuplicateMatchingRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_kmfederatedsearchconfig_DuplicateMatchingRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_kmfederatedsearchconfig_DuplicateBaseRecord

Added by: System Solution Solution

Same as duplicaterecord entity msdyn_kmfederatedsearchconfig_DuplicateBaseRecord Many-To-One relationship.

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_kmfederatedsearchconfig_DuplicateBaseRecord
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_kmfederatedsearchconfig_AsyncOperations

Added by: System Solution Solution

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

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

msdyn_kmfederatedsearchconfig_MailboxTrackingFolders

Added by: System Solution Solution

Same as mailboxtrackingfolder entity msdyn_kmfederatedsearchconfig_MailboxTrackingFolders Many-To-One relationship.

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

msdyn_kmfederatedsearchconfig_ProcessSession

Added by: System Solution Solution

Same as processsession entity msdyn_kmfederatedsearchconfig_ProcessSession Many-To-One relationship.

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

msdyn_kmfederatedsearchconfig_BulkDeleteFailures

Added by: System Solution Solution

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

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

msdyn_kmfederatedsearchconfig_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as principalobjectattributeaccess entity msdyn_kmfederatedsearchconfig_PrincipalObjectAttributeAccesses Many-To-One relationship.

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_kmfederatedsearchconfig_PrincipalObjectAttributeAccesses
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

IK_msdyn_kmfederatedsearchconfig_msdyn_federatedarticle_searchproviderid

Same as msdyn_federatedarticle entity IK_msdyn_kmfederatedsearchconfig_msdyn_federatedarticle_searchproviderid Many-To-One relationship.

Property Value
ReferencingEntity msdyn_federatedarticle
ReferencingAttribute msdyn_searchproviderid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName IK_msdyn_kmfederatedsearchconfig_msdyn_federatedarticle_searchproviderid
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
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.

lk_msdyn_kmfederatedsearchconfig_createdby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_kmfederatedsearchconfig_createdby One-To-Many relationship.

lk_msdyn_kmfederatedsearchconfig_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_kmfederatedsearchconfig_createdonbehalfby One-To-Many relationship.

lk_msdyn_kmfederatedsearchconfig_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_kmfederatedsearchconfig_modifiedby One-To-Many relationship.

lk_msdyn_kmfederatedsearchconfig_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_kmfederatedsearchconfig_modifiedonbehalfby One-To-Many relationship.

user_msdyn_kmfederatedsearchconfig

Added by: System Solution Solution

See systemuser Entity user_msdyn_kmfederatedsearchconfig One-To-Many relationship.

team_msdyn_kmfederatedsearchconfig

Added by: System Solution Solution

See team Entity team_msdyn_kmfederatedsearchconfig One-To-Many relationship.

business_unit_msdyn_kmfederatedsearchconfig

Added by: System Solution Solution

See businessunit Entity business_unit_msdyn_kmfederatedsearchconfig One-To-Many relationship.

See also

About entity reference
Web API reference
Microsoft.Dynamics.CRM.msdyn_kmfederatedsearchconfig

Note

Can you tell us about your documentation language preferences? Take a short survey.

The survey will take about seven minutes. No personal data is collected (privacy statement).