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

 

Applies To: Dynamics CRM 2015

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

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

Syntax

public Dictionary<string, Dictionary<string, object>> GetActivitiesBy(
    string searchEntity,
    Guid entityId,
    List<string> fieldList,
    CrmServiceClient.LogicalSearchOperator searchOperator,
    Dictionary<string, string> searchParameters,
    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^>^>^ GetActivitiesBy(
    String^ searchEntity,
    Guid entityId,
    List<String^>^ fieldList,
    CrmServiceClient::LogicalSearchOperator searchOperator,
    Dictionary<String^, String^>^ searchParameters,
    Dictionary<String^, CrmServiceClient::LogicalSortOrder>^ sortParameters,
    int pageCount,
    int pageNumber,
    String^ pageCookie,
    [OutAttribute] String^% outPageCookie,
    [OutAttribute] bool% isMoreRecords,
    Guid batchId = null
)

member GetActivitiesBy : 
        searchEntity:string *
        entityId:Guid *
        fieldList:List<string> *
        searchOperator:CrmServiceClient.LogicalSearchOperator *
        searchParameters:Dictionary<string, 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 GetActivitiesBy (
    searchEntity As String,
    entityId As Guid,
    fieldList As List(Of String),
    searchOperator As CrmServiceClient.LogicalSearchOperator,
    searchParameters As Dictionary(Of String, 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

• searchEntity
  Type: System.String

  Type of Entity to search against

• entityId
  Type: System.Guid

  ID of the entity to search against.

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

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

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

  Search Operator to use

• searchParameters
  Type: System.Collections.Generic.Dictionary<String, String>

  Filters responses based on search prams.

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

  Sort order

• pageCount
  Type: System.Int32

  Number of Pages

• 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

• 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>>

Array of Activities

See Also

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

Return to top

© 2016 Microsoft. All rights reserved. Copyright