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

 

Applies To: Dynamics CRM 2015

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)

Syntax

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
)

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,
    [OutAttribute] String^% outPageCookie,
    [OutAttribute] bool% isMoreRecords,
    Guid batchId = null
)

member GetEntityDataBySearchParams : 
        entityName:string *
        searchParameters:List<CrmServiceClient.CrmSearchFilter> *
        searchOperator:CrmServiceClient.LogicalSearchOperator *
        fieldList:List<string> *
        sortParameters:Dictionary<string, CrmServiceClient.LogicalSortOrder> *
        pageCount:int *
        pageNumber:int *
        pageCookie:string *
        outPageCookie:string byref *
        isMoreRecords:bool byref *
        batchId:Guid = null -> Dictionary<string, Dictionary<string, Object>>

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,
    <OutAttribute> ByRef outPageCookie As String,
    <OutAttribute> ByRef isMoreRecords As Boolean,
    batchId As Guid
) As Dictionary(Of String, Dictionary(Of String, Object))

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.

See Also

GetEntityDataBySearchParams Overload
CrmServiceClient Class
Microsoft.Xrm.Tooling.Connector Namespace

Return to top

© 2016 Microsoft. All rights reserved. Copyright