msdyn_integratedsearchprovider EntityType

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

Entity Set Path
[organization URI]/api/data/v9.2/msdyn_integratedsearchproviders
Base Type
Display Name
Integrated search provider
Primary Key
Primary Key Attribute
Operations Supported


Properties represent fields of data stored in the entity.Some properties are read-only.

Name Type Details
createdon Edm.DateTimeOffset

Date and time of the external search provider creation

Display Name: Created On

Read Only
importsequencenumber Edm.Int32

Sequence number of the import that created this record.

Display Name: Import Sequence Number

modifiedon Edm.DateTimeOffset

Date and time when the record was modified.

Display Name: Modified On

Read Only
msdyn_allowedlanguages Edm.String

Languages allowed for ingestion

Display Name: Allowed Languages

msdyn_articlepropertiesmapping Edm.String

Map external search provider fields and knowledge article table columns in Dataverse

Display Name: Article properties

msdyn_authenticationtype Edm.Int32

Authentication type for the search provider

Display Name: Authentication

Default Options
Values Label
0 None
1 OAuth
msdyn_clientid Edm.String

Client ID for the OAuth

Display Name: Client ID

msdyn_clientsecret Edm.String

Secret of the external search provider

Display Name: External search provider secret

msdyn_datasourcetype Edm.Int32

Type of the external search provider

Display Name: External search provider type

Default Options
Values Label
0 Website
msdyn_description Edm.String

Description of the external search provider

Display Name: Description

msdyn_htmlmetatags Edm.String

Information about the meta tags extracted from sample dataprovider html

Display Name: Html meta tags information

msdyn_htmlsample Edm.Binary

The reference to the sample html file uploaded for the integrated search provider

Display Name: Sample HTML File of Data Provider uploaded for metatags extraction

Read Only
msdyn_htmlsample_name Edm.String
Read Only
msdyn_includedsitemapurls Edm.String

List of URLs that are allowed

Display Name: Allowlist URL

msdyn_integratedsearchproviderid Edm.Guid

Unique identifier for entity instances

Display Name: Integrated search provider

msdyn_isfieldmappingoptionselected Edm.Boolean

Value is true when field mapping option is selected

Display Name: Is Field Mapping Option Selected

Default Options
Values Label
1 Yes
0 No
msdyn_lastfetchtime Edm.DateTimeOffset

Date and time at which the recent ingestion was started

Display Name: Last fetch time

msdyn_lookbackperiod Edm.Int32

Time interval for ingesting any articles that might have been missed during the sync and ingestion overlap

Display Name: Lookback period

Default Options
Values Label
0 No Lookback
1 2 hours
2 4 hours
3 6 hours
4 8 hours
msdyn_name Edm.String

Name of the external search provider

Display Name: Name

msdyn_refreshschedule Edm.Int32

Time interval for ingesting newly created and updated articles from the external search provider

Display Name: Refresh schedule

Default Options
Values Label
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 Edm.String

Resource ID for OAuth

Display Name: Resource ID

msdyn_rooturl Edm.String

Root URL of the website

Display Name: Root URL

msdyn_tenantid Edm.String

Tenant ID for OAuth

Display Name: Tenant ID

overriddencreatedon Edm.DateTimeOffset

Date and time that the record was migrated.

Display Name: Record Created On

statecode Edm.Int32

State of the external search provider

Display Name: Status

Default Options
Values Label
0 Active
1 Inactive
statuscode Edm.Int32

Reason for the status of the Integrated search provider

Display Name: Status Reason

Default Options
Values Label
1 Ingestion Ready
2 Validated
3 Draft
timezoneruleversionnumber Edm.Int32

For internal use only.

Display Name: Time Zone Rule Version Number

utcconversiontimezonecode Edm.Int32

Time zone code that was in use when the record was created.

Display Name: UTC Conversion Time Zone Code

versionnumber Edm.Int64

Version Number

Display Name: Version Number

Read Only

Lookup Properties

Lookup properties are read-only, computed properties which contain entity primary key Edm.Guid data for one or more corresponding single-valued navigation properties. More information: Lookup properties and Lookup property data.

Name Single-valued navigation property Description
_createdby_value createdby

Unique identifier of the user who created the record.

_createdonbehalfby_value createdonbehalfby

Unique identifier of the delegate user who created the record.

_modifiedby_value modifiedby

Unique identifier of the user who modified the record.

_modifiedonbehalfby_value modifiedonbehalfby

Unique identifier of the delegate user who modified the record.

_ownerid_value ownerid

Owner of the external search provider record

_owningbusinessunit_value owningbusinessunit

Unique identifier for the business unit that owns the record

_owningteam_value owningteam

Unique identifier for the team that owns the record.

_owninguser_value owninguser

Unique identifier for the user that owns the record.

Single-valued navigation properties

Single-valued navigation properties represent lookup fields where a single entity can be referenced. Each single-valued navigation property has a corresponding partner collection-valued navigation property on the related entity.

Name Type Partner
createdby systemuser lk_msdyn_integratedsearchprovider_createdby
createdonbehalfby systemuser lk_msdyn_integratedsearchprovider_createdonbehalfby
modifiedby systemuser lk_msdyn_integratedsearchprovider_modifiedby
modifiedonbehalfby systemuser lk_msdyn_integratedsearchprovider_modifiedonbehalfby
ownerid principal owner_msdyn_integratedsearchprovider
owningbusinessunit businessunit business_unit_msdyn_integratedsearchprovider
owningteam team team_msdyn_integratedsearchprovider
owninguser systemuser user_msdyn_integratedsearchprovider

Collection-valued navigation properties

Collection-valued navigation properties represent collections of entities which may represent either a one-to-many (1:N) or many-to-many (N:N) relationship between the entities.

Name Type Partner
msdyn_integratedsearchprovider_AsyncOperations asyncoperation regardingobjectid_msdyn_integratedsearchprovider
msdyn_integratedsearchprovider_BulkDeleteFailures bulkdeletefailure regardingobjectid_msdyn_integratedsearchprovider
msdyn_integratedsearchprovider_DuplicateBaseRecord duplicaterecord baserecordid_msdyn_integratedsearchprovider
msdyn_integratedsearchprovider_DuplicateMatchingRecord duplicaterecord duplicaterecordid_msdyn_integratedsearchprovider
msdyn_integratedsearchprovider_FileAttachments fileattachment objectid_msdyn_integratedsearchprovider
msdyn_integratedsearchprovider_MailboxTrackingFolders mailboxtrackingfolder regardingobjectid_msdyn_integratedsearchprovider
msdyn_integratedsearchprovider_PrincipalObjectAttributeAccesses principalobjectattributeaccess objectid_msdyn_integratedsearchprovider
msdyn_integratedsearchprovider_ProcessSession processsession regardingobjectid_msdyn_integratedsearchprovider
msdyn_integratedsearchprovider_SyncErrors syncerror regardingobjectid_msdyn_integratedsearchprovider
msdyn_knowledgearticle_integratedsearchprovider knowledgearticle msdyn_integratedsearchproviderid


The following operations can be used with the msdyn_integratedsearchprovider entity type.

Name Binding
CreateMultiple Not Bound
GrantAccess Not Bound
IsValidStateTransition Not Bound
ModifyAccess Not Bound
RetrievePrincipalAccess Not Bound
RetrieveSharedPrincipalsAndAccess Not Bound
RevokeAccess Not Bound
UpdateMultiple Not Bound

See also