msdyn_integratedsearchprovider table/entity reference

Note

Unsure about table vs. entity? See Developers: Understand terminology in Microsoft Dataverse.

Ingest and search files, documents, or articles from data sources outside of your current Dynamics 365 organization with a unified ranking.

Added by: Knowledge Management Patch Solution

Messages

Message Web API Operation SDK class or method
Assign PATCH /msdyn_integratedsearchproviders(msdyn_integratedsearchproviderid)
Update ownerid property.
AssignRequest
Create POST /msdyn_integratedsearchproviders
See Create
CreateRequest or
Create
CreateMultiple CreateMultiple CreateMultipleRequest
Delete DELETE /msdyn_integratedsearchproviders(msdyn_integratedsearchproviderid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess GrantAccessRequest
IsValidStateTransition IsValidStateTransition IsValidStateTransitionRequest
ModifyAccess ModifyAccess ModifyAccessRequest
Retrieve GET /msdyn_integratedsearchproviders(msdyn_integratedsearchproviderid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET /msdyn_integratedsearchproviders
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess RevokeAccessRequest
SetState PATCH /msdyn_integratedsearchproviders(msdyn_integratedsearchproviderid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH /msdyn_integratedsearchproviders(msdyn_integratedsearchproviderid)
See Update
UpdateRequest or
Update
UpdateMultiple UpdateMultiple UpdateMultipleRequest

Properties

Property Value
CollectionSchemaName msdyn_integratedsearchproviders
DisplayCollectionName Integrated search providers
DisplayName Integrated search provider
EntitySetName msdyn_integratedsearchproviders
IsBPFEntity False
LogicalCollectionName msdyn_integratedsearchproviders
LogicalName msdyn_integratedsearchprovider
OwnershipType UserOwned
PrimaryIdAttribute msdyn_integratedsearchproviderid
PrimaryNameAttribute msdyn_name
SchemaName msdyn_integratedsearchprovider

Writable columns/attributes

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

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

msdyn_allowedlanguages

Property Value
Description Languages allowed for ingestion
DisplayName Allowed Languages
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_allowedlanguages
MaxLength 10000
RequiredLevel None
Type String

msdyn_articlepropertiesmapping

Property Value
Description Map external search provider fields and knowledge article table columns in Dataverse
DisplayName Article properties
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_articlepropertiesmapping
MaxLength 1048576
RequiredLevel ApplicationRequired
Type Memo

msdyn_authenticationtype

Property Value
Description Authentication type for the search provider
DisplayName Authentication
IsValidForForm True
IsValidForRead True
LogicalName msdyn_authenticationtype
RequiredLevel ApplicationRequired
Type Picklist

msdyn_authenticationtype Choices/Options

Value Label Description
0 None
1 OAuth

msdyn_clientid

Property Value
Description Client ID for the OAuth
DisplayName Client ID
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_clientid
MaxLength 100
RequiredLevel None
Type String

msdyn_clientsecret

Property Value
Description Secret of the external search provider
DisplayName External search provider secret
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_clientsecret
MaxLength 200
RequiredLevel None
Type String

msdyn_datasourcetype

Property Value
Description Type of the external search provider
DisplayName External search provider type
IsValidForForm True
IsValidForRead True
LogicalName msdyn_datasourcetype
RequiredLevel ApplicationRequired
Type Picklist

msdyn_datasourcetype Choices/Options

Value Label Description
0 Website

msdyn_description

Property Value
Description Description of the external search provider
DisplayName Description
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_description
MaxLength 4000
RequiredLevel None
Type String

msdyn_htmlmetatags

Property Value
Description Information about the meta tags extracted from sample dataprovider html
DisplayName Html meta tags information
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_htmlmetatags
MaxLength 1048576
RequiredLevel None
Type Memo

msdyn_includedsitemapurls

Property Value
Description List of URLs that are allowed
DisplayName Allowlist URL
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_includedsitemapurls
MaxLength 20000
RequiredLevel None
Type Memo

msdyn_integratedsearchproviderId

Property Value
Description Unique identifier for entity instances
DisplayName Integrated search provider
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_integratedsearchproviderid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_isfieldmappingoptionselected

Property Value
Description Value is true when field mapping option is selected
DisplayName Is Field Mapping Option Selected
IsValidForForm True
IsValidForRead True
LogicalName msdyn_isfieldmappingoptionselected
RequiredLevel None
Type Boolean

msdyn_isfieldmappingoptionselected Choices/Options

Value Label Description
1 Yes
0 No

DefaultValue: 0

msdyn_lastfetchtime

Property Value
DateTimeBehavior UserLocal
Description Date and time at which the recent ingestion was started
DisplayName Last fetch time
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName msdyn_lastfetchtime
RequiredLevel None
Type DateTime

msdyn_lookbackperiod

Property Value
Description Time interval for ingesting any articles that might have been missed during the sync and ingestion overlap
DisplayName Lookback period
IsValidForForm True
IsValidForRead True
LogicalName msdyn_lookbackperiod
RequiredLevel None
Type Picklist

msdyn_lookbackperiod Choices/Options

Value Label Description
0 No Lookback
1 2 hours
2 4 hours
3 6 hours
4 8 hours

msdyn_name

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

msdyn_refreshschedule

Property Value
Description Time interval for ingesting newly created and updated articles from the external search provider
DisplayName Refresh schedule
IsValidForForm True
IsValidForRead True
LogicalName msdyn_refreshschedule
RequiredLevel None
Type Picklist

msdyn_refreshschedule Choices/Options

Value Label Description
0 No refresh
1 15 mins
2 30 mins
3 45 mins
4 1 hour
5 2 hours
6 4 hours
7 8 hours
8 1 day
9 2 days
10 4 days
11 7 days

msdyn_resourceid

Property Value
Description Resource ID for OAuth
DisplayName Resource ID
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_resourceid
MaxLength 2000
RequiredLevel None
Type String

msdyn_rooturl

Property Value
Description Root URL of the website
DisplayName Root URL
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_rooturl
MaxLength 2000
RequiredLevel None
Type String

msdyn_tenantid

Property Value
Description Tenant ID for OAuth
DisplayName Tenant ID
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_tenantid
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

Property Value
Description Owner of the external search provider record
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

statecode

Property Value
Description State of the external search provider
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Choices/Options

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

statuscode

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

statuscode Choices/Options

Value Label State
1 Ingestion Ready 0
2 Validated 1
3 Draft 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 columns/attributes

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

CreatedBy

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

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 Date and time of the external search provider creation
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

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

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

ModifiedBy

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

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

ModifiedOnBehalfBy

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

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

msdyn_htmlsample

Property Value
Description The reference to the sample html file uploaded for the integrated search provider
DisplayName Sample HTML File of Data Provider uploaded for metatags extraction
IsValidForForm True
IsValidForRead True
LogicalName msdyn_htmlsample
RequiredLevel None
Type File

msdyn_htmlsample_Name

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

OwnerIdName

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

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

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

OwningBusinessUnitName

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

OwningTeam

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

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

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_integratedsearchprovider_SyncErrors

Added by: System Solution Solution

Same as the msdyn_integratedsearchprovider_SyncErrors many-to-one relationship for the syncerror table/entity.

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

msdyn_integratedsearchprovider_DuplicateMatchingRecord

Added by: System Solution Solution

Same as the msdyn_integratedsearchprovider_DuplicateMatchingRecord many-to-one relationship for the duplicaterecord table/entity.

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

msdyn_integratedsearchprovider_DuplicateBaseRecord

Added by: System Solution Solution

Same as the msdyn_integratedsearchprovider_DuplicateBaseRecord many-to-one relationship for the duplicaterecord table/entity.

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

msdyn_integratedsearchprovider_AsyncOperations

Added by: System Solution Solution

Same as the msdyn_integratedsearchprovider_AsyncOperations many-to-one relationship for the asyncoperation table/entity.

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

msdyn_integratedsearchprovider_MailboxTrackingFolders

Added by: System Solution Solution

Same as the msdyn_integratedsearchprovider_MailboxTrackingFolders many-to-one relationship for the mailboxtrackingfolder table/entity.

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

msdyn_integratedsearchprovider_ProcessSession

Added by: System Solution Solution

Same as the msdyn_integratedsearchprovider_ProcessSession many-to-one relationship for the processsession table/entity.

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

msdyn_integratedsearchprovider_BulkDeleteFailures

Added by: System Solution Solution

Same as the msdyn_integratedsearchprovider_BulkDeleteFailures many-to-one relationship for the bulkdeletefailure table/entity.

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

msdyn_integratedsearchprovider_PrincipalObjectAttributeAccesses

Added by: System Solution Solution

Same as the msdyn_integratedsearchprovider_PrincipalObjectAttributeAccesses many-to-one relationship for the principalobjectattributeaccess table/entity.

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

msdyn_knowledgearticle_integratedsearchprovider

Added by: Knowledge Management Online Features Solution

Same as the msdyn_knowledgearticle_integratedsearchprovider many-to-one relationship for the knowledgearticle table/entity.

Property Value
ReferencingEntity knowledgearticle
ReferencingAttribute msdyn_integratedsearchproviderid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName msdyn_knowledgearticle_integratedsearchprovider
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 table. Listed by SchemaName.

lk_msdyn_integratedsearchprovider_createdby

Added by: System Solution Solution

See the lk_msdyn_integratedsearchprovider_createdby one-to-many relationship for the systemuser table/entity.

lk_msdyn_integratedsearchprovider_createdonbehalfby

Added by: System Solution Solution

See the lk_msdyn_integratedsearchprovider_createdonbehalfby one-to-many relationship for the systemuser table/entity.

lk_msdyn_integratedsearchprovider_modifiedby

Added by: System Solution Solution

See the lk_msdyn_integratedsearchprovider_modifiedby one-to-many relationship for the systemuser table/entity.

lk_msdyn_integratedsearchprovider_modifiedonbehalfby

Added by: System Solution Solution

See the lk_msdyn_integratedsearchprovider_modifiedonbehalfby one-to-many relationship for the systemuser table/entity.

user_msdyn_integratedsearchprovider

Added by: System Solution Solution

See the user_msdyn_integratedsearchprovider one-to-many relationship for the systemuser table/entity.

team_msdyn_integratedsearchprovider

Added by: System Solution Solution

See the team_msdyn_integratedsearchprovider one-to-many relationship for the team table/entity.

business_unit_msdyn_integratedsearchprovider

Added by: System Solution Solution

See the business_unit_msdyn_integratedsearchprovider one-to-many relationship for the businessunit table/entity.

See also

Dataverse table/entity reference
Web API Reference
msdyn_integratedsearchprovider EntityType