Organization service messages in Dynamics 365 Customer Engagement

Applies to Dynamics 365 (online), version 9.x

The Microsoft.Crm.Sdk.Messages namespace contains all the messages you need to work with the data stored in any entity. The solution messages are also in this namespace.

Messages are used with the IOrganizationService.Execute method. Most messages available in this namespace apply to all three deployment types. The request page for each message indicates which deployment types support the message. The deployment types are:

  • Dynamics 365 (online) Customer Engagement - On-premises deployment

  • Dynamics 365 (online) – Internet-facing deployment (IFD)

  • Dynamics 365 (online)

    The request page also indicates whether the message works while online (connected to the server) or offline (disconnected from the server).

    Note

    The Dynamics 365 (online), version 9.0 release is not available for on-premises deployments.

Messages

The following table shows the messages available in the Dynamics 365 namespace.

Message request class Description
AddChannelAccessProfilePrivilegesRequest Adds entity privileges to a channel access profile.
AddItemCampaignActivityRequest Adds an item to a campaign activity.
AddItemCampaignRequest Adds an item to a campaign. The item added must be one of the following entity types: campaign, list, product, or salesliterature.
AddListMembersListRequest Adds a list of members to a list.
AddMemberListRequest Adds a member to a list. The member added must be one of the following entity types: account, contact, or lead.
AddMembersTeamRequest Adds members to a team.
AddToQueueRequest Moves an entity record from a source queue to a destination queue.
AddPrivilegesRoleRequest Adds a set of existing privileges to an existing role.
AddProductToKitRequest Adds a product to a kit.
AddRecurrenceRequest Adds recurrence information to an existing appointment to make it a recurring appointment master.
AddSolutionComponentRequest Adds a solution component to an unmanaged solution.
AddSubstituteProductRequest Deprecated. Establishes an association between a product and a substitute product.
AddToQueueRequest Moves a record from a source queue to a destination queue.
AddUserToRecordTeamRequest Adds a user to the auto created access team for the specified record.
ApplyRecordCreationAndUpdateRuleRequest Contains data to apply record creating and update rule to incoming activities in Dynamics 365.
ApplyRoutingRuleRequest Applies the active routing rule to the incident (case).
AssignRequest Assigns the specified record to a new security principal (user). This changes the ownerid attribute of the instance.
AssociateEntitiesRequest Deprecated. Adds a link between two records in a many-to-many relationship.
AutoMapEntityRequest Creates the attribute mappings between two entities.
BackgroundSendEmailRequest Sends an email asynchronously.
BookRequest Schedules or "books" an appointment.
BulkDeleteRequest Submits an asynchronous bulk delete job.
BulkDetectDuplicatesRequest Submits an asynchronous duplicates detection job.
CalculateActualValueOpportunityRequest Calculates the value of an opportunity that is in the "Won" state.
CalculateTotalTimeIncidentRequest Calculates the total number of minutes spent on an incident (case).
CalculatePriceRequest Defines custom pricing for your products in opportunities, quotes, orders, and invoices.
CalculateRollupFieldRequest Calculates a rollup attribute value on demand.
CancelContractRequest Cancels a contract.
CancelSalesOrderRequest Cancels a sales order.
CheckIncomingEmailRequest Checks whether the incoming email message is relevant to the Dynamics 365 system.
CheckPromoteEmailRequest Checks whether the incoming email message should be promoted to the Dynamics 365 system.
CloneAsPatchRequest Creates a solution patch from a managed or unmanaged solution.
CloneAsSolutionRequest Creates a new copy of an unmanaged solution that contains the original solution plus all of its patches.
CloneContractRequest Copies an existing contract and its line items.
CloneProductRequest Clones a product family, product, or bundle record, and creates a copy of the record under the same parent node.
CloseIncidentRequest Closes an incident (case).
CloseQuoteRequest Closes a quote.
CompoundCreateRequest Deprecated. Creates a compound entity (salesorder, invoice, quote, or duplicaterule) and its related entity (salesorderdetail, invoicedetail, quotedetail, or duplicaterulecondition).
CompoundUpdateDuplicateDetectionRuleRequest Updates a duplicate detection rule and its conditions.
CompoundUpdateRequest Deprecated. Updates a compound record (salesorder, invoice, quote or duplicaterule) and its related detail record (salesorderdetail, invoicedetail, quotedetail or duplicaterulecondition).
ConvertKitToProductRequest Converts a kit to a product.
ConvertOwnerTeamToAccessTeamRequest Converts a team of type owner to a team of type access.
ConvertProductToKitRequest Converts a product to a kit.
ConvertQuoteToSalesOrderRequest Converts a quote to a sales order.
ConvertSalesOrderToInvoiceRequest Converts a sales order to an invoice.
CopyCampaignRequest Copies a campaign.
CopyCampaignResponseRequest Copies the information from one campaign response to another, and optionally creates a campaign response template.
CopyDynamicListToStaticRequest Creates a static list from the specified dynamic list and adds the members that satisfy the dynamic list query criteria to the static list.
CopyMembersListRequest Copies the members from the source list to the target list without creating duplicates.
CopySystemFormRequest Creates a new entity form that is based on an existing entity form.
CreateActivitiesListRequest Creates the activities for a list.
CreateExceptionRequest Creates an exception for the recurring appointment instance.
CreateInstanceRequest Creates future unexpanded instances of a recurring appointment master.
CreateKnowledgeArticleTranslationRequest Creates a translation of a knowledge article record.
CreateKnowledgeArticleVersionRequest Creates a major or minor version of a knowledge article record.
CreateWorkflowFromTemplateRequest Creates a workflow from a workflow template.
DeleteAndPromoteRequest Replaces a managed solution plus all of its patches.
DeleteAuditDataRequest Deletes all partitions containing audit data created before a given end date.
DeleteOpenInstancesRequest Deletes instances of a recurring appointment master that have an Open state.
DeliverIncomingEmailRequest Creates an email activity instance from an incoming email message.
DeliverPromoteEmailRequest Creates an email activity instance from the specified email message.
DeprovisionLanguageRequest Deprovisions a language.
DisassociateEntitiesRequest Deprecated. Removes a link between two records in a many to many relationship.
DistributeCampaignActivityRequest Creates a bulk operation to distribute the activity, creating the appropriate activity for each member in the list for the specified campaign activity.
DownloadReportDefinitionRequest Downloads a report definition.
ExecuteByIdSavedQueryRequest Executes a saved query (view) that has the specified ID.
ExecuteByIdUserQueryRequest Executes the user query (saved view) that has the specified ID.
ExecuteFetchRequest Deprecated. Executes the specified Fetch XML query.
ExecuteWorkflowRequest Executes a workflow.
ExpandCalendarRequest Converts the calendar rules to an array of available time blocks for the specified period.
ExportMappingsImportMapRequest Exports an import data map to an XML file.
ExportFieldTranslationRequest Exports localizable attributes for translation.
ExportSolutionRequest Exports a managed or unmanaged solution.
ExportTranslationRequest Exports all translations for a specific solution to a compressed file.
FetchXmlToQueryExpressionRequest Converts a query in Fetch XML to a QueryExpression.
FindParentResourceGroupRequest Finds a parent resource group (scheduling group) for the specified resource groups (scheduling groups).
FulfillSalesOrderRequest Fulfills a sales order (order).
FullTextSearchKnowledgeArticleRequest Performs a full-text search on knowledge articles in Dynamics 365 using the specified search text.
GenerateInvoiceFromOpportunityRequest Generates an invoice from an opportunity.
GenerateQuoteFromOpportunityRequest Generates a quote from an opportunity.
GenerateSalesOrderFromOpportunityRequest Generates a sales order from an opportunity.
GenerateSocialProfileRequest Returns an existing social profile record if one exists, otherwise generates a new one and returns it.
GetAllTimeZonesWithDisplayNameRequest Retrieves all the time-zone definitions for the specified locale returning only the display name attribute.
GetDecryptionKeyRequest Gets a decryption key.
GetDefaultPriceLevelRequest Contains the data that is needed to retrieve the default price level (price list) for the current user based on the user’s territory relationship with the price list.
GetDistinctValuesImportFileRequest Returns distinct values for a column in the source file that contains list values.
GetHeaderColumnsImportFileRequest Retrieves the source-file column headings, or system-generated column headings, if the source file does not contain column headings.
GetInvoiceProductsFromOpportunityRequest Retrieves the products from an opportunity and copies them to the specified invoice.
GetQuantityDecimalRequest Gets the quantity decimal value for a product.
GetQuoteProductsFromOpportunityRequest Retrieves the products from an opportunity and copies them to the quote.
GetReportHistoryLimitRequest Gets the history limit for a report.
GetSalesOrderProductsFromOpportunityRequest Retrieves the products from an opportunity and copies them to the sales order.
GetTimeZoneCodeByLocalizedNameRequest Retrieves the time-zone code for the specified localized time-zone name.
GetTrackingTokenEmailRequest Returns a tracking token that can be then passed in as a parameter to the SendEmailRequest message.
GrantAccessRequest Grants a security principal (user or team) access to the specified record.
ImportFieldTranslationRequest Imports localizable attributes for translation.
ImportMappingsImportMapRequest Imports XML mappings and creates an import data map.
ImportRecordsImportRequest Submits an asynchronous job that uploads the transformed data into Dynamics 365.
ImportSolutionRequest Imports a managed or unmanaged solution.
ImportTranslationRequest Imports all translations from a compressed file.
IncrementKnowledgeArticleViewCountRequest Increments the per day view count of a knowledge article record.
InitializeFromRequest Initializes a new record from an existing record.
InstallSampleDataRequest Installs sample data for an organization.
InstantiateFiltersRequest Instantiates a filter.
InstantiateTemplateRequest Creates an email message from a template.
IsBackOfficeInstalledRequest Deprecated. Checks if Microsoft Great Plains is installed.
IsComponentCustomizableRequest Determines whether a solution component is customizable.
IsValidStateTransitionRequest Checks to see if the state transition is valid.
LocalTimeFromUtcTimeRequest Retrieves the local time for the specified Universal Time Coordinate (UTC) time.
LockInvoicePricingRequest Locks the total price of products and services specified in the invoice. When the invoice pricing is locked, changes to underlying price lists (price levels) do not affect the prices for an invoice.
LockSalesOrderPricingRequest Locks the total price of products and services specified in the sales order (order). When the sales order pricing is locked, changes to underlying price lists (price levels) do not affect the prices for a sales order (order).
LoseOpportunityRequest Sets the state of an opportunity to Lost.
MakeAvailableToOrganizationReportRequest Deprecated. Makes the report available to all users in the organization.
MakeAvailableToOrganizationTemplateRequest Deprecated. Makes the specified email template available to the entire organization.
MakeUnavailableToOrganizationReportRequest Deprecated. Makes the report unavailable to all users in the organization.
MakeUnavailableToOrganizationTemplateRequest Deprecated. Makes the specified email template no longer available to the entire organization.
MergeRequest Merges the information from two records of the same type.
ModifyAccessRequest Replaces the access rights on the target record for the specified security principal (user or team).
ParseImportRequest Submits an asynchronous job that parses all import files associated with the specified data import (import).
PickFromQueueRequest Assigns a queue item to a user and optionally remove the queue item from the queue.
ProcessInboundEmailRequest Processes marketing campaign email responses.
PropagateByExpressionRequest Distributes an activity to a quick campaign.
ProvisionLanguageRequest Provisions a language.
PublishAllXmlRequest Publishes all customizations.
PublishDuplicateRuleRequest Submits an asynchronous job to publish a duplicate rule.
PublishProductHierarchyRequest Publishes a product family hierarchy including the child products and bundles.
PublishThemeRequest Publishes a theme.
PublishXmlRequest Publishes the customizations for the specified entities.
QualifyLeadRequest Qualifies a lead and creates an account, contact, or opportunity records that are linked to the originating lead.
QualifyMemberListRequest Qualifies the specified member list and either overrides the list members or removes them according to the specified option.
QueryExpressionToFetchXmlRequest Converts a query represented as a QueryExpression class to the equivalent query represented as FetchXML.
QueryMultipleSchedulesRequest Searches multiple resources for an available time slot matching the specified parameters. This is similar to the QuerySchedule message but it works for multiple resources at one time.
QueryScheduleRequest Searches the specified resource for an available time slot matching the specified parameters.
ReassignObjectsOwnerRequest Reassigns all records that are owned by the security principal (user or team) to another security principal (user or team).
ReassignObjectsSystemUserRequest Reassigns all records that are owned by the user to another security principal (user or team).
RecalculateRequest Recalculates the rollup attribute values for all goals in the goal hierarchy that contain a specified goal.
ReleaseToQueueRequest Assigns a queue item back to the queue owner so others can pick it.
RemoveFromQueueRequest Removes a queue item from a queue.
RemoveItemCampaignActivityRequest Removes an item from a campaign activity.
RemoveItemCampaignRequest Removes an item from a campaign.
RemoveMemberListRequest Removes a member from a list.
RemoveMembersTeamRequest Removes members from a team.
RemoveParentRequest Removes the parent for a record.
RemovePrivilegeRoleRequest Removes a privilege from an existing role.
RemoveProductFromKitRequest Removes a product from a kit.
RemoveRelatedRequest Deprecated. Removes the relationship between two records as defined by the target classes listed below. For example, remove the relationship between an invoice and a contact.
RemoveSolutionComponentRequest Removes a solution component to an unmanaged solution.
RemoveSubstituteProductRequest Deprecated. Removes the association between a product and a substitute product.
RemoveUserFromRecordTeamRequest Removes a user from the auto created access team for the specified record.
RenewContractRequest Renews a contract.
RenewEntitlementRequest Renews an entitlement.
ReplacePrivilegesRoleRequest Replaces the privilege set of an existing role. This effectively deletes all existing privileges from the role and adds the new specified privileges.
RescheduleRequest Reschedules an appointment, service appointment or recurring appointment.
ResetUserFiltersRequest Resets the offline data filters for the calling user to the default filters for the organization.
RetrieveAbsoluteAndSiteCollectionUrlRequest Retrieves the absolute (complete) URL and the site collection URL of a SharePoint document location or SharePoint site.
RetrieveAllChildUsersSystemUserRequest Retrieves a collection of system users who report to the specified system user.
RetrieveApplicationRibbonRequest Retrieves the core application ribbons including the entity template.
RetrieveAttributeChangeHistoryRequest Retrieves all changes to a specific attribute.
RetrieveAuditDetailsRequest Retrieves the full audit details of a particular audit record.
RetrieveAuditPartitionListRequest Retrieves the list of auditing partitions.
RetrieveAvailableLanguagesRequest Retrieves the list of available languages.
RetrieveBusinessHierarchyBusinessUnitRequest Retrieves all the business units in the business unit hierarchy.
RetrieveByGroupResourceRequest Retrieves all the resource groups to which the specified resource belongs.
RetrieveByResourceResourceGroupRequest Retrieves the resource groups that contain the specified resource.
RetrieveByResourcesServiceRequest Retrieves a collection of services related to the specified set of services.
RetrieveByTopIncidentProductKbArticleRequest Retrieves the top ten knowledge base articles for the product specified.
RetrieveByTopIncidentSubjectKbArticleRequest Retrieves the top ten knowledge base articles for the subject specified.
RetrieveChannelAccessProfilePrivilegesRequest Retrieves the channel access profile with entity privileges.
RetrieveCurrentOrganizationRequest Retrieves organization information from the organization service rather than the discovery service.
RetrieveDependenciesForDeleteRequest Retrieves the dependencies for solution components that will prevent a solution component from being deleted.
RetrieveDependenciesForUninstallRequest Retrieves the dependencies for solution components that could prevent uninstalling a managed solution.
RetrieveDependentComponentsRequest Retrieves all components that depend on the specified component.
RetrieveDeploymentLicenseTypeRequest Retrieves the type of license for a deployment of Dynamics 365.
RetrieveDeprovisionedLanguagesRequest Retrieves the list of language packs installed on the server that have been disabled.
RetrieveDuplicatesRequest Detects and retrieves duplicate records for the specified record, provided duplicate detection is enabled and there are published duplicate detection rules for the entity.
RetrieveEntityRibbonRequest Retrieves the ribbon definition used for a specific entity.
RetrieveExchangeRateRequest Retrieves the exchange rate.
RetrieveFilteredFormsRequest Retrieves the system forms for the specified user.
RetrieveFormattedImportJobResultsRequest Retrieves the formatted results from an import job.
RetrieveFormXmlRequest For internal use only.
RetrieveInstalledLanguagePacksRequest Retrieves the list of language packs installed on the server.
RetrieveInstalledLanguagePackVersionRequest Retrieves the version of an installed language pack.
RetrieveLicenseInfoRequest Retrieves the number of licenses for a deployment of Dynamics 365.
RetrieveLocLabelsRequest Retrieves the localized labels for the specified attribute.
RetrieveMailboxTrackingFoldersRequest Retrieves folder mapping rules for a user.
RetrieveMembersBulkOperationRequest Retrieves the members of a bulk operation.
RetrieveMembersTeamRequest Deprecated. Retrieves the members of a team.
RetrieveMissingComponentsRequest Retrieves a list of missing components for the target organization.
RetrieveMissingDependenciesRequest Verifies whether any solution components are not included in the solution but possibly should be for a complete solution to be exported.
RetrieveOrganizationResourcesRequest Retrieves the resources used by an organization.
RetrieveParentGroupsResourceGroupRequest Retrieves a collection of the parent resource groups of the specified resource group (scheduling group).
RetrieveParsedDataImportFileRequest Retrieves the data from the parse table.
RetrievePersonalWallRequest Retrieves pages of posts, with comments for each post, for all records that the calling user follows.
RetrievePrincipalAccessRequest Retrieves the access rights the specified security principal (user or team) has to a record.
RetrievePrincipalAttributePrivilegesRequest Retrieves all the secured attribute privileges a user or team has through direct or indirect (through team membership) associations with the FieldSecurityProfile entity.
RetrievePrincipalSyncAttributeMappingsRequest Retrieves the synchronization attribute mapping information that defines the flow of data from the server to client application.
RetrievePrivilegeSetRequest Retrieves the set of privileges defined in the system.
RetrieveProductPropertiesRequest Retrieves all the property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice.
RetrieveProvisionedLanguagePackVersionRequest Retrieves the version of the language packs installed on the server.
RetrieveProvisionedLanguagesRequest Retrieves the list of language packs installed on the server that are enabled.
RetrieveRecordChangeHistoryRequest Retrieves all changes to a specific entity.
RetrieveRecordWallRequest Retrieves pages of posts, with comments for each post, for a specific record.
RetrieveRequiredComponentsRequest Retrieves all components that this component requires.
RetrieveRolePrivilegesRoleRequest Retrieves the privileges that are assigned to the specified role.
RetrieveSharedPrincipalsAndAccessRequest Retrieves all the security principals (users or teams) that have access to a record, together with their access rights to the record.
RetrieveSubGroupsResourceGroupRequest Retrieves a collection of the child resource groups of the specified resource group (scheduling group).
RetrieveSubsidiaryTeamsBusinessUnitRequest Deprecated. Retrieves all the team information for child business units of the specified business unit.
RetrieveSubsidiaryUsersBusinessUnitRequest Deprecated. Retrieves all system users for the child business units of the specified business unit.
RetrieveTeamPrivilegesRequest Retrieves the privileges for a team.
RetrieveTeamsSystemUserRequest Deprecated. Retrieves a collection of teams of which the specified system user is a member.
RetrieveUnpublishedMultipleRequest Retrieves the current saved definitions of Web resources, organization-owned charts, or organization-owned dashboards, whether they have been published or not.
RetrieveUnpublishedRequest Retrieves the current saved definition of a Web resource, organization-owned chart, or organization-owned dashboard, whether is has been published or not.
RetrieveUserPrivilegesRequest Retrieves all the privileges a system user (user) has through his or her roles in the specified business unit.
RetrieveUserSettingsSystemUserRequest Deprecated. Retrieves the system user settings for the specified system user.
RetrieveVersionRequest Retrieves the version number of the Dynamics 365 server.
RevertProductRequest Reverts a product family, product, or bundle record to its last Active state. All the product property (attribute) changes done to the record since it was last published (Active state) will be lost.
ReviseQuoteRequest Sets the state of a quote to Draft.
RevokeAccessRequest Removes all access to a record for the specified security principal (user or team).
RollupRequest Retrieves all the records related to the specified record (account or contact). This applies to all activity entities, annotation (note), contract, incident (case), invoice, opportunity, quote and sales order (order) entities.
RouteToRequest Routes a queue item to a different user or queue.
SearchByBodyKbArticleRequest Finds all the document indexes that contain the specified text in the body.
SearchByKeywordsKbArticleRequest Finds all the document indexes that contain the specified keywords.
SearchByTitleKbArticleRequest Finds all the document indexes that contain the specified text in the title.
SearchRequest Searches for available time slots that fulfill the specified appointment request.
SendBulkMailRequest Sends bulk email messages.
SendEmailFromTemplateRequest Sends an email message using a template.
SendEmailRequest Sends an email message.
SendFaxRequest Sends a fax.
SendTemplateRequest Sends a bulk email message that is created from a template.
SetBusinessEquipmentRequest Sets the business that owns the equipment.
SetBusinessSystemUserRequest Sets the business unit for the specified system user.
SetLocLabelsRequest Sets the localized labels for the specified attribute.
SetParentBusinessUnitRequest Sets the parent (manager) for the specified business unit.
SetParentSystemUserRequest Sets the parent (manager) for the specified system user.
SetParentTeamRequest Sets the parent (manager) for the specified team.
SetProcessRequest Sets the process that associates with a given target entity.
SetRelatedRequest Deprecated. Creates a link between an opportunity and an account, contact, or competitor.
SetReportRelatedRequest Specifies in which areas of Dynamics 365 the report can be run and viewed.
SetStateRequest Sets the state of a record.
TransformImportRequest Submits an asynchronous job to transform the parsed data.
TriggerServiceEndpointCheckRequest Validates the configuration of a Azure solution’s service endpoint.
UninstallSampleDataRequest Uninstalls sample data for an organization.
UnlockInvoicePricingRequest Unlocks the price per unit for the products in the specified invoice.
UnlockSalesOrderPricingRequest Unlocks the price per unit for the products in the specified sales order (order).
UnpublishDuplicateRuleRequest Unpublishes a duplicate rule.
UpdateProductPropertiesRequest Updates all the retrieved property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice.
UpdateSolutionComponentRequest Updates a component in an unmanaged solution.
UpdateUserSettingsSystemUserRequest Deprecated. Updates the user settings for a system user.
UtcTimeFromLocalTimeRequest Retrieves the UTC time for the specified local time.
ValidateRecurrenceRuleRequest Validates a recurrence rule for a recurring appointment.
ValidateRequest Validates that all the constraints of an appointment or service appointment are met.
ValidateSavedQueryRequest Validates a saved query.
WhoAmIRequest Retrieves the user information for the logged on user.
WinOpportunityRequest Changes the state of an opportunity to Won.
WinQuoteRequest Changes the state of a quote to Won.

See also

Web Services: IOrganizationService
IOrganizationService entities
IOrganizationService
Microsoft.Crm.Sdk.Messages