Share via


QueryExtensions.GetEntityDataByRollup Method

Definition

Overloads

GetEntityDataByRollup(ServiceClient, String, Guid, String, List<String>, LogicalSearchOperator, Dictionary<String,String>, Dictionary<String, LogicalSortOrder>, Guid)

Returns all Activities Related to a given Entity ID. Only Account, Contact and Opportunity entities are supported.

GetEntityDataByRollup(ServiceClient, String, Guid, String, List<String>, LogicalSearchOperator, List<DataverseSearchFilter>, Dictionary<String, LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid, Boolean)

Returns all Activities Related to a given Entity ID. Only Account, Contact and Opportunity entities are supported.

GetEntityDataByRollup(ServiceClient, String, Guid, String, List<String>, LogicalSearchOperator, Dictionary<String,String>, Dictionary<String, LogicalSortOrder>, Guid)

Returns all Activities Related to a given Entity ID. Only Account, Contact and Opportunity entities are supported.

public static System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataByRollup (this Microsoft.PowerPlatform.Dataverse.Client.ServiceClient serviceClient, string searchEntity, Guid entityId, string rollupfromEntity, System.Collections.Generic.List<string> fieldList, Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator searchOperator, System.Collections.Generic.Dictionary<string,string> searchParameters, System.Collections.Generic.Dictionary<string,Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSortOrder> sortParameters, Guid batchId = default);
static member GetEntityDataByRollup : Microsoft.PowerPlatform.Dataverse.Client.ServiceClient * string * Guid * string * System.Collections.Generic.List<string> * Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator * System.Collections.Generic.Dictionary<string, string> * System.Collections.Generic.Dictionary<string, Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSortOrder> * Guid -> System.Collections.Generic.Dictionary<string, System.Collections.Generic.Dictionary<string, obj>>
<Extension()>
Public Function GetEntityDataByRollup (serviceClient As ServiceClient, searchEntity As String, entityId As Guid, rollupfromEntity As String, fieldList As List(Of String), searchOperator As LogicalSearchOperator, searchParameters As Dictionary(Of String, String), sortParameters As Dictionary(Of String, LogicalSortOrder), Optional batchId As Guid = Nothing) As Dictionary(Of String, Dictionary(Of String, Object))

Parameters

serviceClient
ServiceClient

ServiceClient

searchEntity
String

Type of Entity to search against

entityId
Guid

ID of the entity to search against.

rollupfromEntity
String

Entity to Rollup from

fieldList
List<String>

List of Field to return for the entity , null indicates all fields.

searchOperator
LogicalSearchOperator
searchParameters
Dictionary<String,String>

Filters responses based on search prams.

sortParameters
Dictionary<String,LogicalSortOrder>

Sort Order

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

Array of Activities

Applies to

GetEntityDataByRollup(ServiceClient, String, Guid, String, List<String>, LogicalSearchOperator, List<DataverseSearchFilter>, Dictionary<String, LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid, Boolean)

Returns all Activities Related to a given Entity ID. Only Account, Contact and Opportunity entities are supported.

public static System.Collections.Generic.Dictionary<string,System.Collections.Generic.Dictionary<string,object>> GetEntityDataByRollup (this Microsoft.PowerPlatform.Dataverse.Client.ServiceClient serviceClient, string searchEntity, Guid entityId, string rollupfromEntity, System.Collections.Generic.List<string> fieldList, Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator searchOperator, System.Collections.Generic.List<Microsoft.PowerPlatform.Dataverse.Client.Extensions.DataverseSearchFilter> searchParameters, 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 GetEntityDataByRollup : Microsoft.PowerPlatform.Dataverse.Client.ServiceClient * string * Guid * string * System.Collections.Generic.List<string> * Microsoft.PowerPlatform.Dataverse.Client.Extensions.LogicalSearchOperator * System.Collections.Generic.List<Microsoft.PowerPlatform.Dataverse.Client.Extensions.DataverseSearchFilter> * 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 GetEntityDataByRollup (serviceClient As ServiceClient, searchEntity As String, entityId As Guid, rollupfromEntity As String, fieldList As List(Of String), searchOperator As LogicalSearchOperator, searchParameters As List(Of DataverseSearchFilter), 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

searchEntity
String

Type of Entity to search against

entityId
Guid

ID of the entity to search against.

rollupfromEntity
String

Entity to Rollup from

fieldList
List<String>

List of Field to return for the entity , null indicates all fields.

searchOperator
LogicalSearchOperator

Search Operator to user

searchParameters
List<DataverseSearchFilter>

Dataverse Filter list to apply

sortParameters
Dictionary<String,LogicalSortOrder>

Sort by

pageCount
Int32

Number of Pages

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

Applies to