CrmServiceClient.GetEntityDataByFetchSearch Method

  • Reference

Definition

Namespace:
Microsoft.Xrm.Tooling.Connector
Assembly:
Microsoft.Xrm.Tooling.Connector.dll
Package:
Microsoft.CrmSdk.XrmTooling.CoreAssembly v9.1.1.45

Overloads

GetEntityDataByFetchSearch(String, Guid)

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

Searches for data based on a FetchXML query

GetEntityDataByFetchSearch(String, Guid)

Searches for data based on a FetchXML query

public System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataByFetchSearch (string fetchXml, Guid batchId = default);
member this.GetEntityDataByFetchSearch : string * Guid -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>>
Public Function GetEntityDataByFetchSearch (fetchXml As String, Optional batchId As Guid = Nothing) As Dictionary(Of String, Dictionary(Of String, Object))

Parameters

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

Returns

Dictionary<String,Dictionary<String,Object>>

results or null

Applies to

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

Searches for data based on a FetchXML query

public System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataByFetchSearch (string fetchXml, int pageCount, int pageNumber, string pageCookie, out string outPageCookie, out bool isMoreRecords, Guid batchId = default);
member this.GetEntityDataByFetchSearch : string * int * int * string * string * bool * Guid -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>>
Public Function GetEntityDataByFetchSearch (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) As Dictionary(Of String, Dictionary(Of String, Object))

Parameters

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

Returns

Dictionary<String,Dictionary<String,Object>>

results or null

Applies to