QueryExtensions.GetEntityDataBySearchParams Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetEntityDataBySearchParams(ServiceClient, String, Dictionary<String,String>, LogicalSearchOperator, List<String>, Guid, Boolean) |
Gets a list of accounts based on the search parameters. |
| GetEntityDataBySearchParams(ServiceClient, String, List<DataverseSearchFilter>, LogicalSearchOperator, List<String>, Guid, Boolean) |
Gets a list of accounts based on the search parameters. |
| GetEntityDataBySearchParams(ServiceClient, String, List<DataverseSearchFilter>, LogicalSearchOperator, List<String>, Dictionary<String,LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid, Boolean) |
Searches for data from an entity based on the search parameters. |
GetEntityDataBySearchParams(ServiceClient, String, Dictionary<String,String>, LogicalSearchOperator, List<String>, Guid, Boolean)
Gets a list of accounts based on the search parameters.
public static System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataBySearchParams (this Microsoft.PowerPlatform.Dataverse.Client.ServiceClient serviceClient, string entityName, System.Collections.Generic.Dictionary<string,string> searchParameters, Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator searchOperator, System.Collections.Generic.List<string> fieldList, Guid batchId = default, bool bypassPluginExecution = false);static member GetEntityDataBySearchParams : Microsoft.PowerPlatform.Dataverse.Client.ServiceClient * string * System.Collections.Generic.Dictionary<string, string> * Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator * System.Collections.Generic.List<string> * Guid * bool -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>><Extension()>
Public Function GetEntityDataBySearchParams (serviceClient As ServiceClient, entityName As String, searchParameters As Dictionary(Of String, String), searchOperator As LogicalSearchOperator, fieldList As List(Of String), Optional batchId As Guid = Nothing, Optional bypassPluginExecution As Boolean = false) As Dictionary(Of String, Dictionary(Of String, Object))Parameters
- serviceClient
- ServiceClient
ServiceClient
- entityName
- String
Dataverse Entity Type Name to search
- searchParameters
- Dictionary<String,String>
Array of Search Parameters
- searchOperator
- LogicalSearchOperator
Logical Search Operator
- 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
List of matching Entity Types.
Applies to
GetEntityDataBySearchParams(ServiceClient, String, List<DataverseSearchFilter>, LogicalSearchOperator, List<String>, Guid, Boolean)
Gets a list of accounts based on the search parameters.
public static System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataBySearchParams (this Microsoft.PowerPlatform.Dataverse.Client.ServiceClient serviceClient, string entityName, System.Collections.Generic.List<Microsoft.PowerPlatform.Dataverse.Client.Extensions.DataverseSearchFilter> searchParameters, Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator searchOperator, System.Collections.Generic.List<string> fieldList, Guid batchId = default, bool bypassPluginExecution = false);static member GetEntityDataBySearchParams : Microsoft.PowerPlatform.Dataverse.Client.ServiceClient * string * System.Collections.Generic.List<Microsoft.PowerPlatform.Dataverse.Client.Extensions.DataverseSearchFilter> * Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator * System.Collections.Generic.List<string> * Guid * bool -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>><Extension()>
Public Function GetEntityDataBySearchParams (serviceClient As ServiceClient, entityName As String, searchParameters As List(Of DataverseSearchFilter), searchOperator As LogicalSearchOperator, fieldList As List(Of String), Optional batchId As Guid = Nothing, Optional bypassPluginExecution As Boolean = false) As Dictionary(Of String, Dictionary(Of String, Object))Parameters
- serviceClient
- ServiceClient
ServiceClient
- entityName
- String
Dataverse Entity Type Name to search
- searchParameters
- List<DataverseSearchFilter>
Array of Search Parameters
- searchOperator
- LogicalSearchOperator
Logical Search Operator
- 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
List of matching Entity Types.
Applies to
GetEntityDataBySearchParams(ServiceClient, String, List<DataverseSearchFilter>, LogicalSearchOperator, List<String>, Dictionary<String,LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid, Boolean)
Searches for data from an entity based on the search parameters.
public static System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataBySearchParams (this Microsoft.PowerPlatform.Dataverse.Client.ServiceClient serviceClient, string entityName, System.Collections.Generic.List<Microsoft.PowerPlatform.Dataverse.Client.Extensions.DataverseSearchFilter> searchParameters, Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator searchOperator, System.Collections.Generic.List<string> fieldList, System.Collections.Generic.Dictionary<string,Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSortOrder> sortParameters, int pageCount, int pageNumber, string pageCookie, out string outPageCookie, out bool isMoreRecords, Guid batchId = default, bool bypassPluginExecution = false);static member GetEntityDataBySearchParams : Microsoft.PowerPlatform.Dataverse.Client.ServiceClient * string * System.Collections.Generic.List<Microsoft.PowerPlatform.Dataverse.Client.Extensions.DataverseSearchFilter> * Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator * System.Collections.Generic.List<string> * System.Collections.Generic.Dictionary<string, Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSortOrder> * int * int * string * string * bool * Guid * bool -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>><Extension()>
Public Function GetEntityDataBySearchParams (serviceClient As ServiceClient, entityName As String, searchParameters As List(Of DataverseSearchFilter), searchOperator As LogicalSearchOperator, fieldList As List(Of String), sortParameters As Dictionary(Of String, LogicalSortOrder), 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
- entityName
- String
Name of the entity to search
- searchParameters
- List<DataverseSearchFilter>
Array of Search Parameters
- searchOperator
- LogicalSearchOperator
Logical Search Operator
- sortParameters
- Dictionary<String,LogicalSortOrder>
Sort order
- 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
List of matching Entity Types.