QueryExtensions.GetEntityDataByFetchSearch Method

Definition

Namespace:

Microsoft.PowerPlatform.Dataverse.Client.Extensions

Assembly:

Microsoft.PowerPlatform.Dataverse.Client.dll

Package:

Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Overloads

GetEntityDataByFetchSearch(ServiceClient, String, Guid, Boolean)	Searches for data based on a FetchXML query
GetEntityDataByFetchSearch(ServiceClient, String, Int32, Int32, String, String, Boolean, Guid, Boolean)	Searches for data based on a FetchXML query

GetEntityDataByFetchSearch(ServiceClient, String, Guid, Boolean)

Searches for data based on a FetchXML query

public static System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataByFetchSearch (this Microsoft.PowerPlatform.Dataverse.Client.ServiceClient serviceClient, string fetchXml, Guid batchId = default, bool bypassPluginExecution = false);

static member GetEntityDataByFetchSearch : Microsoft.PowerPlatform.Dataverse.Client.ServiceClient * string * Guid * bool -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>>

<Extension()>
Public Function GetEntityDataByFetchSearch (serviceClient As ServiceClient, fetchXml As String, Optional batchId As Guid = Nothing, Optional bypassPluginExecution As Boolean = false) As Dictionary(Of String, Dictionary(Of String, Object))

Parameters

serviceClient

ServiceClient

ServiceClient

fetchXml

String

Fetch XML query data.

batchId

Guid

Optional: if set to a valid GUID, generated by the Create Batch Request Method, will assigned the request to the batch for later execution, on fail, runs the request immediately

bypassPluginExecution

Boolean

Adds the bypass plugin behavior to this request. Note: this will only apply if the caller has the prvBypassPlugins permission to bypass plugins. If its attempted without the permission the request will fault.

Returns

Dictionary<String,Dictionary<String,Object>>

results or null

GetEntityDataByFetchSearch(ServiceClient, String, Int32, Int32, String, String, Boolean, Guid, Boolean)

Searches for data based on a FetchXML query

public static System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataByFetchSearch (this Microsoft.PowerPlatform.Dataverse.Client.ServiceClient serviceClient, string fetchXml, int pageCount, int pageNumber, string pageCookie, out string outPageCookie, out bool isMoreRecords, Guid batchId = default, bool bypassPluginExecution = false);

static member GetEntityDataByFetchSearch : Microsoft.PowerPlatform.Dataverse.Client.ServiceClient * string * int * int * string * string * bool * Guid * bool -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>>

<Extension()>
Public Function GetEntityDataByFetchSearch (serviceClient As ServiceClient, fetchXml As String, pageCount As Integer, pageNumber As Integer, pageCookie As String, ByRef outPageCookie As String, ByRef isMoreRecords As Boolean, Optional batchId As Guid = Nothing, Optional bypassPluginExecution As Boolean = false) As Dictionary(Of String, Dictionary(Of String, Object))

Parameters

serviceClient

ServiceClient

ServiceClient

fetchXml

String

Fetch XML query data.

pageCount

Int32

Number records per Page

pageNumber

Int32

Current Page number

pageCookie

String

inbound place holder cookie

outPageCookie

String

outbound place holder cookie

isMoreRecords

Boolean

is there more records or not

batchId

Guid

Optional: if set to a valid GUID, generated by the Create Batch Request Method, will assigned the request to the batch for later execution, on fail, runs the request immediately

bypassPluginExecution

Boolean

Adds the bypass plugin behavior to this request. Note: this will only apply if the caller has the prvBypassPlugins permission to bypass plugins. If its attempted without the permission the request will fault.

Returns

Dictionary<String,Dictionary<String,Object>>

results or null