Export (0) Print
Expand All

SdkMessage entity messages and methods

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

This entity represents a message that is supported by the SDK. The schema name for this entity is SdkMessage. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the tools folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

 

message Description

RetrieveRequest

Retrieves an SDK message. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of SDK messages. You can also call the IOrganizationService.RetrieveMultiple method.

Mapping between names

The following table contains the mappings for the SdkMessage.Name, SdkMessageRequest.Name and SdkMessage.CategoryName attributes.

 

SdkMessage.Name SdkMessageRequest.Name SdkMessage.CategoryName

AddItem

AddItemCampaignActivity

None

AddItem

AddItemCampaign

None

AddListMembers

AddListMembersList

None

AddMember

AddMemberList

None

AddMembers

AddMembersTeam

None

AddPrivileges

AddPrivilegesRole

None

AddProductToKit

AddProductToKit

None

AddRecurrence

AddRecurrence

RecurringSeries

AddSolutionComponent

AddSolutionComponent

Solution

AddSubstitute

AddSubstituteProduct

None

AddToQueue

AddToQueue

AddToQueue

Assign

Assign

Owned

Associate

Associate

None

AssociateEntities

AssociateEntities

None

AutoMapEntity

AutoMapEntity

None

BackgroundSend

BackgroundSendEmail

None

Book

Book

Schedule

BulkDelete

BulkDelete

None

BulkDetectDuplicates

BulkDetectDuplicates

None

BulkMail

SendBulkMail

None

BulkOperationStatusClose

BulkOperationStatusClose

None

CalculateActualValue

CalculateActualValueOpportunity

None

CalculateTotalTime

CalculateTotalTimeIncident

None

CanBeReferenced

CanBeReferenced

None

CanBeReferencing

CanBeReferencing

None

Cancel

CancelSalesOrder

None

Cancel

CancelContract

None

CanManyToMany

CanManyToMany

None

CheckIncoming

CheckIncomingEmail

None

CheckPromote

CheckPromoteEmail

None

CleanUpBulkOperation

CleanUpBulkOperation

None

Clone

CloneContract

None

Close

CloseQuote

None

Close

CloseIncident

None

CompoundCreate

CompoundCreate

Compound

CompoundUpdate

CompoundUpdate

Compound

CompoundUpdateDuplicateDetectionRule

CompoundUpdateDuplicateDetectionRule

Compound

ConvertKitToProduct

ConvertKitToProduct

None

ConvertProductToKit

ConvertProductToKit

None

ConvertQuoteToSalesOrder

ConvertQuoteToSalesOrder

None

ConvertSalesOrderToInvoice

ConvertSalesOrderToInvoice

None

Copy

CopyCampaign

None

CopyCampaignResponse

CopyCampaignResponse

None

CopyDynamicListToStatic

CopyDynamicListToStatic

None

CopyMembers

CopyMembersList

None

CopySystemForm

CopySystemForm

None

Create

Create

Create

CreateActivities

CreateActivitiesList

None

CreateAttribute

CreateAttribute

None

CreateEntity

CreateEntity

None

CreateException

CreateException

RecurringInstance

CreateInstance

CreateInstance

RecurringSeries

CreateManyToMany

CreateManyToMany

None

CreateOneToMany

CreateOneToMany

None

CreateOptionSet

CreateOptionSet

None

CreateWorkflowFromTemplate

CreateWorkflowFromTemplate

None

Delete

Delete

Delete

DeleteAttribute

DeleteAttribute

None

DeleteAuditData

DeleteAuditData

None

DeleteEntity

DeleteEntity

None

DeleteOpenInstances

DeleteOpenInstances

RecurringSeries

DeleteOptionSet

DeleteOptionSet

None

DeleteOptionValue

DeleteOptionValue

None

DeleteRelationship

DeleteRelationship

None

DeliverIncoming

DeliverIncomingEmail

None

DeliverPromote

DeliverPromoteEmail

None

DeprovisionLanguage

DeprovisionLanguage

None

Disassociate

Disassociate

None

DisassociateEntities

DisassociateEntities

None

DistributeCampaignActivity

DistributeCampaignActivity

None

DownloadReportDefinition

DownloadReportDefinition

None

EntityExpressionToFetchXml

QueryExpressionToFetchXml

None

Execute

ExecuteFetch

None

ExecuteById

ExecuteByIdSavedQuery

None

ExecuteById

ExecuteByIdUserQuery

None

ExecuteWorkflow

ExecuteWorkflow

None

Expand

ExpandCalendar

None

ExportMappings

ExportMappingsImportMap

None

ExportSolution

ExportSolution

None

ExportTranslation

ExportTranslation

None

FetchXmlToEntityExpression

FetchXmlToQueryExpression

None

FindParent

FindParentResourceGroup

None

Fulfill

FulfillSalesOrder

None

GenerateInvoiceFromOpportunity

GenerateInvoiceFromOpportunity

None

GenerateQuoteFromOpportunity

GenerateQuoteFromOpportunity

None

GenerateSalesOrderFromOpportunity

GenerateSalesOrderFromOpportunity

None

GetAllTimeZonesWithDisplayName

GetAllTimeZonesWithDisplayName

None

GetDecryptionKey

GetDecryptionKey

None

GetDistinctValues

GetDistinctValuesImportFile

None

GetHeaderColumns

GetHeaderColumnsImportFile

None

GetInvoiceProductsFromOpportunity

GetInvoiceProductsFromOpportunity

None

GetQuantityDecimal

GetQuantityDecimal

Quantify

GetQuoteProductsFromOpportunity

GetQuoteProductsFromOpportunity

None

GetReportHistoryLimit

GetReportHistoryLimit

None

GetSalesOrderProductsFromOpportunity

GetSalesOrderProductsFromOpportunity

None

GetTimeZoneCodeByLocalizedName

GetTimeZoneCodeByLocalizedName

None

GetTrackingToken

GetTrackingTokenEmail

None

GetValidManyToMany

GetValidManyToMany

None

GetValidReferencedEntities

GetValidReferencedEntities

None

GetValidReferencingEntities

GetValidReferencingEntities

None

GrantAccess

GrantAccess

Owned

ImportMappings

ImportMappingsImportMap

None

ImportRecords

ImportRecordsImport

None

ImportSolution

ImportSolution

None

ImportTranslation

ImportTranslation

None

InitializeFrom

InitializeFrom

None

InsertOptionValue

InsertOptionValue

None

InsertStatusValue

InsertStatusValue

None

InstallSampleData

InstallSampleData

None

Instantiate

InstantiateTemplate

None

InstantiateFilters

InstantiateFilters

None

IsBackOfficeInstalled

IsBackOfficeInstalled

None

IsComponentCustomizable

IsComponentCustomizable

Solution

IsValidStateTransition

IsValidStateTransition

None

LocalTimeFromUtcTime

LocalTimeFromUtcTime

None

LockInvoicePricing

LockInvoicePricing

None

LockSalesOrderPricing

LockSalesOrderPricing

None

LogFailure

LogFailureBulkOperation

None

LogSuccess

LogSuccessBulkOperation

None

Lose

LoseOpportunity

None

MakeAvailableToOrganization

MakeAvailableToOrganizationReport

None

MakeAvailableToOrganization

MakeAvailableToOrganizationTemplate

None

MakeUnavailableToOrganization

MakeUnavailableToOrganizationReport

None

MakeUnavailableToOrganization

MakeUnavailableToOrganizationTemplate

None

Merge

Merge

Merge

ModifyAccess

ModifyAccess

Owned

OrderOption

OrderOption

None

Parse

ParseImport

None

ProcessInbound

ProcessInboundEmail

None

ProcessOneMemberBulkOperation

ProcessOneMemberBulkOperation

None

PropagateByExpression

PropagateByExpression

None

ProvisionLanguage

ProvisionLanguage

None

Publish

PublishXml

None

Publish

PublishDuplicateRule

None

PublishAll

PublishAllXml

None

QualifyLead

QualifyLead

None

QualifyMember

QualifyMemberList

None

Query

QuerySchedule

None

QueryMultiple

QueryMultipleSchedules

None

ReassignObjects

ReassignObjectsSystemUser

None

ReassignObjectsEx

ReassignObjectsOwner

None

Recalculate

Recalculate

Recalculate

RemoveItem

RemoveItemCampaign

None

RemoveItem

RemoveItemCampaignActivity

None

RemoveMember

RemoveMemberList

None

RemoveMembers

RemoveMembersTeam

None

RemoveParent

RemoveParent

RemoveParent

RemovePrivilege

RemovePrivilegeRole

None

RemoveProductFromKit

RemoveProductFromKit

None

RemoveRelated

RemoveRelated

Related

RemoveSolutionComponent

RemoveSolutionComponent

Solution

RemoveSubstitute

RemoveSubstituteProduct

None

Renew

RenewContract

None

ReplacePrivileges

ReplacePrivilegesRole

None

Reschedule

Reschedule

Schedule

ResetUserFilters

ResetUserFilters

None

Retrieve

Retrieve

Retrieve

RetrieveAbsoluteAndSiteCollectionUrl

RetrieveAbsoluteAndSiteCollectionUrl

RetrieveAbsoluteUrl

RetrieveAllChildUsers

RetrieveAllChildUsersSystemUser

None

RetrieveAllEntities

RetrieveAllEntities

None

RetrieveAllManagedProperties

RetrieveAllManagedProperties

None

RetrieveAllOptionSets

RetrieveAllOptionSets

None

RetrieveApplicationRibbon

RetrieveApplicationRibbon

None

RetrieveAttribute

RetrieveAttribute

None

RetrieveAttributeChangeHistory

RetrieveAttributeChangeHistory

None

RetrieveAuditDetails

RetrieveAuditDetails

None

RetrieveAuditPartitionList

RetrieveAuditPartitionList

None

RetrieveAvailableLanguages

RetrieveAvailableLanguages

None

RetrieveBusinessHierarchy

RetrieveBusinessHierarchyBusinessUnit

None

RetrieveByGroup

RetrieveByGroupResource

None

RetrieveByResource

RetrieveByResourceResourceGroup

None

RetrieveByResources

RetrieveByResourcesService

None

RetrieveByTopIncidentProduct

RetrieveByTopIncidentProductKbArticle

None

RetrieveByTopIncidentSubject

RetrieveByTopIncidentSubjectKbArticle

None

RetrieveDependenciesForDelete

RetrieveDependenciesForDelete

None

RetrieveDependenciesForUninstall

RetrieveDependenciesForUninstall

None

RetrieveDependentComponents

RetrieveDependentComponents

None

RetrieveDeploymentLicenseType

RetrieveDeploymentLicenseType

None

RetrieveDeprovisionedLanguages

RetrieveDeprovisionedLanguages

None

RetrieveDuplicates

RetrieveDuplicates

None

RetrieveEntity

RetrieveEntity

None

RetrieveEntityRibbon

RetrieveEntityRibbon

None

RetrieveExchangeRate

RetrieveExchangeRate

None

RetrieveFilteredForms

RetrieveFilteredForms

None

RetrieveFormattedImportJobResults

RetrieveFormattedImportJobResults

None

RetrieveFormXml

RetrieveFormXml

None

RetrieveInstalledLanguagePacks

RetrieveInstalledLanguagePacks

None

RetrieveInstalledLanguagePackVersion

RetrieveInstalledLanguagePackVersion

None

RetrieveLicenseInfo

RetrieveLicenseInfo

None

RetrieveLocLabels

RetrieveLocLabels

None

RetrieveManagedProperty

RetrieveManagedProperty

None

RetrieveMembers

RetrieveMembersTeam

None

RetrieveMembersBulkOperation

RetrieveMembersBulkOperation

None

RetrieveMissingComponents

RetrieveMissingComponents

None

RetrieveMissingDependencies

RetrieveMissingDependencies

None

RetrieveMultiple

RetrieveMultiple

Retrieve

RetrieveOptionSet

RetrieveOptionSet

None

RetrieveOrganizationResources

RetrieveOrganizationResources

None

RetrieveParentGroups

RetrieveParentGroupsResourceGroup

None

RetrieveParsedData

RetrieveParsedDataImportFile

None

RetrievePrincipalAccess

RetrievePrincipalAccess

Owned

RetrievePrincipalAttributePrivileges

RetrievePrincipalAttributePrivileges

None

RetrievePrivilegeSet

RetrievePrivilegeSet

None

RetrieveProvisionedLanguagePackVersion

RetrieveProvisionedLanguagePackVersion

None

RetrieveProvisionedLanguages

RetrieveProvisionedLanguages

None

RetrieveRecordChangeHistory

RetrieveRecordChangeHistory

None

RetrieveRelationship

RetrieveRelationship

None

RetrieveRequiredComponents

RetrieveRequiredComponents

None

RetrieveRolePrivileges

RetrieveRolePrivilegesRole

None

RetrieveSharedPrincipalsAndAccess

RetrieveSharedPrincipalsAndAccess

Owned

RetrieveSubGroups

RetrieveSubGroupsResourceGroup

None

RetrieveSubsidiaryTeams

RetrieveSubsidiaryTeamsBusinessUnit

None

RetrieveSubsidiaryUsers

RetrieveSubsidiaryUsersBusinessUnit

None

RetrieveTeamPrivileges

RetrieveTeamPrivileges

None

RetrieveTeams

RetrieveTeamsSystemUser

None

RetrieveTimestamp

RetrieveTimestamp

None

RetrieveUnpublished

RetrieveUnpublished

RetrieveUnpublished

RetrieveUnpublishedMultiple

RetrieveUnpublishedMultiple

Retrieve

RetrieveUserPrivileges

RetrieveUserPrivileges

None

RetrieveUserSettings

RetrieveUserSettingsSystemUser

None

RetrieveVersion

RetrieveVersion

None

Revise

ReviseQuote

None

RevokeAccess

RevokeAccess

Owned

Rollup

Rollup

Rollup

Search

Search

None

SearchByBody

SearchByBodyKbArticle

None

SearchByKeywords

SearchByKeywordsKbArticle

None

SearchByTitle

SearchByTitleKbArticle

None

Send

SendTemplate

None

Send

SendFax

None

Send

SendEmail

None

SendFromTemplate

SendEmailFromTemplate

SendFromTemplate

SetBusiness

SetBusinessSystemUser

None

SetBusiness

SetBusinessEquipment

None

SetLocLabels

SetLocLabels

None

SetParent

SetParentBusinessUnit

None

SetParent

SetParentSystemUser

None

SetParent

SetParentTeam

None

SetRelated

SetRelated

Related

SetReportRelated

SetReportRelated

None

SetStateDynamicEntity

SetState

None

StatusUpdateBulkOperation

StatusUpdateBulkOperation

None

Transform

TransformImport

None

TriggerServiceEndpointCheck

TriggerServiceEndpointCheck

None

UninstallSampleData

UninstallSampleData

None

UnlockInvoicePricing

UnlockInvoicePricing

None

UnlockSalesOrderPricing

UnlockSalesOrderPricing

None

Unpublish

UnpublishDuplicateRule

None

Update

Update

Update

UpdateAttribute

UpdateAttribute

None

UpdateEntity

UpdateEntity

None

UpdateOptionSet

UpdateOptionSet

None

UpdateOptionValue

UpdateOptionValue

None

UpdateRelationship

UpdateRelationship

None

UpdateStateValue

UpdateStateValue

None

UpdateUserSettings

UpdateUserSettingsSystemUser

None

UtcTimeFromLocalTime

UtcTimeFromLocalTime

None

Validate

ValidateSavedQuery

None

Validate

Validate

None

ValidateRecurrenceRule

ValidateRecurrenceRule

Recurrence

VerifyProcessStateData

VerifyProcessStateData

None

WhoAmI

WhoAmI

None

Win

WinOpportunity

None

Win

WinQuote

None

See Also

Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2014 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft