CrmServiceClient CrmServiceClient CrmServiceClient CrmServiceClient Class

Definition

Contains data for the primary implementation of the API interface for Common Data Service.

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)

Uses the Organization service proxy provided by the user.

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

Uses the Organization Web proxy Client provided by the user.

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

CrmServiceClient to accept the connectionstring as a parameter.

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

Offloads authentication to class that implements IOverrideAuthHookWrapper.

CrmServiceClient(Uri, String, SecureString, Boolean, String) CrmServiceClient(Uri, String, SecureString, Boolean, String) CrmServiceClient(Uri, String, SecureString, Boolean, String) CrmServiceClient(Uri, String, SecureString, Boolean, String)

ClientID/ClientSecret based authentication flow, allowing for secure client Id passing.

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

ClientID/ClientSecret based authentication flow.

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)

Logs in with user supplied settings using Active Directory.

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)

Logs in with user supplied settings using 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)

Logs in with user supplied settings using Windows Live or 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 authentication type. This requires the org API url.

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)

Logs in with Claims based authentication type.

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 authentication type for On-premises connections.

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

Log in with OAuth authentication type for online connections.

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)

Log in with OAuth authentication type for On-premises connections.

Fields

_sdkVersionProperty _sdkVersionProperty _sdkVersionProperty _sdkVersionProperty

Properties

ActiveAuthenticationType ActiveAuthenticationType ActiveAuthenticationType ActiveAuthenticationType

Authentication type to use.

Authority Authority Authority Authority

OAuth Authority.

AuthOverrideHook AuthOverrideHook AuthOverrideHook AuthOverrideHook

External token acquire behavior, for internal use only.

CallerAADObjectId CallerAADObjectId CallerAADObjectId CallerAADObjectId

Gets or sets the AAD Object Id of the caller. This is supported for Xrm 8.1 + versions only.

CallerId CallerId CallerId CallerId

Gets or sets the current caller Id.

ConnectedOrgFriendlyName ConnectedOrgFriendlyName ConnectedOrgFriendlyName ConnectedOrgFriendlyName

Returns the friendly name of the connected org.

ConnectedOrgId ConnectedOrgId ConnectedOrgId ConnectedOrgId

Id of the connected organization.

ConnectedOrgPublishedEndpoints ConnectedOrgPublishedEndpoints ConnectedOrgPublishedEndpoints ConnectedOrgPublishedEndpoints

Returns the endpoint collection for the connected org.

ConnectedOrgUniqueName ConnectedOrgUniqueName ConnectedOrgUniqueName ConnectedOrgUniqueName

Returns the unique name for the org that has been connected.

ConnectedOrgVersion ConnectedOrgVersion ConnectedOrgVersion ConnectedOrgVersion

Returns the version number of the connected Common Data Service organization. If accessed before the organization is connected, value returned will be null or 0.0

ConnectionLockObject ConnectionLockObject ConnectionLockObject ConnectionLockObject

This is the connection lock object that is used to control the connection access for various threads. This should be used if you are using the Common Data Service queries via Linq to lock the connection.

CrmConnectOrgUriActual CrmConnectOrgUriActual CrmConnectOrgUriActual CrmConnectOrgUriActual

Returns the actual URI used to connect to Common Data Service. This URI could be influenced by user defined variables.

CurrentAccessToken CurrentAccessToken CurrentAccessToken CurrentAccessToken

Returns the current access token in use to connect to Common Data Service. Note: This is only available when a token based authentication process is in use.

DisableCrossThreadSafeties DisableCrossThreadSafeties DisableCrossThreadSafeties DisableCrossThreadSafeties

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

EnvironmentId EnvironmentId EnvironmentId EnvironmentId
ForceServerMetadataCacheConsistency ForceServerMetadataCacheConsistency ForceServerMetadataCacheConsistency ForceServerMetadataCacheConsistency

This will force the Common Data Service server to refresh the current metadata cache with current database config. Note, that this is a performance impacting property. Use of this flag will slow down operations server side as the server is required to check for consistency of the platform metadata against disk on each API call executed. It is recommended to use this only in conjunction with solution import or delete operations.

IsBatchOperationsAvailable IsBatchOperationsAvailable IsBatchOperationsAvailable IsBatchOperationsAvailable

If true then Batch Operations are available.

IsReady IsReady IsReady IsReady

If true the service is ready to accept requests.

LastCrmError LastCrmError LastCrmError LastCrmError

Returns the last String error that was created by the Common Data Service connection.

LastCrmException LastCrmException LastCrmException LastCrmException

Returns the Last Exception from Common Data Service.

MaxConnectionTimeout MaxConnectionTimeout MaxConnectionTimeout MaxConnectionTimeout

Gets or sets the max connection timeout for the connection. Default setting is 2 min, this property can also be set via app.config/app.settings with the property MaxCrmConnectionTimeOutMinutes.

MaxRetryCount MaxRetryCount MaxRetryCount MaxRetryCount

Gets or sets max retry count.

OAuthUserId OAuthUserId OAuthUserId OAuthUserId

Logged in Office365 UserId using OAuth.

OrganizationServiceProxy OrganizationServiceProxy OrganizationServiceProxy OrganizationServiceProxy

Exposed OrganizationServiceProxy for consumers.

OrganizationWebProxyClient OrganizationWebProxyClient OrganizationWebProxyClient OrganizationWebProxyClient

Exposed OrganizationWebProxyClient for consumers.

RetryPauseTime RetryPauseTime RetryPauseTime RetryPauseTime

Gets or sets retry pause time.

SdkVersionProperty SdkVersionProperty SdkVersionProperty SdkVersionProperty

Get the Client SDK version property.

SessionTrackingId SessionTrackingId SessionTrackingId SessionTrackingId

This Id is used to support Common Data Service telemtry when trouble shooting SDK based errors. When set by the caller, all the API actions executed by this client will be tracked under a single session id for later troubleshooting. For example, you are able to group all actions in a given run of your client ( seveal creates / reads and such ) under a given tracking id that is shared on all requests. providing this id when when reporting a problem will aid in trouble shooting your issue.

TenantId TenantId TenantId TenantId

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)

This will 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 Common Data Service.

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 Common Data Service client with a new connection to Common Data Service. Clone only works for connections creating using OAuth protocol.

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

Clones the current Common Data Service client with a new connection to Common Data Service. 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 Common Data Service, this special handling is necessary to support Common Data Service 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 Common Data Service.

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 Common Data Service.

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)

Create a Batch request for executing batch operations. This returns an Id 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.

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 a Delete request to Common Data Service.

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

Executes a Delete and Promote request against Common Data Service using the Async pattern.

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

Deletes an entity from Common Data Service.

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 a Disassociate request to Common Data Service.

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

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, Boolean) DiscoverOrganizations(Uri, ClientCredentials, UserIdentifier, String, Uri, String, Boolean, String, PromptBehavior, Boolean) DiscoverOrganizations(Uri, ClientCredentials, UserIdentifier, String, Uri, String, Boolean, String, PromptBehavior, Boolean) DiscoverOrganizations(Uri, ClientCredentials, UserIdentifier, String, Uri, String, Boolean, String, PromptBehavior, Boolean)

Discovers the organizations, used for OAuth.

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

Disposed the resources used by the CrmService Client.

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 Common Data Service 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 Common Data Service 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 Xrm WebAPI.

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.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, 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.CrmSearchFilter>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient.CrmSearchFilter>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient.CrmSearchFilter>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetActivitiesBy(String, Guid, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient.CrmSearchFilter>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, 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 Common Data Service.

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.CrmSearchFilter>, String, List<CrmServiceClient.CrmSearchFilter>, String, String, String, CrmServiceClient+LogicalSearchOperator, List<String>, Guid, Boolean) GetEntityDataByLinkedSearch(String, List<CrmServiceClient.CrmSearchFilter>, String, List<CrmServiceClient.CrmSearchFilter>, String, String, String, CrmServiceClient+LogicalSearchOperator, List<String>, Guid, Boolean) GetEntityDataByLinkedSearch(String, List<CrmServiceClient.CrmSearchFilter>, String, List<CrmServiceClient.CrmSearchFilter>, String, String, String, CrmServiceClient+LogicalSearchOperator, List<String>, Guid, Boolean) GetEntityDataByLinkedSearch(String, List<CrmServiceClient.CrmSearchFilter>, String, List<CrmServiceClient.CrmSearchFilter>, 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.LogicalSortOrder>, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, Dictionary<String,String>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, 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.CrmSearchFilter>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient.CrmSearchFilter>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient.CrmSearchFilter>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataByRollup(String, Guid, String, List<String>, CrmServiceClient+LogicalSearchOperator, List<CrmServiceClient.CrmSearchFilter>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, 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.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Guid)

Gets a list of accounts based on the search parameters.

GetEntityDataBySearchParams(String, List<CrmServiceClient.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, Int32, Int32, String, String, Boolean, Guid) GetEntityDataBySearchParams(String, List<CrmServiceClient.CrmSearchFilter>, CrmServiceClient+LogicalSearchOperator, List<String>, Dictionary<String,CrmServiceClient.LogicalSortOrder>, 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 Common Data Service, 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 type code of an entity by name.

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

Gets a global option set from Common Data Service.

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

Returns 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 Common Data Service.

ImportSolutionToCrm(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>) ImportSolutionToCrm(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>) ImportSolutionToCrm(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>) ImportSolutionToCrm(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>)

Imports a Common Data Service solution to the Common Data Service Server currently connected.

*** Note: This is a blocking call and will take time to import to Common Data Service ***

ImportSolutionToCrmAsync(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>) ImportSolutionToCrmAsync(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>) ImportSolutionToCrmAsync(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>) ImportSolutionToCrmAsync(String, Guid, Boolean, Boolean, Boolean, Boolean, Boolean, Dictionary<String,Object>)

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

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

Request Common Data Service to install sample data shipped with Common Data Service. 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 Common Data Service 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 a Retrieve request to Common Data Service.

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 has the exception.

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

Issues a RetrieveMultiple request to Common Data Service.

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 Common Data Service.

Supports a single file per import request.

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

Request Common Data Service to remove sample data that shipped with Common Data Service. 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)

Issues an update to Common Data Service.

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