CrmServiceClient CrmServiceClient CrmServiceClient CrmServiceClient Class

Definition

Provides the low-level interaction and wrapper methods to connect to Microsoft Dynamics 365 Customer Engagement or Common Data Services for Apps, and execute actions.

public ref class CrmServiceClient sealed : IDisposable, Microsoft::Xrm::Sdk::IOrganizationService
public sealed class CrmServiceClient : IDisposable, Microsoft.Xrm.Sdk.IOrganizationService
type CrmServiceClient = class
    interface IOrganizationService
    interface IDisposable
Public NotInheritable Class CrmServiceClient
Implements IDisposable, IOrganizationService
Inheritance
CrmServiceClientCrmServiceClientCrmServiceClientCrmServiceClient
Implements

Remarks

Constructors

CrmServiceClient(OrganizationServiceProxy) CrmServiceClient(OrganizationServiceProxy) CrmServiceClient(OrganizationServiceProxy) CrmServiceClient(OrganizationServiceProxy)

Initializes a new instance of the CrmServiceClient class using the Organization service proxy provided by the user.

CrmServiceClient(OrganizationWebProxyClient) CrmServiceClient(OrganizationWebProxyClient) CrmServiceClient(OrganizationWebProxyClient) CrmServiceClient(OrganizationWebProxyClient)

Initializes a new instance of the CrmServiceClient class using the OrganizationWebProxyClient instance provided by the user.

CrmServiceClient(String) CrmServiceClient(String) CrmServiceClient(String) CrmServiceClient(String)

Initializes a new instance of the CrmServiceClient class using a connection string.

CrmServiceClient(Uri, Boolean) CrmServiceClient(Uri, Boolean) CrmServiceClient(Uri, Boolean) CrmServiceClient(Uri, Boolean)

Offloads Authentication to class that implements IOverrideAuthHookWrapper.

CrmServiceClient(NetworkCredential, String, String, String, Boolean, Boolean, OrganizationDetail) CrmServiceClient(NetworkCredential, String, String, String, Boolean, Boolean, OrganizationDetail) CrmServiceClient(NetworkCredential, String, String, String, Boolean, Boolean, OrganizationDetail) CrmServiceClient(NetworkCredential, String, String, String, Boolean, Boolean, OrganizationDetail)

Initializes a new instance of the CrmServiceClient class using the specified network credentials and Active Directory (AD) authentication.

CrmServiceClient(NetworkCredential, AuthenticationType, String, String, String, Boolean, Boolean, OrganizationDetail) CrmServiceClient(NetworkCredential, AuthenticationType, String, String, String, Boolean, Boolean, OrganizationDetail) CrmServiceClient(NetworkCredential, AuthenticationType, String, String, String, Boolean, Boolean, OrganizationDetail) CrmServiceClient(NetworkCredential, AuthenticationType, String, String, String, Boolean, Boolean, OrganizationDetail)

Initializes a new instance of the CrmServiceClient class using the specified network credentials and authentication type as AD or IFD

CrmServiceClient(String, SecureString, String, String, Boolean, Boolean, OrganizationDetail, Boolean) CrmServiceClient(String, SecureString, String, String, Boolean, Boolean, OrganizationDetail, Boolean) CrmServiceClient(String, SecureString, String, String, Boolean, Boolean, OrganizationDetail, Boolean) CrmServiceClient(String, SecureString, String, String, Boolean, Boolean, OrganizationDetail, Boolean)

Initializes a new instance of the CrmServiceClient class using the specified network credentials and authentication type as Office 365.

CrmServiceClient(X509Certificate2, StoreName, String, Uri, Boolean, OrganizationDetail, String, Uri, String) CrmServiceClient(X509Certificate2, StoreName, String, Uri, Boolean, OrganizationDetail, String, Uri, String) CrmServiceClient(X509Certificate2, StoreName, String, Uri, Boolean, OrganizationDetail, String, Uri, String) CrmServiceClient(X509Certificate2, StoreName, String, Uri, Boolean, OrganizationDetail, String, Uri, String)

Log in with certificate Auth OnLine connections. This requires the org API URI.

CrmServiceClient(String, SecureString, String, String, String, String, String, Boolean, Boolean, OrganizationDetail) CrmServiceClient(String, SecureString, String, String, String, String, String, Boolean, Boolean, OrganizationDetail) CrmServiceClient(String, SecureString, String, String, String, String, String, Boolean, Boolean, OrganizationDetail) CrmServiceClient(String, SecureString, String, String, String, String, String, Boolean, Boolean, OrganizationDetail)

Initializes a new instance of the CrmServiceClient class using the specified network credentials and claims-based authentication.

CrmServiceClient(X509Certificate2, StoreName, String, Uri, String, Boolean, Boolean, OrganizationDetail, String, Uri, String) CrmServiceClient(X509Certificate2, StoreName, String, Uri, String, Boolean, Boolean, OrganizationDetail, String, Uri, String) CrmServiceClient(X509Certificate2, StoreName, String, Uri, String, Boolean, Boolean, OrganizationDetail, String, Uri, String) CrmServiceClient(X509Certificate2, StoreName, String, Uri, String, Boolean, Boolean, OrganizationDetail, String, Uri, String)

Log in with Certificate Auth On-Premises connections.

CrmServiceClient(String, SecureString, String, String, Boolean, OrganizationDetail, UserIdentifier, String, Uri, String, OrganizationWebProxyClient, PromptBehavior) CrmServiceClient(String, SecureString, String, String, Boolean, OrganizationDetail, UserIdentifier, String, Uri, String, OrganizationWebProxyClient, PromptBehavior) CrmServiceClient(String, SecureString, String, String, Boolean, OrganizationDetail, UserIdentifier, String, Uri, String, OrganizationWebProxyClient, PromptBehavior) CrmServiceClient(String, SecureString, String, String, Boolean, OrganizationDetail, UserIdentifier, String, Uri, String, OrganizationWebProxyClient, PromptBehavior)

Initializes a new instance of the CrmServiceClient using the OAuth protocol to connect to your CRM Online instance in Office 365.

CrmServiceClient(String, SecureString, String, String, String, String, String, Boolean, Boolean, OrganizationDetail, UserIdentifier, String, Uri, String, OrganizationWebProxyClient, PromptBehavior) CrmServiceClient(String, SecureString, String, String, String, String, String, Boolean, Boolean, OrganizationDetail, UserIdentifier, String, Uri, String, OrganizationWebProxyClient, PromptBehavior) CrmServiceClient(String, SecureString, String, String, String, String, String, Boolean, Boolean, OrganizationDetail, UserIdentifier, String, Uri, String, OrganizationWebProxyClient, PromptBehavior) CrmServiceClient(String, SecureString, String, String, String, String, String, Boolean, Boolean, OrganizationDetail, UserIdentifier, String, Uri, String, OrganizationWebProxyClient, PromptBehavior)

Initializes a new instance of the CrmServiceClient class using the specified network credentials and OAuth protocol.

Properties

ActiveAuthenticationType ActiveAuthenticationType ActiveAuthenticationType ActiveAuthenticationType

Gets the authentication type used for the active CRM connection.

Authority Authority Authority Authority

The authority provider for OAuth tokens. Unique if any already known.

AuthOverrideHook AuthOverrideHook AuthOverrideHook AuthOverrideHook

External token acquire behaviour, Internal use only.

CallerAADObjectId CallerAADObjectId CallerAADObjectId CallerAADObjectId

Gets or Set the AAD Object ID of the caller. Valid in XRM 8.1 + only.

CallerId CallerId CallerId CallerId

Gets or Sets the current caller ID

ConnectedOrgFriendlyName ConnectedOrgFriendlyName ConnectedOrgFriendlyName ConnectedOrgFriendlyName

Gets the friendly name of the organization that you are connected to.

ConnectedOrgId ConnectedOrgId ConnectedOrgId ConnectedOrgId

ID of the connected organization.

ConnectedOrgPublishedEndpoints ConnectedOrgPublishedEndpoints ConnectedOrgPublishedEndpoints ConnectedOrgPublishedEndpoints

Gets the endpoint collection for the organization you are connected to.

ConnectedOrgUniqueName ConnectedOrgUniqueName ConnectedOrgUniqueName ConnectedOrgUniqueName

Get the unique name of the organization you are connected to.

ConnectedOrgVersion ConnectedOrgVersion ConnectedOrgVersion ConnectedOrgVersion

Gets the version number of the organization you are connected to. If accessed before you are connected to an organization, null or 0.0 is returned.

ConnectionLockObject ConnectionLockObject ConnectionLockObject ConnectionLockObject

Gets the connection lock object that is used to control connection access for various threads. This should be used to lock the connection if you are using the Microsoft Dynamics CRM queries via LINQ.

CrmConnectOrgUriActual CrmConnectOrgUriActual CrmConnectOrgUriActual CrmConnectOrgUriActual

Gets the actual URI used to connect to Microsoft Dynamics CRM. This URI could be influenced by user defined variables.

DisableCrossThreadSafeties DisableCrossThreadSafeties DisableCrossThreadSafeties DisableCrossThreadSafeties

Disabled internal cross thread safeties, this will gain much higher performance, however it place the requirement of thread safety on you, the developer.

IsBatchOperationsAvailable IsBatchOperationsAvailable IsBatchOperationsAvailable IsBatchOperationsAvailable

Gets information about the availability of batch operation. If true, batch operations are available.

IsReady IsReady IsReady IsReady

Gets the service connection status. If true, the service is ready to accept requests.

LastCrmError LastCrmError LastCrmError LastCrmError

Gets the last error that occurred while attempting to connect to Microsoft Dynamics CRM.

LastCrmException LastCrmException LastCrmException LastCrmException

Gets the last exception that occurred while attempting to connect to Microsoft Dynamics CRM.

MaxRetryCount MaxRetryCount MaxRetryCount MaxRetryCount

Number of retries for an execute operation

OAuthUserId OAuthUserId OAuthUserId OAuthUserId

Gets the current user ID used for connecting to CRM using OAuth.

OrganizationServiceProxy OrganizationServiceProxy OrganizationServiceProxy OrganizationServiceProxy

Gets the native Microsoft Dynamics CRM organization service.

OrganizationWebProxyClient OrganizationWebProxyClient OrganizationWebProxyClient OrganizationWebProxyClient

Gets the CRM OrganizationWebProxyClient instance for the active CRM connection using OAuth.

RetryPauseTime RetryPauseTime RetryPauseTime RetryPauseTime

Amount of time to wait between retries

SdkVersionProperty SdkVersionProperty SdkVersionProperty SdkVersionProperty

Get the Client SDK version property

Methods

AddEntityToQueue(Guid, String, String, Guid, Boolean, Guid) AddEntityToQueue(Guid, String, String, Guid, Boolean, Guid) AddEntityToQueue(Guid, String, String, Guid, Boolean, Guid) AddEntityToQueue(Guid, String, String, Guid, Boolean, Guid)

Route an entity to a public queue.

AssignEntityToUser(Guid, String, Guid, Guid) AssignEntityToUser(Guid, String, Guid, Guid) AssignEntityToUser(Guid, String, Guid, Guid) AssignEntityToUser(Guid, String, Guid, Guid)

Assign an Entity to the specified user ID

Associate(String, Guid, Relationship, EntityReferenceCollection) Associate(String, Guid, Relationship, EntityReferenceCollection) Associate(String, Guid, Relationship, EntityReferenceCollection) Associate(String, Guid, Relationship, EntityReferenceCollection)

Issues an Associate Request to CRM.

CancelSalesOrder(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CancelSalesOrder(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CancelSalesOrder(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CancelSalesOrder(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid)

Cancel Sales order

Clone() Clone() Clone() Clone()

Clones the current CRM Service client with a new connection to CRM. Clone only works for connections creating using OAuth Protocol.

Clone(Assembly) Clone(Assembly) Clone(Assembly) Clone(Assembly)

Clones the current CRM Service client with a new connection to CRM. Clone only works for connections creating using OAuth Protocol.

CloseActivity(String, Guid, String, String, Guid) CloseActivity(String, Guid, String, String, Guid) CloseActivity(String, Guid, String, String, Guid) CloseActivity(String, Guid, String, String, Guid)

Closes the Activity type specified. The Activity Entity type supports fax , letter , and phonecall

*Note: This will default to using English names for Status. if you need to use Non-English, you should populate the names for completed for the status and state.

CloseIncident(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CloseIncident(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CloseIncident(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CloseIncident(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid)

Closes an Incident request in CRM, this special handling is necessary to support CRM Built In Object.

CloseOpportunity(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CloseOpportunity(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CloseOpportunity(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CloseOpportunity(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid)

This will close an opportunity as either Won or lost in CRM

CloseQuote(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CloseQuote(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CloseQuote(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid) CloseQuote(Guid, Dictionary<String,CrmDataTypeWrapper>, Int32, Guid)

Closes a quote as won or lost, Revise is not supported via this method

CloseTroubleTicket(Guid, String, String, Guid) CloseTroubleTicket(Guid, String, String, Guid) CloseTroubleTicket(Guid, String, String, Guid) CloseTroubleTicket(Guid, String, String, Guid)

Closes a Trouble ticket by ID

Create(Entity) Create(Entity) Create(Entity) Create(Entity)

Issues a Create request to CRM

CreateAnnotation(String, Guid, Dictionary<String,CrmDataTypeWrapper>, Guid) CreateAnnotation(String, Guid, Dictionary<String,CrmDataTypeWrapper>, Guid) CreateAnnotation(String, Guid, Dictionary<String,CrmDataTypeWrapper>, Guid) CreateAnnotation(String, Guid, Dictionary<String,CrmDataTypeWrapper>, Guid)

This creates a annotation [note] entry, related to a an existing entity

Required Properties in the fieldList

notetext (string) = Text of the note,

subject (string) = this is the title of the note

CreateBatchOperationRequest(String, Boolean, Boolean) CreateBatchOperationRequest(String, Boolean, Boolean) CreateBatchOperationRequest(String, Boolean, Boolean) CreateBatchOperationRequest(String, Boolean, Boolean)

Creates a batch request for executing batch operations. This method returns an ID (GUID) that will be used to identify a request as a batch request vs a "normal" request.

CreateEntityAssociation(String, Guid, String, Guid, String, Guid) CreateEntityAssociation(String, Guid, String, Guid, String, Guid) CreateEntityAssociation(String, Guid, String, Guid, String, Guid) CreateEntityAssociation(String, Guid, String, Guid, String, Guid)

Associates one Entity to another where an M2M Relationship Exists.

CreateMultiEntityAssociation(String, Guid, String, List<Guid>, String, Guid, Boolean) CreateMultiEntityAssociation(String, Guid, String, List<Guid>, String, Guid, Boolean) CreateMultiEntityAssociation(String, Guid, String, List<Guid>, String, Guid, Boolean) CreateMultiEntityAssociation(String, Guid, String, List<Guid>, String, Guid, Boolean)

Associates multiple entities of the same time to a single entity

CreateNewActivityEntry(String, String, Guid, String, String, String, Dictionary<String,CrmDataTypeWrapper>, Guid) CreateNewActivityEntry(String, String, Guid, String, String, String, Dictionary<String,CrmDataTypeWrapper>, Guid) CreateNewActivityEntry(String, String, Guid, String, String, String, Dictionary<String,CrmDataTypeWrapper>, Guid) CreateNewActivityEntry(String, String, Guid, String, String, String, Dictionary<String,CrmDataTypeWrapper>, Guid)

Creates a new activity against the target entity type

CreateNewRecord(String, Dictionary<String,CrmDataTypeWrapper>, String, Boolean, Guid) CreateNewRecord(String, Dictionary<String,CrmDataTypeWrapper>, String, Boolean, Guid) CreateNewRecord(String, Dictionary<String,CrmDataTypeWrapper>, String, Boolean, Guid) CreateNewRecord(String, Dictionary<String,CrmDataTypeWrapper>, String, Boolean, Guid)

Uses the dynamic entity pattern to create a new entity record.

CreateOrUpdatePickListElement(String, String, List<LocalizedLabel>, Int32, Boolean) CreateOrUpdatePickListElement(String, String, List<LocalizedLabel>, Int32, Boolean) CreateOrUpdatePickListElement(String, String, List<LocalizedLabel>, Int32, Boolean) CreateOrUpdatePickListElement(String, String, List<LocalizedLabel>, Int32, Boolean)

Adds an option to a pick list on an entity.

Delete(String, Guid) Delete(String, Guid) Delete(String, Guid) Delete(String, Guid)

Issues an Delete request to CRM

DeleteAndPromoteSolutionAsync(String) DeleteAndPromoteSolutionAsync(String) DeleteAndPromoteSolutionAsync(String) DeleteAndPromoteSolutionAsync(String)

Executes a Delete and Promote Request against CRM using the Async Pattern.

DeleteEntity(String, Guid, Guid) DeleteEntity(String, Guid, Guid) DeleteEntity(String, Guid, Guid) DeleteEntity(String, Guid, Guid)

Deletes an entity from the CRM

DeleteEntityAssociation(String, Guid, String, Guid, String, Guid) DeleteEntityAssociation(String, Guid, String, Guid, String, Guid) DeleteEntityAssociation(String, Guid, String, Guid, String, Guid) DeleteEntityAssociation(String, Guid, String, Guid, String, Guid)

Removes the Association between 2 entity items where an M2M Relationship Exists.

Disassociate(String, Guid, Relationship, EntityReferenceCollection) Disassociate(String, Guid, Relationship, EntityReferenceCollection) Disassociate(String, Guid, Relationship, EntityReferenceCollection) Disassociate(String, Guid, Relationship, EntityReferenceCollection)

Issues an Disassociate Request to CRM

DiscoverGlobalOrganizations(Uri, ClientCredentials, UserIdentifier, String, Uri, String, Boolean, String, PromptBehavior) DiscoverGlobalOrganizations(Uri, ClientCredentials, UserIdentifier, String, Uri, String, Boolean, String, PromptBehavior) DiscoverGlobalOrganizations(Uri, ClientCredentials, UserIdentifier, String, Uri, String, Boolean, String, PromptBehavior) DiscoverGlobalOrganizations(Uri, ClientCredentials, UserIdentifier, String, Uri, String, Boolean, String, PromptBehavior)

Discovers the organizations, used for OAuth.

DiscoverOrganizations(Uri, Uri, NetworkCredential) DiscoverOrganizations(Uri, Uri, NetworkCredential) DiscoverOrganizations(Uri, Uri, NetworkCredential) DiscoverOrganizations(Uri, Uri, NetworkCredential)

Discovers the organizations.

DiscoverOrganizations(Uri, Uri, ClientCredentials, ClientCredentials) DiscoverOrganizations(Uri, Uri, ClientCredentials, ClientCredentials) DiscoverOrganizations(Uri, Uri, ClientCredentials, ClientCredentials) DiscoverOrganizations(Uri, Uri, ClientCredentials, ClientCredentials)

Discovers the organizations.

DiscoverOrganizations(Uri, ClientCredentials, UserIdentifier, String, Uri, String, Boolean, String, PromptBehavior) DiscoverOrganizations(Uri, ClientCredentials, UserIdentifier, String, Uri, String, Boolean, String, PromptBehavior) DiscoverOrganizations(Uri, ClientCredentials, UserIdentifier, String, Uri, String, Boolean, String, PromptBehavior) DiscoverOrganizations(Uri, ClientCredentials, UserIdentifier, String, Uri, String, Boolean, String, PromptBehavior)

Discovers the organizations, used for OAUth.

Dispose() Dispose() Dispose() Dispose()

Disposed the resource used by the CrmServiceClient

Execute(OrganizationRequest) Execute(OrganizationRequest) Execute(OrganizationRequest) Execute(OrganizationRequest)

Executes a general organization request

ExecuteBatch(Guid) ExecuteBatch(Guid) ExecuteBatch(Guid) ExecuteBatch(Guid)

Begins running the Batch command.

ExecuteCrmEntityDeleteRequest(String, Guid, String) ExecuteCrmEntityDeleteRequest(String, Guid, String) ExecuteCrmEntityDeleteRequest(String, Guid, String) ExecuteCrmEntityDeleteRequest(String, Guid, String)

Executes a row level delete on a CRM entity ( thread safe ) and returns true or false. Also adds metrics for logging support.

ExecuteCrmOrganizationRequest(OrganizationRequest, String) ExecuteCrmOrganizationRequest(OrganizationRequest, String) ExecuteCrmOrganizationRequest(OrganizationRequest, String) ExecuteCrmOrganizationRequest(OrganizationRequest, String)

Executes a CRM Organization Request (thread safe) and returns the organization response object. Also adds metrics for logging support.

ExecuteCrmWebRequest(HttpMethod, String, String, Dictionary<String,List<String>>, String) ExecuteCrmWebRequest(HttpMethod, String, String, Dictionary<String,List<String>>, String) ExecuteCrmWebRequest(HttpMethod, String, String, Dictionary<String,List<String>>, String) ExecuteCrmWebRequest(HttpMethod, String, String, Dictionary<String,List<String>>, String)

Executes a web request against Web API.

ExecuteWorkflowOnEntity(String, Guid, Guid) ExecuteWorkflowOnEntity(String, Guid, Guid) ExecuteWorkflowOnEntity(String, Guid, Guid) ExecuteWorkflowOnEntity(String, Guid, Guid)

Executes a named workflow on an object.

GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid)

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

GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid)

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

GetAllAttributesForEntity(String) GetAllAttributesForEntity(String) GetAllAttributesForEntity(String) GetAllAttributesForEntity(String)

Returns all attributes on a entity

GetAllEntityMetadata(Boolean, EntityFilters) GetAllEntityMetadata(Boolean, EntityFilters) GetAllEntityMetadata(Boolean, EntityFilters) GetAllEntityMetadata(Boolean, EntityFilters)

Returns a list of entities with basic data from CRM

GetBatchById(Guid) GetBatchById(Guid) GetBatchById(Guid) GetBatchById(Guid)

TEMP

GetBatchOperationIdRequestByName(String) GetBatchOperationIdRequestByName(String) GetBatchOperationIdRequestByName(String) GetBatchOperationIdRequestByName(String)

Returns the batch id for a given batch name.

GetBatchRequestAtPosition(Guid, Int32) GetBatchRequestAtPosition(Guid, Int32) GetBatchRequestAtPosition(Guid, Int32) GetBatchRequestAtPosition(Guid, Int32)

Returns the organization request at a give position

GetDataByKeyFromResultsSet<T>(Dictionary<String,Object>, String) GetDataByKeyFromResultsSet<T>(Dictionary<String,Object>, String) GetDataByKeyFromResultsSet<T>(Dictionary<String,Object>, String) GetDataByKeyFromResultsSet<T>(Dictionary<String,Object>, String)

This function gets data from a Dictionary object, where "string" identifies the field name, and Object contains the data, this method then attempts to cast the result to the Type requested, if it cannot be cast an empty object is returned.

GetEntityAttributeMetadataForAttribute(String, String) GetEntityAttributeMetadataForAttribute(String, String) GetEntityAttributeMetadataForAttribute(String, String) GetEntityAttributeMetadataForAttribute(String, String)

Gets metadata for a specific entity's attribute.

GetEntityDataByFetchSearch(String, Guid) GetEntityDataByFetchSearch(String, Guid) GetEntityDataByFetchSearch(String, Guid) GetEntityDataByFetchSearch(String, Guid)

Searches for data based on a FetchXML query

GetEntityDataByFetchSearch(String, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByFetchSearch(String, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByFetchSearch(String, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByFetchSearch(String, Int32, Int32, String, String, Boolean, Guid)

Searches for data based on a FetchXML query

GetEntityDataByFetchSearchEC(String, Guid) GetEntityDataByFetchSearchEC(String, Guid) GetEntityDataByFetchSearchEC(String, Guid) GetEntityDataByFetchSearchEC(String, Guid)

Searches for data based on a FetchXML query

GetEntityDataByFetchSearchEC(String, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByFetchSearchEC(String, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByFetchSearchEC(String, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByFetchSearchEC(String, Int32, Int32, String, String, Boolean, Guid)

Searches for data based on a FetchXML query

GetEntityDataById(String, Guid, List<String>, Guid) GetEntityDataById(String, Guid, List<String>, Guid) GetEntityDataById(String, Guid, List<String>, Guid) GetEntityDataById(String, Guid, List<String>, Guid)

Gets a List of variables from the account based on the list of field specified in the Fields List

GetEntityDataByLinkedSearch(String, List<CrmServiceClient>, String, List<CrmServiceClient>, String, String, String, CrmServiceClient+LogicalSearchOperator, List<String>, Guid, Boolean) GetEntityDataByLinkedSearch(String, List<CrmServiceClient>, String, List<CrmServiceClient>, String, String, String, CrmServiceClient+LogicalSearchOperator, List<String>, Guid, Boolean) GetEntityDataByLinkedSearch(String, List<CrmServiceClient>, String, List<CrmServiceClient>, String, String, String, CrmServiceClient+LogicalSearchOperator, List<String>, Guid, Boolean) GetEntityDataByLinkedSearch(String, List<CrmServiceClient>, String, List<CrmServiceClient>, String, String, String, CrmServiceClient+LogicalSearchOperator, List<String>, Guid, Boolean)

Queries an Object via a M to M Link

GetEntityDataByLinkedSearch(String, Dictionary<String,String>, String, Dictionary<String,String>, String, String, String, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataByLinkedSearch(String, Dictionary<String,String>, String, Dictionary<String,String>, String, String, String, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataByLinkedSearch(String, Dictionary<String,String>, String, Dictionary<String,String>, String, String, String, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataByLinkedSearch(String, Dictionary<String,String>, String, Dictionary<String,String>, String, String, String, CrmServiceClient+LogicalSearchOperator, List<String>, Guid)

Queries an Object via a M to M Link

GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient>, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient>, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient>, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient>, Guid)

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

GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid)

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

GetEntityDataBySearchParams(String, Dictionary<String,String>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataBySearchParams(String, Dictionary<String,String>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataBySearchParams(String, Dictionary<String,String>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataBySearchParams(String, Dictionary<String,String>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid)

Gets a list of accounts based on the search parameters.

GetEntityDataBySearchParams(String, List<CrmServiceClient>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid)

Gets a list of accounts based on the search parameters.

GetEntityDataBySearchParams(String, List<CrmServiceClient>, CrmServiceClient+LogicalSearchOperator, List<String>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient>, CrmServiceClient+LogicalSearchOperator, List<String>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient>, CrmServiceClient+LogicalSearchOperator, List<String>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient>, CrmServiceClient+LogicalSearchOperator, List<String>, Dictionary<String,CrmServiceClient>, Int32, Int32, String, String, Boolean, Guid)

Searches for data from an entity based on the search parameters.

GetEntityDisplayName(String, Int32) GetEntityDisplayName(String, Int32) GetEntityDisplayName(String, Int32) GetEntityDisplayName(String, Int32)

Gets an Entity Name by Logical name or Type code.

GetEntityDisplayNamePlural(String, Int32) GetEntityDisplayNamePlural(String, Int32) GetEntityDisplayNamePlural(String, Int32) GetEntityDisplayNamePlural(String, Int32)

Gets an Entity Name by Logical name or Type code.

GetEntityFormIdListByType(String, CrmServiceClient+FormTypeId) GetEntityFormIdListByType(String, CrmServiceClient+FormTypeId) GetEntityFormIdListByType(String, CrmServiceClient+FormTypeId) GetEntityFormIdListByType(String, CrmServiceClient+FormTypeId)

Returns the Form Entity References for a given form type.

GetEntityMetadata(String, EntityFilters) GetEntityMetadata(String, EntityFilters) GetEntityMetadata(String, EntityFilters) GetEntityMetadata(String, EntityFilters)

Returns the Metadata for an entity from CRM, defaults to basic data only.

GetEntityName(Int32) GetEntityName(Int32) GetEntityName(Int32) GetEntityName(Int32)

Returns the Entity name for the given Type code

GetEntityTypeCode(String) GetEntityTypeCode(String) GetEntityTypeCode(String) GetEntityTypeCode(String)

Gets the typecode of an entity by name.

GetGlobalOptionSetMetadata(String) GetGlobalOptionSetMetadata(String) GetGlobalOptionSetMetadata(String) GetGlobalOptionSetMetadata(String)

Gets a global option set from CRM.

GetMyCrmUserId() GetMyCrmUserId() GetMyCrmUserId() GetMyCrmUserId()

Gets the user ID of the currently logged in user.

GetPickListElementFromMetadataEntity(String, String) GetPickListElementFromMetadataEntity(String, String) GetPickListElementFromMetadataEntity(String, String) GetPickListElementFromMetadataEntity(String, String)

Gets a PickList, Status List or StateList from the metadata of an attribute

ImportDataMapToCrm(String, Boolean, Boolean) ImportDataMapToCrm(String, Boolean, Boolean) ImportDataMapToCrm(String, Boolean, Boolean) ImportDataMapToCrm(String, Boolean, Boolean)

Used to upload a data map to the CRM

ImportSolutionToCrm(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean) ImportSolutionToCrm(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean) ImportSolutionToCrm(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean) ImportSolutionToCrm(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean)

Imports a CRM solution to the CRM Server currently connected.

ImportSolutionToCrmAsync(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean) ImportSolutionToCrmAsync(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean) ImportSolutionToCrmAsync(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean) ImportSolutionToCrmAsync(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean)

Import Solution Async used Execute Async pattern to run a solution import.

InstallSampleDataToCrm() InstallSampleDataToCrm() InstallSampleDataToCrm() InstallSampleDataToCrm()

Request CRM to install sample data shipped with CRM. Note this is process will take a few moments to execute.

This method will return once the request has been submitted.

IsSampleDataInstalled() IsSampleDataInstalled() IsSampleDataInstalled() IsSampleDataInstalled()

Determines if the CRM sample data has been installed

MakeSecureString(String) MakeSecureString(String) MakeSecureString(String) MakeSecureString(String)

Makes a secure string

PublishEntity(String) PublishEntity(String) PublishEntity(String) PublishEntity(String)

Publishes an entity to the production system, used in conjunction with the Metadata services.

ReleaseBatchInfoById(Guid) ReleaseBatchInfoById(Guid) ReleaseBatchInfoById(Guid) ReleaseBatchInfoById(Guid)

Release a batch from the stack Once you have completed using a batch, you must release it from the system.

RemoveOAuthTokenCache(String) RemoveOAuthTokenCache(String) RemoveOAuthTokenCache(String) RemoveOAuthTokenCache(String)

Clear the persistent and in-memory store cache

ResetLocalMetadataCache(String) ResetLocalMetadataCache(String) ResetLocalMetadataCache(String) ResetLocalMetadataCache(String)

This will clear the Metadata cache for either all entities or the specified entity

Retrieve(String, Guid, ColumnSet) Retrieve(String, Guid, ColumnSet) Retrieve(String, Guid, ColumnSet) Retrieve(String, Guid, ColumnSet)

Issues an Retrieve Request to CRM

RetrieveBatchResponse(Guid) RetrieveBatchResponse(Guid) RetrieveBatchResponse(Guid) RetrieveBatchResponse(Guid)

Executes the batch command and then parses the retrieved items into a list. If there exists a exception then the LastException would be filled with the first item that had the exception.

RetrieveMultiple(QueryBase) RetrieveMultiple(QueryBase) RetrieveMultiple(QueryBase) RetrieveMultiple(QueryBase)

Issues a RetrieveMultiple Request to CRM

SendSingleEmail(Guid, String, Guid) SendSingleEmail(Guid, String, Guid) SendSingleEmail(Guid, String, Guid) SendSingleEmail(Guid, String, Guid)

Sends an email.

SubmitImportRequest(CrmServiceClient+ImportRequest, DateTime) SubmitImportRequest(CrmServiceClient+ImportRequest, DateTime) SubmitImportRequest(CrmServiceClient+ImportRequest, DateTime) SubmitImportRequest(CrmServiceClient+ImportRequest, DateTime)

Starts an Import request for CRM.

Supports a single file per Import request.

UninstallSampleDataFromCrm() UninstallSampleDataFromCrm() UninstallSampleDataFromCrm() UninstallSampleDataFromCrm()

Request CRM to remove sample data shipped with CRM. Note this is process will take a few moments to execute. This method will return once the request has been submitted.

Update(Entity) Update(Entity) Update(Entity) Update(Entity)

UpdateEntity(String, String, Guid, Dictionary<String,CrmDataTypeWrapper>, String, Boolean, Guid) UpdateEntity(String, String, Guid, Dictionary<String,CrmDataTypeWrapper>, String, Boolean, Guid) UpdateEntity(String, String, Guid, Dictionary<String,CrmDataTypeWrapper>, String, Boolean, Guid) UpdateEntity(String, String, Guid, Dictionary<String,CrmDataTypeWrapper>, String, Boolean, Guid)

Generic update entity

UpdateStateAndStatusForEntity(String, Guid, Int32, Int32, Guid) UpdateStateAndStatusForEntity(String, Guid, Int32, Int32, Guid) UpdateStateAndStatusForEntity(String, Guid, Int32, Int32, Guid) UpdateStateAndStatusForEntity(String, Guid, Int32, Int32, Guid)

Updates the State and Status of the Entity passed in.

UpdateStateAndStatusForEntity(String, Guid, String, String, Guid) UpdateStateAndStatusForEntity(String, Guid, String, String, Guid) UpdateStateAndStatusForEntity(String, Guid, String, String, Guid) UpdateStateAndStatusForEntity(String, Guid, String, String, Guid)

Updates the State and Status of the Entity passed in.

Applies to