Share via


QueryExtensions.GetEntityDataByLinkedSearch Method

Definition

Overloads

GetEntityDataByLinkedSearch(ServiceClient, String, Dictionary<String, String>, String, Dictionary<String,String>, String, String, String, LogicalSearchOperator, List<String>, Guid, Boolean)

Queries an Object via a M to M Link

GetEntityDataByLinkedSearch(ServiceClient, String, List<DataverseSearchFilter>, String, List<DataverseSearchFilter>, String, String, String, LogicalSearchOperator, List<String>, Guid, Boolean, Boolean)

Queries an Object via a M to M Link

GetEntityDataByLinkedSearch(ServiceClient, String, Dictionary<String, String>, String, Dictionary<String,String>, String, String, String, LogicalSearchOperator, List<String>, Guid, Boolean)

Queries an Object via a M to M Link

public static System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataByLinkedSearch (this Microsoft.PowerPlatform.Dataverse.Client.ServiceClient serviceClient, string returnEntityName, System.Collections.Generic.Dictionary<string,string> primarySearchParameters, string linkedEntityName, System.Collections.Generic.Dictionary<string,string> linkedSearchParameters, string linkedEntityLinkAttribName, string m2MEntityName, string returnEntityPrimaryId, Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator searchOperator, System.Collections.Generic.List<string> fieldList, Guid batchId = default, bool bypassPluginExecution = false);
static member GetEntityDataByLinkedSearch : Microsoft.PowerPlatform.Dataverse.Client.ServiceClient * string * System.Collections.Generic.Dictionary<string, string> * string * System.Collections.Generic.Dictionary<string, string> * string * 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 GetEntityDataByLinkedSearch (serviceClient As ServiceClient, returnEntityName As String, primarySearchParameters As Dictionary(Of String, String), linkedEntityName As String, linkedSearchParameters As Dictionary(Of String, String), linkedEntityLinkAttribName As String, m2MEntityName As String, returnEntityPrimaryId As 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

returnEntityName
String

Name of the entity you want return data from

primarySearchParameters
Dictionary<String,String>

Search Prams for the Return Entity

linkedEntityName
String

Name of the entity you are linking too

linkedSearchParameters
Dictionary<String,String>

Search Prams for the Entity you are linking too

linkedEntityLinkAttribName
String

Key field on the Entity you are linking too

m2MEntityName
String

Dataverse Name of the Relationship

returnEntityPrimaryId
String

Key field on the Entity you want to return data from

searchOperator
LogicalSearchOperator

Search Operator to apply

fieldList
List<String>

List of Fields from the Returned Entity you want

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

Applies to

GetEntityDataByLinkedSearch(ServiceClient, String, List<DataverseSearchFilter>, String, List<DataverseSearchFilter>, String, String, String, LogicalSearchOperator, List<String>, Guid, Boolean, Boolean)

Queries an Object via a M to M Link

public static System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataByLinkedSearch (this Microsoft.PowerPlatform.Dataverse.Client.ServiceClient serviceClient, string returnEntityName, System.Collections.Generic.List<Microsoft.PowerPlatform.Dataverse.Client.Extensions.DataverseSearchFilter> primarySearchParameters, string linkedEntityName, System.Collections.Generic.List<Microsoft.PowerPlatform.Dataverse.Client.Extensions.DataverseSearchFilter> linkedSearchParameters, string linkedEntityLinkAttribName, string m2MEntityName, string returnEntityPrimaryId, Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator searchOperator, System.Collections.Generic.List<string> fieldList, Guid batchId = default, bool isReflexiveRelationship = false, bool bypassPluginExecution = false);
static member GetEntityDataByLinkedSearch : Microsoft.PowerPlatform.Dataverse.Client.ServiceClient * string * System.Collections.Generic.List<Microsoft.PowerPlatform.Dataverse.Client.Extensions.DataverseSearchFilter> * string * System.Collections.Generic.List<Microsoft.PowerPlatform.Dataverse.Client.Extensions.DataverseSearchFilter> * string * string * string * Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator * System.Collections.Generic.List<string> * Guid * bool * bool -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>>
<Extension()>
Public Function GetEntityDataByLinkedSearch (serviceClient As ServiceClient, returnEntityName As String, primarySearchParameters As List(Of DataverseSearchFilter), linkedEntityName As String, linkedSearchParameters As List(Of DataverseSearchFilter), linkedEntityLinkAttribName As String, m2MEntityName As String, returnEntityPrimaryId As String, searchOperator As LogicalSearchOperator, fieldList As List(Of String), Optional batchId As Guid = Nothing, Optional isReflexiveRelationship As Boolean = false, Optional bypassPluginExecution As Boolean = false) As Dictionary(Of String, Dictionary(Of String, Object))

Parameters

serviceClient
ServiceClient

ServiceClient

returnEntityName
String

Name of the entity you want return data from

primarySearchParameters
List<DataverseSearchFilter>

Search Prams for the Return Entity

linkedEntityName
String

Name of the entity you are linking too

linkedSearchParameters
List<DataverseSearchFilter>

Search Prams for the Entity you are linking too

linkedEntityLinkAttribName
String

Key field on the Entity you are linking too

m2MEntityName
String

Dataverse Name of the Relationship

returnEntityPrimaryId
String

Key field on the Entity you want to return data from

searchOperator
LogicalSearchOperator

Search Operator to apply

fieldList
List<String>

List of Fields from the Returned Entity you want

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

isReflexiveRelationship
Boolean

If the relationship is defined as Entity:Entity or Account N:N Account, this parameter should be set to true

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

Applies to