Share via


CrmServiceClient.GetEntityDataBySearchParams Method

Definition

Overloads

GetEntityDataBySearchParams(String, Dictionary<String,String>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid)

Gets a list of accounts based on the search parameters.

GetEntityDataBySearchParams(String, List<CrmServiceClient.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid)

Gets a list of accounts based on the search parameters.

GetEntityDataBySearchParams(String, List<CrmServiceClient.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Dictionary<String, CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid)

Searches for data from an entity based on the search parameters.

GetEntityDataBySearchParams(String, Dictionary<String,String>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid)

Gets a list of accounts based on the search parameters.

public System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataBySearchParams (string entityName, System.Collections.Generic.Dictionary<string,string> searchParameters, Microsoft.Xrm.Tooling.Connector.CrmServiceClient.LogicalSearchOperator searchOperator, System.Collections.Generic.List<string> fieldList, Guid batchId = default);
member this.GetEntityDataBySearchParams : string * System.Collections.Generic.Dictionary<string, string> * Microsoft.Xrm.Tooling.Connector.CrmServiceClient.LogicalSearchOperator * System.Collections.Generic.List<string> * Guid -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>>
Public Function GetEntityDataBySearchParams (entityName As String, searchParameters As Dictionary(Of String, String), searchOperator As CrmServiceClient.LogicalSearchOperator, fieldList As List(Of String), Optional batchId As Guid = Nothing) As Dictionary(Of String, Dictionary(Of String, Object))

Parameters

entityName
String

CRM Entity Type Name to search

searchParameters
Dictionary<String,String>

Array of Search Parameters

searchOperator
CrmServiceClient.LogicalSearchOperator

Logical Search Operator

fieldList
List<String>

List of fields to retrieve, Null indicates all Fields

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

List of matching Entity Types.

Applies to

GetEntityDataBySearchParams(String, List<CrmServiceClient.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid)

Gets a list of accounts based on the search parameters.

public System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataBySearchParams (string entityName, System.Collections.Generic.List<Microsoft.Xrm.Tooling.Connector.CrmServiceClient.CrmSearchFilter> searchParameters, Microsoft.Xrm.Tooling.Connector.CrmServiceClient.LogicalSearchOperator searchOperator, System.Collections.Generic.List<string> fieldList, Guid batchId = default);
member this.GetEntityDataBySearchParams : string * System.Collections.Generic.List<Microsoft.Xrm.Tooling.Connector.CrmServiceClient.CrmSearchFilter> * Microsoft.Xrm.Tooling.Connector.CrmServiceClient.LogicalSearchOperator * System.Collections.Generic.List<string> * Guid -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>>
Public Function GetEntityDataBySearchParams (entityName As String, searchParameters As List(Of CrmServiceClient.CrmSearchFilter), searchOperator As CrmServiceClient.LogicalSearchOperator, fieldList As List(Of String), Optional batchId As Guid = Nothing) As Dictionary(Of String, Dictionary(Of String, Object))

Parameters

entityName
String

CRM Entity Type Name to search

searchParameters
List<CrmServiceClient.CrmSearchFilter>

Array of Search Parameters

searchOperator
CrmServiceClient.LogicalSearchOperator

Logical Search Operator

fieldList
List<String>

List of fields to retrieve, Null indicates all Fields

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

List of matching Entity Types.

Applies to

GetEntityDataBySearchParams(String, List<CrmServiceClient.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Dictionary<String, CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid)

Searches for data from an entity based on the search parameters.

public System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataBySearchParams (string entityName, System.Collections.Generic.List<Microsoft.Xrm.Tooling.Connector.CrmServiceClient.CrmSearchFilter> searchParameters, Microsoft.Xrm.Tooling.Connector.CrmServiceClient.LogicalSearchOperator searchOperator, System.Collections.Generic.List<string> fieldList, System.Collections.Generic.Dictionary<string,Microsoft.Xrm.Tooling.Connector.CrmServiceClient.LogicalSortOrder> sortParameters, int pageCount, int pageNumber, string pageCookie, out string outPageCookie, out bool isMoreRecords, Guid batchId = default);
member this.GetEntityDataBySearchParams : string * System.Collections.Generic.List<Microsoft.Xrm.Tooling.Connector.CrmServiceClient.CrmSearchFilter> * Microsoft.Xrm.Tooling.Connector.CrmServiceClient.LogicalSearchOperator * System.Collections.Generic.List<string> * System.Collections.Generic.Dictionary<string, Microsoft.Xrm.Tooling.Connector.CrmServiceClient.LogicalSortOrder> * int * int * string * string * bool * Guid -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>>
Public Function GetEntityDataBySearchParams (entityName As String, searchParameters As List(Of CrmServiceClient.CrmSearchFilter), searchOperator As CrmServiceClient.LogicalSearchOperator, fieldList As List(Of String), sortParameters As Dictionary(Of String, CrmServiceClient.LogicalSortOrder), 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

entityName
String

Name of the entity to search

searchParameters
List<CrmServiceClient.CrmSearchFilter>

Array of Search Parameters

searchOperator
CrmServiceClient.LogicalSearchOperator

Logical Search Operator

fieldList
List<String>

List of fields to retrieve, Null indicates all Fields

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

List of matching Entity Types.

Applies to