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

 

Updated: November 29, 2016

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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

Namespace:   Microsoft.Xrm.Tooling.Connector
Assembly:  Microsoft.Xrm.Tooling.Connector (in Microsoft.Xrm.Tooling.Connector.dll)

public Dictionary<string, Dictionary<string, object>> GetEntityDataBySearchParams(
	string entityName,
	List<CrmServiceClient.CrmSearchFilter> searchParameters,
	CrmServiceClient.LogicalSearchOperator searchOperator,
	List<string> fieldList,
	Dictionary<string, CrmServiceClient.LogicalSortOrder> sortParameters,
	int pageCount,
	int pageNumber,
	string pageCookie,
	out string outPageCookie,
	out bool isMoreRecords,
	Guid batchId = null
)

Parameters

entityName
Type: System.String

Name of the entity to search

searchParameters
Type: System.Collections.Generic.List<CrmServiceClient.CrmSearchFilter>

Array of Search Parameters

fieldList
Type: System.Collections.Generic.List<String>

List of fields to retrieve, Null indicates all Fields

searchOperator
Type: Microsoft.Xrm.Tooling.Connector.CrmServiceClient.LogicalSearchOperator

Logical Search Operator

pageCount
Type: System.Int32

Number records per Page

pageNumber
Type: System.Int32

Current Page number

pageCookie
Type: System.String

inbound place holder cookie

outPageCookie
Type: System.String

outbound place holder cookie

isMoreRecords
Type: System.Boolean

is there more records or not

sortParameters
Type: System.Collections.Generic.Dictionary<String, CrmServiceClient.LogicalSortOrder>

Sort order

batchId
Type: System.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

Return Value

Type: System.Collections.Generic.Dictionary<String, Dictionary<String, Object>>

List of matching Entity Types.

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Show: