Microsoft.Crm.Sdk.Messages Namespace

Classes

AddAppComponentsRequest

Contains the data that is needed to add app components to a business app.

For the Web API use the AddAppComponents Action.

AddAppComponentsResponse

Contains the response from the AddAppComponentsRequest class.

AddChannelAccessProfilePrivilegesRequest

For internal use only.

AddChannelAccessProfilePrivilegesResponse

For internal use only.

AddItemCampaignActivityRequest

Contains the data that is needed to add an item to a campaign activity.

For the Web API use the AddItemCampaignActivity Action.

AddItemCampaignActivityResponse

Contains the response from the AddItemCampaignActivityRequest class.

For the Web API the AddItemCampaignActivityResponse ComplexType is the response value from the AddItemCampaignActivity Action.

AddItemCampaignRequest

Contains the data that is needed to add an item to a campaign.

For the Web API use AddItemCampaign Action.

AddItemCampaignResponse

Contains the response from the AddItemCampaignRequest class.

AddListMembersListRequest

Contains the data that is needed to add members to the list.

For the Web API use the AddListMembersList Action.

AddListMembersListResponse

Contains the response from the AddListMembersListRequest class.

AddMemberListRequest

Contains the data that is needed to add a member to a list (marketing list).

For the Web API use the AddMemberList Action.

AddMemberListResponse

Contains the response from the AddMemberListRequest class.

For the Web API the AddMemberListResponse ComplexType is the response value from the AddMemberList Action.

AddMembersTeamRequest

Contains the data that is needed to add members to a team.

For the Web API use the AddMembersTeam Action.

AddMembersTeamResponse

Contains the response from the AddMembersTeamRequest class.

AddPrincipalToQueueRequest

Contains the data to add the specified principal to the list of queue members. If the principal is a team, add each team member to the queue.

For the Web API use the AddPrincipalToQueue Action.

AddPrincipalToQueueResponse

Contains the response from the AddPrincipalToQueueRequest message.

AddPrivilegesRoleRequest

Contains the data that is needed to add a set of existing privileges to an existing role.

For the Web API use the AddPrivilegesRole Action.

AddPrivilegesRoleResponse

Contains the response from the AddPrivilegesRoleRequest class.

AddProductToKitRequest

Deprecated. Use the ProductAssociation entity. Contains the data that is needed to add a product to a kit.

AddProductToKitResponse

Deprecated. Use the ProductAssociation entity. Contains the response from the AddProductToKitRequest class.

AddRecurrenceRequest

Contains the data that is needed to add recurrence information to an existing appointment.

For the Web API use the AddRecurrence Action.

AddRecurrenceResponse

Contains the response from the AddRecurrenceRequest class.

AddSolutionComponentRequest

Contains the data that is needed to add a solution component to an unmanaged solution.

For the Web API use the AddSolutionComponent Action.

AddSolutionComponentResponse

Contains the response from the AddSolutionComponentRequest message.

For the Web API the AddSolutionComponentResponse ComplexType is the response value from the AddSolutionComponent Action.

AddSubstituteProductRequest

Deprecated. Use the AssociateRequest class.

Adds a link between two entity instances in a many-to-many relationship.

AddSubstituteProductResponse

Deprecated. Use the AssociateRequest class and its associated response class.

Contains the response from the AddSubstituteProductRequest class.

AddToQueueRequest

Contains the data that is needed to move an entity record from a source queue to a destination queue.

For the Web API use the AddToQueue Action.

AddToQueueResponse

Contains the response from the AddToQueueRequest class.

For the Web API the AddToQueueResponse ComplexType is the response value from the AddToQueue Action.

AddUserToRecordTeamRequest

Contains the data that is needed to add a user to the auto created access team for the specified record.

For the Web API use the AddUserToRecordTeam Action.

AddUserToRecordTeamResponse

Contains the response from the AddUserToRecordTeamRequest class.

For the Web API the AddUserToRecordTeamResponse ComplexType is the response value from the AddUserToRecordTeam Action.

AppComponentInfo
AppComponents
AppContext

AppElementInfo
AppElementsCollection
AppEntityInfo

AppInfo

AppInformation

For internal use only.

ApplyRecordCreationAndUpdateRuleRequest

Contains data to apply record creation and update rules to activities in CRM created as a result of the integration with external applications.

For the Web API use the ApplyRecordCreationAndUpdateRule Action.

ApplyRecordCreationAndUpdateRuleResponse

Contains the response from the ApplyRecordCreationAndUpdateRuleRequest class.

ApplyRoutingRuleRequest

Contains the data that is needed to apply the active routing rule to an incident.

For the Web API use the ApplyRoutingRule Action.

ApplyRoutingRuleResponse

Contains the response from the ApplyRoutingRuleRequest message.

AppModuleCollection

AppModuleDescriptor
AppModuleDetails
AppModuleDetailsCollection
AppModuleEventHandlerInfo
AppModuleInfo

AppModuleSaveResponse
AppModuleValidationResponse

AppointmentProposal

Represents a proposed appointment time and date as a result of the SearchRequest message.

For the Web API the corresponding type is AppointmentProposal ComplexType.

AppointmentRequest

Provides the details of an appointment request for the AppointmentRequest class.

For the Web API the corresponding type is AppointmentRequest ComplexType.

AppointmentsToIgnore

Specifies the appointments to ignore in an appointment request from the SearchRequest class.

For the Web API the corresponding type is AppointmentsToIgnore ComplexType.

AppOverridableSettingInfo

Internal use only.

AppSettingDetails
AppValidationResponse

Contains the response from App validation.

ArtifactIdType

AssignRequest

Contains the data that is needed to assign the specified record to a new owner (user or team) by changing the OwnerId attribute of the record.

AssignResponse

Contains the response from the AssignRequest.

AssociateEntitiesRequest

Deprecated. Use the AssociateRequest class.

Contains the data that is needed to add a link between two entity instances in a many-to-many relationship.

AssociateEntitiesResponse

Deprecated. Use the AssociateRequest class and its associated response class.

Contains the response from the AssociateEntitiesRequest class.

AttributeAuditDetail

Contains the details of changes to entity attributes.

AuditDetail

Provides a base class for storing the details of data changes.

AuditDetailCollection

Contains a collection of AuditDetail objects.

AuditPartitionDetail

Identifies a Microsoft SQL Server partition that is used to store changes to entity data records.

For the Web API the corresponding type is AuditPartitionDetail ComplexType.

AuditPartitionDetailCollection

Contains a data collection of AuditDetail objects.

AutoMapEntityRequest

Contains the data that is needed to generate a new set of attribute mappings based on the metadata.

For the Web API use the AutoMapEntity Action.

AutoMapEntityResponse

Contains the response from the AutoMapEntityRequest class.

BackgroundSendEmailRequest

Contains the data that is needed to send email messages asynchronously.

BackgroundSendEmailResponse

Contains the response from the BackgroundSendEmailRequest class.

BookRequest

Contains the data that is needed to schedule or “book” an appointment, recurring appointment, or service appointment (service activity).

For the Web API use the Book Action.

Web API support for this message was added with Microsoft Dynamics CRM Online 2016 Update 1 and Microsoft Dynamics CRM 2016 Service Pack 1

BookResponse

Contains the response from the BookRequest class.

BulkDeleteRequest

Contains the data that’s needed to submit a bulk delete job that deletes selected records in bulk. This job runs asynchronously in the background without blocking other activities.

For the Web API use the BulkDelete Action.

BulkDeleteResponse

Contains the response from the BulkDeleteRequest class.

BulkDetectDuplicatesRequest

Contains the data that is needed to submit an asynchronous system job that detects and logs multiple duplicate records.

For the Web API use the BulkDetectDuplicates Action.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises)

BulkDetectDuplicatesResponse

Contains the response from the BulkDetectDuplicatesRequest class.

BusinessNotification

For internal use only.

BusinessNotificationParameter

For internal use only.

BusinessProcessFlowContext

CalculateActualValueOpportunityRequest

Contains the data that is needed to calculate the value of an opportunity that is in the "Won" state.

For the Web API use the CalculateActualValueOpportunity Action.

CalculateActualValueOpportunityResponse

Contains the response from the CalculateActualValueOpportunityRequest class.

For the Web API the CalculateActualValueOpportunityResponse ComplexType is the response value from the CalculateActualValueOpportunity Action.

CalculatePriceRequest

Contains the data that is needed to calculate price in an opportunity, quote, order, and invoice. This is used internally for custom pricing calculation when the default system pricing is overridden.

For the Web API use the CalculatePrice Action.

CalculatePriceResponse

Contains the response from the CalculatePriceRequest class.

CalculateRollupFieldRequest

Contains the data that is needed to calculate the value of a rollup attribute.

For the Web API use the CalculateRollupField Function.

Web API support for this message was added with Microsoft Dynamics CRM Online 2016 Update 1 and Microsoft Dynamics CRM 2016 Service Pack 1.

CalculateRollupFieldResponse

Contains the response from the CalculateRollupFieldRequest class.

CalculateTotalTimeIncidentRequest

Contains the data that is needed to calculate the total time, in minutes, that you used while you worked on an incident (case).

For the Web API use the CalculateTotalTimeIncident Function.

CalculateTotalTimeIncidentResponse

Contains the response from the CalculateTotalTimeIncidentRequest class.

For the Web API the CalculateTotalTimeIncidentResponse ComplexType is the response value from the CalculateTotalTimeIncident Function.

CancelContractRequest

Contains the data that is needed to cancel a contract.

For the Web API use the CancelContract Action.

CancelContractResponse

Contains the response from the CancelContractRequest class.

CancelSalesOrderRequest

Contains the data that is needed to cancel a sales order (order).

For the Web API use the CancelSalesOrder Action.

CancelSalesOrderResponse

Contains the response from the CancelSalesOrderRequest class.

CanvasAppsDetails
CanvasAppsInfo
ChannelAccessProfilePrivilege

For internal use only.

ChannelAccessProfileWithPrivileges

For internal use only.

CheckIncomingEmailRequest

Contains the data that is needed to check whether the incoming email message is relevant to the Microsoft Dynamics 365 system.

For the Web API use the CheckIncomingEmail Function.

CheckIncomingEmailResponse

Contains the response from the CheckIncomingEmailRequest class.

CheckPromoteEmailRequest

Contains the data that is needed to check whether the incoming email message should be promoted to the Microsoft Dynamics 365 system.

For the Web API use the CheckPromoteEmail Function.

CheckPromoteEmailResponse

Contains the response from the CheckPromoteEmailRequest class.

For the Web API the CheckPromoteEmailResponse ComplexType is the response value from the CheckPromoteEmail Function.

CloneAsPatchRequest

Contains the data that is needed to create a solution patch from a managed or unmanaged solution.

For the Web API use the CloneAsPatch Action

CloneAsPatchResponse

Contains the response from executing the CloneAsPatchRequest class.

For the Web API the CloneAsPatchResponse ComplexType is the response value from the CloneAsPatch Action.

CloneAsSolutionRequest

Contains the data that is needed to create a new copy of an unmanaged solution that contains the original solution plus all of its patches.

For the Web API use the CloneAsSolution Action

CloneAsSolutionResponse

Contains the response from executing the CloneAsSolutionRequest class.

For the Web API the CloneAsSolutionResponse ComplexType is the response value from the CloneAsSolution Action.

CloneContractRequest

Contains the data that is needed to copy an existing contract and its line items.

For the Web API use the CloneContract Action.

CloneContractResponse

Contains the response from the CancelContractRequest class.

CloneMobileOfflineProfileRequest

For the Web API use the CloneMobileOfflineProfile Action.

For internal use only.

CloneMobileOfflineProfileResponse

For internal use only.

CloneProductRequest

Contains the data that is needed to copy an existing product family, product, or bundle under the same parent record.

For the Web API use the CloneProduct Action.

CloneProductResponse

Contains the response from the CloneProductRequest class.

CloseIncidentRequest

Contains the data that is needed to close an incident (case).

For the Web API use the CloseIncident Action.

CloseIncidentResponse

Contains the response from the CloseIncidentRequest class.

CloseQuoteRequest

Contains the data that is needed to close a quote.

For the Web API use the CloseQuote Action.

CloseQuoteResponse

Contains the response from the CloseQuoteRequest class.

CommitAnnotationBlocksUploadRequest

Contains the data needed to commit the uploaded data blocks to the annotation store.

CommitAnnotationBlocksUploadResponse

Contains the response from the CommitAnnotationBlocksUploadRequest class.

CommitAttachmentBlocksUploadRequest

Contains the data needed to commit the uploaded data blocks to the attachment store.

CommitAttachmentBlocksUploadResponse

Contains the response from the CommitAttachmentBlocksUploadRequest class.

CommitFileBlocksUploadRequest

Contains the data needed to commit the uploaded data blocks to the file store.

CommitFileBlocksUploadResponse

Contains the response from the CommitFileBlocksUploadRequest class.

Component

ComponentDetail

Provides additional information about the solution components that are related to a missing component.

For the Web API the corresponding type is ComponentDetail ComplexType.

CompoundCreateRequest

Deprecated. Use the CreateRequest class. Creates a compound entity, such as a sales order (order), invoice, quote, or duplicate rule (duplicate detection rule); and its related entity, such as a sales order detail (order product), invoice detail (invoice product), quote detail (quote product), or duplicate rule condition.

CompoundCreateResponse

Deprecated. Use the CreateRequest class and its associated response class.

CompoundUpdateDuplicateDetectionRuleRequest

Contains the data that is needed to update a duplicate rule (duplicate detection rule) and its related duplicate rule conditions.

For the Web API use the CompoundUpdateDuplicateDetectionRule Action.

CompoundUpdateDuplicateDetectionRuleResponse

Contains the response from the CompoundUpdateDuplicateDetectionRuleRequest class.

CompoundUpdateRequest

Deprecated. Use the UpdateRequest class. Contains the data that is needed to update a compound record, such as a sales order (order), invoice, quote, or duplicate rule (duplicate detection rule); and its related detail record, such as a sales order detail (order product), invoice detail (invoice product), quote detail (quote product), or duplicate rule condition.

CompoundUpdateResponse

Deprecated. Use the CreateRequest class and its associated response class.

Contains the response from the CompoundUpdateRequest class.

ConstraintRelation

Specifies additional constraints to be applied when you select resources for appointments.

For the Web API the corresponding type is ConstraintRelation ComplexType.

ConvertKitToProductRequest

Deprecated. Contains the data that is needed to convert a kit to a product.

ConvertKitToProductResponse

Deprecated. Contains the response from the ConvertKitToProductRequest class.

ConvertOwnerTeamToAccessTeamRequest

Contains the data that is needed to convert a team of type owner to a team of type access.

For the Web API use the ConvertOwnerTeamToAccessTeam Action.

ConvertOwnerTeamToAccessTeamResponse

Contains the response from the ConvertOwnerTeamToAccessTeamRequest class.

ConvertProductToKitRequest

Deprecated. Contains the data that is needed to convert a product to a kit.

For the Web API use the ConvertProductToKit Action.

ConvertProductToKitResponse

Deprecated. Contains the response from the ConvertProductToKitRequest class.

ConvertQuoteToSalesOrderRequest

Contains the data that is needed to convert a quote to a sales order.

For the Web API use the ConvertQuoteToSalesOrder Action.

ConvertQuoteToSalesOrderResponse

Contains the response from the ConvertQuoteToSalesOrderRequest class.

ConvertSalesOrderToInvoiceRequest

Contains the data that is needed to convert a sales order to an invoice.

For the Web API use the ConvertSalesOrderToInvoice Action.

ConvertSalesOrderToInvoiceResponse

Contains the response from the ConvertSalesOrderToInvoiceRequest class.

CopyCampaignRequest

Contains the data that is needed to copy a campaign.

For the Web API use the CopyCampaign Action.

CopyCampaignResponse

Contains the response from the CopyCampaignRequest class.

CopyCampaignResponseRequest

Contains the data that is needed to create a copy of the campaign response.

For the Web API use the CopyCampaignResponse Action.

CopyCampaignResponseResponse

Contains the response from the CopyCampaignResponseRequest class.

CopyDynamicListToStaticRequest

Contains the data that is needed to create a static list from the specified dynamic list and add the members that satisfy the dynamic list query criteria to the static list.

For the Web API use the CopyDynamicListToStatic Action.

CopyDynamicListToStaticResponse

Contains the response from the CopyDynamicListToStaticRequest class.

CopyMembersListRequest

Contains the data that is needed to copy the members from the source list to the target list without creating duplicates.

For the Web API use the CopyMembersList Action.

CopyMembersListResponse

Contains the response from the CopyMembersListRequest class.

CopySystemFormRequest

Contains the data that is needed to create a new entity form that is based on an existing entity form.

For the Web API use the CopySystemForm Action.

CopySystemFormResponse

Contains the response from the CopySystemFormRequest class.

CreateActivitiesListRequest

Contains the data that is needed to create a quick campaign to distribute an activity to members of a list (marketing list).

For the Web API use the CreateActivitiesList Action.

CreateActivitiesListResponse

Contains the response from the CreateActivitiesListRequest class.

For the Web API the CreateActivitiesListResponse ComplexType is the response value from the CreateActivitiesList Action.

CreateAsyncJobToRevokeInheritedAccessRequest
CreateAsyncJobToRevokeInheritedAccessResponse
CreateExceptionRequest

Contains the data that is needed to create an exception for the recurring appointment instance.

For the Web API use the CreateException Action.

CreateExceptionResponse

Contains the response from the CreateExceptionRequest class.

For the Web API the CreateExceptionResponse ComplexType is the response value from the CreateException Action.

CreateInstanceRequest

Contains the data that is needed to create future unexpanded instances for the recurring appointment master.

For the Web API use the CreateInstance Action.

CreateInstanceResponse

Contains the response from the CreateInstanceRequest class.

For the Web API the CreateInstanceResponse ComplexType is the response value from the CreateInstance Action.

CreateKnowledgeArticleTranslationRequest

Contains the data that is required to create translation of a knowledge article record.

For the Web API use the CreateKnowledgeArticleTranslation Action.

CreateKnowledgeArticleTranslationResponse

Contains the response from the CreateKnowledgeArticleTranslationRequest class.

CreateKnowledgeArticleVersionRequest

Contains the data that is required to create a major or minor version of a knowledge article record.

For the Web API use the CreateKnowledgeArticleVersion Action.

CreateKnowledgeArticleVersionResponse

Contains the response from the CreateKnowledgeArticleVersionRequest class.

CreatePolymorphicLookupAttributeRequest

Contains the data to create a multi-table lookup attribute.

CreatePolymorphicLookupAttributeResponse

Contains the service response from processing CreatePolymorphicLookupAttributeRequest.

CreateWorkflowFromTemplateRequest

Contains the data that is needed to create a workflow (process) from a workflow template.

For the Web API use the CreateWorkflowFromTemplate Action.

CreateWorkflowFromTemplateResponse

Contains the response from the CreateWorkflowFromTemplateRequest class.

DeleteAndPromoteAsyncRequest
DeleteAndPromoteAsyncResponse
DeleteAndPromoteRequest

Contains the data needed to replace a managed solution plus all of its patches.

DeleteAndPromoteResponse

Contains the response from executing the DeleteAndPromoteRequest class.

For the Web API the DeleteAndPromoteResponse ComplexType is the response value from the DeleteAndPromote Action.

DeleteAuditDataRequest

Contains the data that is needed to delete all audit data records up until a specified end date.

For the Web API use the DeleteAuditData Action.

DeleteAuditDataResponse

Contains the response from the DeleteAuditDataRequest class.

For the Web API the DeleteAuditDataResponse ComplexType is the response value from the DeleteAuditData Action.

DeleteFileRequest

Contains the data needed to delete a stored binary file, attachment, or annotation.

DeleteFileResponse

Contains the response from the DeleteFileRequest class.

DeleteOpenInstancesRequest

Contains the data that is needed to delete instances of a recurring appointment master that have an “Open” state.

For the Web API use the DeleteOpenInstances Action.

DeleteOpenInstancesResponse

Contains the response from the DeleteOpenInstancesRequest class.

DeleteRecordChangeHistory1Request

For internal use only.

DeleteRecordChangeHistory1Response

For internal use only.

DeleteRecordChangeHistoryRequest

Contains the data that is needed to delete all audit change history records for a particular record.

For the Web API use the DeleteRecordChangeHistory Action.

DeleteRecordChangeHistoryResponse

Contains the response from the DeleteRecordChangeHistoryRequest class.

DeliverImmediatePromoteEmailRequest

Contains the data that is needed to deliver an email from an email client.

DeliverImmediatePromoteEmailResponse

Contains the response from processing the DeliverImmediatePromoteEmailRequest message.

DeliverIncomingEmailRequest

Contains the data that is needed to create an email activity record from an incoming email message (Track in CRM).

For the Web API use the DeliverIncomingEmail Action.

DeliverIncomingEmailResponse

Contains the response from the DeliverIncomingEmailRequest class.

DeliverPromoteEmailRequest

Contains the data that is needed to create an email activity record from the specified email message (Track in CRM).

For the Web API use the DeliverPromoteEmail Action.

DeliverPromoteEmailResponse

Contains the response from the DeliverPromoteEmailRequest class.

DependencyMetadataCollection

Internal use only.

DependencyMetadataInfo

Internal use only.

DependentAttributeMetadata

Individual dependent attribute metadata.

DependentAttributeMetadataCollection

A collection of DependentAttributeMetadata instances.

DependentEntityMetadata

Individual dependent entity metadata.

DependentEntityMetadataCollection

A collection of DependentEntityMetadata instances.

DependentManyToManyRelationshipMetadata

Individual N:N dependent relationship metadata.

DependentOptionMetadata

Individual option set metadata.

DependentOptionMetadataCollection

A collection of DependentOptionMetadata instances.

DependentOptionSetMetadata

Contains dependent metadata for an option set.

DependentRelationship

Individual 1:N or N:1 dependent relationship.

DependentRelationshipCollection

A collection of DependentRelationship instances.

DeprovisionLanguageRequest

Contains the data that is needed to deprovision a language.

For the Web API use the DeprovisionLanguage Action.

DeprovisionLanguageResponse

Contains the response from the DeprovisionLanguageRequest class.

DisassociateEntitiesRequest

Deprecated. Use the DisassociateRequest class. Contains the data that is needed to remove a link between two entity instances in a many-to-many relationship.

DisassociateEntitiesResponse

Deprecated. Use the DisassociateRequest class and its associated response class. Contains the response from the DisassociateEntitiesRequest class.

DistributeCampaignActivityRequest

Contains the data that is needed to create a bulk operation that distributes a campaign activity. The appropriate activities, such as a phone call or fax, are created for the members of the list that is associated with the specified campaign activity.

For the Web API use the DistributeCampaignActivity Action.

DistributeCampaignActivityResponse

Contains the response from the DistributeCampaignActivityRequest class.

DownloadBlockRequest

Contains the data needed to download a data block.

DownloadBlockResponse

Contains the response from the DownloadBlockRequest class.

DownloadReportDefinitionRequest

Contains the data that is needed to download a report definition.

For the Web API use the DownloadReportDefinition Function.

DownloadReportDefinitionResponse

Contains the response from the DownloadReportDefinitionRequest class.

For the Web API the DownloadReportDefinitionResponse ComplexType is the response value from the DownloadReportDefinition Function.

DownloadSolutionExportDataRequest

Contains the data needed to download a solution file that was exported by an asynchronous job.

DownloadSolutionExportDataResponse

Contains the service response from processing DownloadSolutionExportDataRequest.

EntityMetaDataInfo
EntityRelationsWithDependantEntityMetadata

The attributes of a given entity; Relational entities with attributes metadata and dependent entity metadata.

ErrorInfo

Specifies the results of a scheduling operation using the ValidateRequest, BookRequest, or RescheduleRequest message.

For the Web API the corresponding type is ErrorInfo ComplexType.

ExecuteByIdSavedQueryRequest

Contains the data that is needed to execute a saved query (view) that has the specified ID.

ExecuteByIdSavedQueryResponse

Contains the response from the ExecuteByIdSavedQueryRequest class.

ExecuteByIdUserQueryRequest

Contains the data that is needed to execute the user query (saved view) that has the specified ID.

ExecuteByIdUserQueryResponse

Contains the response from the ExecuteByIdUserQueryRequest class.

ExecuteFetchRequest

Deprecated. Use the RetrieveMultipleRequest class.

ExecuteFetchResponse

Deprecated. Use the RetrieveMultipleRequest class and its associated response class.

ExecuteWorkflowRequest

Contains the data that’s needed to execute a workflow.

For the Web API use the ExecuteWorkflow Action .

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

ExecuteWorkflowResponse

Contains the response from the ExecuteWorkflowResponse class.

ExpandCalendarRequest

Contains the data that is needed to convert the calendar rules to an array of available time blocks for the specified period.

For the Web API use the ExpandCalendar Function.

ExpandCalendarResponse

Contains the response from the ExpandCalendarRequest class.

For the Web API the ExpandCalendarResponse ComplexType is the response value from the ExpandCalendar Function.

ExportFieldTranslationRequest

Contains the data that is needed to export localizable fields values to a compressed file.

For the Web API use ExportFieldTranslation Function.

ExportFieldTranslationResponse

Contains the response from the ExportFieldTranslationRequest class.

For the Web API the ExportFieldTranslationResponse ComplexType is the response value from the ExportFieldTranslation Function.

ExportMappingsImportMapRequest

Contains the data that is needed to export a data map as an XML formatted data.

ExportMappingsImportMapResponse

Contains the response from the ExportMappingsImportMapRequest class.

For the Web API the ExportMappingsImportMapResponse ComplexType is the response value from the ExportMappingsImportMap Action.

ExportSolutionAsyncRequest

Contains the data to export a solution using an asynchronous job.

ExportSolutionAsyncResponse

Contains the service response from processing the ExportSolutionAsyncRequest class.

ExportSolutionRequest

Contains the data that’s needed to export a solution.

For the Web API use the ExportSolution Action.

ExportSolutionResponse

Contains the response from the ExportSolutionRequest class.

For the Web API the ExportSolutionResponse ComplexType is the response value from the ExportSolution Action.

ExportTranslationRequest

Contains the data that is needed to export all translations for a specific solution to a compressed file.

For the Web API use the ExportTranslation Action.

ExportTranslationResponse

Contains the response from the ExportTranslationRequest class.

For the Web API the ExportTranslationResponse ComplexType is the response value from the ExportTranslation Action.

FeatureControlSettingCollection

Internal use only.

FeatureControlSettingData

Internal use only.

FetchXmlToQueryExpressionRequest

Contains the data that is needed to convert a query in FetchXML to a QueryExpression.

For the Web API use the FetchXmlToQueryExpression Function.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

FetchXmlToQueryExpressionResponse

Contains the response from the FetchXmlToQueryExpressionRequest class.

FindParentResourceGroupRequest

Contains the data that is needed to find a parent resource group (scheduling group) for the specified resource groups (scheduling groups).

For the Web API use the FindParentResourceGroup Function .

FindParentResourceGroupResponse

Contains the response from the FindParentResourceGroupRequest class.

FormatAddressRequest

Contains the data to compute an address based on country and format parameters.

FormatAddressResponse

Contains the response from processing the FormatAddressRequest message.

FormDisplayOrder

Contains data that specifies the display order of a form.

FormDisplayOrderCollection

A collection of FormDisplayOrder instances.

FulfillSalesOrderRequest

Contains the data that is needed to fulfill the sales order (order).

For the Web API use the FulfillSalesOrder Action.

FulfillSalesOrderResponse

Contains the response from the FulfillSalesOrderRequest class.

FullTextSearchKnowledgeArticleRequest

Contains the data that is needed to perform a full-text search on knowledge articles in CRM using the specified search text.

For the Web API use the FullTextSearchKnowledgeArticle Action.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

FullTextSearchKnowledgeArticleResponse

Contains the response from the FullTextSearchKnowledgeArticleRequest class.

GenerateInvoiceFromOpportunityRequest

Contains the data that is needed to generate an invoice from an opportunity.

For the Web API use the GenerateInvoiceFromOpportunity Action.

GenerateInvoiceFromOpportunityResponse

Contains the response from the GenerateInvoiceFromOpportunityRequest class.

GenerateQuoteFromOpportunityRequest

Contains the data that is needed to generate a quote from an opportunity.

For the Web API use the GenerateQuoteFromOpportunity Action.

GenerateQuoteFromOpportunityResponse

Contains the response from the GenerateQuoteFromOpportunityRequest class.

GenerateSalesOrderFromOpportunityRequest

Contains the data that is needed to generate a sales order (order) from an opportunity.

For the Web API use the GenerateSalesOrderFromOpportunity Action.

GenerateSalesOrderFromOpportunityResponse

Contains the response from the GenerateSalesOrderFromOpportunityRequest class.

GenerateSharedLinkRequest
GenerateSharedLinkResponse
GenerateSocialProfileRequest

Contains the data to return an existing social profile record if one exists, otherwise generates a new one and returns it.

For the Web API use the GenerateSocialProfile Action.

GenerateSocialProfileResponse

Contains the response from the GenerateSocialProfileRequest message.

GetAllTimeZonesWithDisplayNameRequest

Contains the data that is needed to retrieve all the time zone definitions for the specified locale and to return only the display name attribute.

For the Web API use the GetAllTimeZonesWithDisplayName Function.

GetAllTimeZonesWithDisplayNameResponse

Contains the response from the GetAllTimeZonesWithDisplayNameRequest class.

GetAutoNumberSeed1Request

For internal use only.

GetAutoNumberSeed1Response

For internal use only.

GetAutoNumberSeedRequest
GetAutoNumberSeedResponse

Contains the response from processing the GetAutoNumberSeedRequest message.

GetDecryptionKeyRequest

For internal use only. See RetrieveDataEncryptionKeyRequest.

GetDecryptionKeyResponse

For internal use only.

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 level.

For the Web API use the GetDefaultPriceLevel Function.

GetDefaultPriceLevelResponse

Contains the response from the GetDefaultPriceLevelRequest class.

GetDistinctValuesImportFileRequest

Contains the data that is needed to retrieve distinct values from the parse table for a column in the source file that contains list values.

For the Web API use the GetDistinctValuesImportFile Function.

GetDistinctValuesImportFileResponse

Contains the response from the GetDistinctValuesImportFileRequest class.

GetFileSasUrlRequest
GetFileSasUrlResponse
GetHeaderColumnsImportFileRequest

Contains the data that is needed to retrieve the source-file column headings; or retrieve the system-generated column headings if the source file does not contain column headings.

For the Web API use GetHeaderColumnsImportFile Function.

GetHeaderColumnsImportFileResponse

Contains the response from the GetHeaderColumnsImportFileRequest class.

GetInvoiceProductsFromOpportunityRequest

Contains the data that is needed to retrieve the products from an opportunity and copy them to the invoice.

For the Web API use the GetInvoiceProductsFromOpportunity Action.

GetInvoiceProductsFromOpportunityResponse

Contains the response from the GetInvoiceProductsFromOpportunityRequest class.

GetNextAutoNumberValue1Request

For internal use only.

GetNextAutoNumberValue1Response

For internal use only.

GetNextAutoNumberValueRequest
GetNextAutoNumberValueResponse

Contains the response from processing the GetNextAutoNumberValueRequest message.

GetQuantityDecimalRequest

Contains the data that is needed to get the quantity decimal value of a product for the specified entity in the target.

For the Web API use the GetQuantityDecimal Function.

GetQuantityDecimalResponse

Contains the response from the GetQuantityDecimalRequest class.

GetQuoteProductsFromOpportunityRequest

Contains the data that is needed to retrieve the products from an opportunity and copy them to the quote.

For the Web API use the GetQuoteProductsFromOpportunity Action.

GetQuoteProductsFromOpportunityResponse

Contains the response from the GetQuoteProductsFromOpportunityRequest class.

GetReportHistoryLimitRequest

Contains the data that is needed to retrieve the history limit for a report.

For the Web API use the GetReportHistoryLimit Function.

GetReportHistoryLimitResponse

Contains the response from the GetReportHistoryLimitRequest class.

For the Web API the GetReportHistoryLimitResponse ComplexType is the response value from the GetReportHistoryLimit Function.

GetSalesOrderProductsFromOpportunityRequest

Contains the data that is needed to retrieve the products from an opportunity and copy them to the sales order (order).

For the Web API use GetSalesOrderProductsFromOpportunity Action.

GetSalesOrderProductsFromOpportunityResponse

Contains the response from the GetSalesOrderProductsFromOpportunityRequest class.

GetTimeZoneCodeByLocalizedNameRequest

Contains the data that is needed to retrieve the time zone code for the specified localized time zone name.

For the Web API use the GetTimeZoneCodeByLocalizedName Function.

GetTimeZoneCodeByLocalizedNameResponse

Contains the response from the GetTimeZoneCodeByLocalizedNameRequest class.

For the Web API the GetTimeZoneCodeByLocalizedNameResponse ComplexType is the response value from the GetTimeZoneCodeByLocalizedName Function.

GetTrackingTokenEmailRequest

Contains the data that is needed to return a tracking token that can then be passed as a parameter to the SendEmailRequest message.

For the Web API use the GetTrackingTokenEmail Action.

GetTrackingTokenEmailResponse

Contains the response from the GetTrackingTokenEmailRequest class.

For the Web API the GetTrackingTokenEmailResponse ComplexType is the response value from the GetTrackingTokenEmail Action.

GrantAccessRequest

Contains the data that is needed to grant a security principal (user, team, or organization) access to the specified record.

GrantAccessResponse

Contains the response from the GrantAccessRequest class.

GrantAccessUsingSharedLinkRequest
GrantAccessUsingSharedLinkResponse
ImmediateBookRequest

Contains the data to book an appointment transactionally, obeying the constraints specified by the associated service and the supplied appointment request.

ImmediateBookResponse

Contains the response from processing the ImmediateBookRequest message.

ImportCardTypeSchemaRequest

Contains the data to import and create a new cardtype required by the installed solution.

ImportCardTypeSchemaResponse

Contains the response from processing the ImportCardTypeSchemaRequest message.

ImportFieldTranslationRequest

Contains the data that is needed to import translations from a compressed file.

For the Web API use the ImportFieldTranslation Action.

ImportFieldTranslationResponse

Contains the response from the ImportFieldTranslationRequest class.

ImportMappingsImportMapRequest

Contains the data that is needed to import the XML representation of a data map and create an import map (data map) based on this data.

For the Web API use the ImportMappingsImportMap Action.

ImportMappingsImportMapResponse

Contains the response from the ImportMappingsImportMapRequest class.

ImportRecordsImportRequest

Contains the data that is needed to submit an asynchronous job that uploads the transformed data into Microsoft Dynamics 365.

For the Web API use the ImportRecordsImport Action.

ImportRecordsImportResponse

Contains the response from the ImportRecordsImportRequest class.

ImportSolutionAsyncRequest

Contains the data that is needed to import a solution using an asynchronous job.

For the Web API use the ImportSolutionAsync Action.

ImportSolutionAsyncResponse

Contains the response from the ImportSolutionAsyncRequest class.

ImportSolutionRequest

Contains the data that is needed to import a solution.

For the Web API use the ImportSolution Action.

ImportSolutionResponse

Contains the response from the ImportSolutionRequest class.

ImportSolutionsRequest

For internal use only.

ImportSolutionsResponse

Contains the response from processing the ImportSolutionsRequest message.

ImportTranslationAsyncRequest
ImportTranslationAsyncResponse
ImportTranslationRequest

Contains the data that is needed to import translations from a compressed file.

For the Web API use the ImportTranslation Action.

ImportTranslationResponse

Contains the response from the ImportTranslationRequest class.

IncrementKnowledgeArticleViewCountRequest

Contains the data that is required to increment the per day view count of a knowledge article record.

For the Web API use the IncrementKnowledgeArticleViewCount Function.

IncrementKnowledgeArticleViewCountResponse

Contains the response from the IncrementKnowledgeArticleViewCountRequest class.

InitializeAnnotationBlocksDownloadRequest

Contains the data needed to initialize the download of one or more annotation data blocks.

InitializeAnnotationBlocksDownloadResponse

Contains the response from the InitializeAnnotationBlocksDownloadRequest class.

InitializeAnnotationBlocksUploadRequest

Contains the data needed to initialize annotation storage for receiving (uploading) one or more annotation data blocks.

InitializeAnnotationBlocksUploadResponse

Contains the response from the InitializeAnnotationBlocksUploadRequest class.

InitializeAttachmentBlocksDownloadRequest

Contains the data needed to initialize the download of one or more attachment data blocks.

InitializeAttachmentBlocksDownloadResponse

Contains the response from the InitializeAttachmentBlocksDownloadRequest class.

InitializeAttachmentBlocksUploadRequest

Contains the data needed to initialize attachment storage for receiving (uploading) one or more attachment data blocks.

InitializeAttachmentBlocksUploadResponse

Contains the response from the InitializeAttachmentBlocksUploadRequest class.

InitializeFileBlocksDownloadRequest

Contains the data needed to initialize the download of one or more binary data blocks.

InitializeFileBlocksDownloadResponse

Contains the response from the InitializeFileBlocksDownloadRequest class.

InitializeFileBlocksUploadRequest

Contains the data needed to initialize file storage for receiving (uploading) one or more binary data blocks.

InitializeFileBlocksUploadResponse

Contains the response from the InitializeFileBlocksUploadRequest class.

InitializeFromRequest

Contains the data that is needed to initialize a new record from an existing record.

For the Web API use the InitializeFrom Function.

InitializeFromResponse

Contains the response from the InitializeFromRequest class.

InitializeModernFlowFromAsyncWorkflowRequest

For internal use only.

InitializeModernFlowFromAsyncWorkflowResponse
InputArgument

Contains custom application data.

InputArgumentCollection

Contains a collection of InputArgument objects.

InstallSampleDataRequest

Contains the data that is needed to install the sample data.

For the Web API use the InstallSampleData Action.

InstallSampleDataResponse

Contains the response from the InstallSampleDataRequest class.

InstantiateFiltersRequest

Contains the data that is needed to instantiate a set of filters for Dynamics 365 for Outlook for the specified user.

For the Web API use the InstantiateFilters Action.

InstantiateFiltersResponse

Contains the response from the InstantiateFiltersRequest class.

InstantiateTemplateRequest

Contains the parameters that are needed to create an email message from a template (email template).

For the Web API use the InstantiateTemplate Action.

InstantiateTemplateResponse

Contains the response from the InstantiateTemplateRequest class.

IsBackOfficeInstalledRequest

Deprecated. Checks whether Microsoft Dynamics GP 9.0 is installed.

IsBackOfficeInstalledResponse

Deprecated.

IsComponentCustomizableRequest

Contains the data that is needed to determine whether a solution component is customizable.

For the Web API use the IsComponentCustomizable Function.

IsComponentCustomizableResponse

Contains the response from the IsComponentCustomizableRequest class.

For the Web API the AddItemCampaignActivityResponse ComplexType is the response value from the AddItemCampaignActivity Action.

IsValidStateTransitionRequest

Contains the data that is needed to validate the state transition.

For the Web API use the IsValidStateTransition Function.

IsValidStateTransitionResponse

Contains the response from the IsValidStateTransitionRequest class.

LocalizedLabelDetails
LocalizedLabelInfo
LocalTimeFromUtcTimeRequest

Contains the data that is needed to retrieve the local time for the specified Coordinated Universal Time (UTC).

LocalTimeFromUtcTimeResponse

Contains the response from the LocalTimeFromUtcTimeRequest class.

LockInvoicePricingRequest

Contains the data that is needed to lock the total price of products and services that are specified in the invoice.

For the Web API use the LockInvoicePricing Action.

LockInvoicePricingResponse

Contains the response from the LockInvoicePricingRequest class.

LockSalesOrderPricingRequest

For the Web API use the LockSalesOrderPricing Action.

LockSalesOrderPricingResponse

Contains the response from the LockSalesOrderPricingRequest class.

LoseOpportunityRequest

Contains the data that is needed to set the state of an opportunity to Lost.

For the Web API use the LoseOpportunity Action.

LoseOpportunityResponse

Contains the response from the LoseOpportunityRequest class.

MakeAvailableToOrganizationReportRequest

Deprecated. Use the UpdateRequest class.

MakeAvailableToOrganizationReportResponse

Deprecated. Use the UpdateRequest class and its associated response class.

MakeAvailableToOrganizationTemplateRequest

Deprecated. Use the UpdateRequest class.

MakeAvailableToOrganizationTemplateResponse

Deprecated. Use the UpdateRequest class and its associated response class.

MakeUnavailableToOrganizationReportRequest

Deprecated. Use the UpdateRequest class.

MakeUnavailableToOrganizationReportResponse

Deprecated. Use the UpdateRequest class and its associated response class.

MakeUnavailableToOrganizationTemplateRequest

Deprecated. Use the UpdateRequest class.

MakeUnavailableToOrganizationTemplateResponse

Deprecated. Use the UpdateRequest class and its associated response class.

MergeRequest

Contains the data that’s needed to merge the information from two entity records of the same type.

For the Web API use the Merge Action.

MergeResponse

Contains the response from the MergeRequest class.

MissingComponent

Contains the data to describe a solution component that is required by a solution but not found in the system.

For the Web API the corresponding type is MissingComponent ComplexType.

ModifyAccessRequest

Contains the data that is needed to replace the access rights on the target record for the specified security principal (user, team, or organization).

ModifyAccessResponse

Contains the response from the ModifyAccessRequest class.

ObjectiveRelation

Contains the data that describes the scheduling strategy for an AppointmentRequest and that overrides the default constraints.

For the Web API the corresponding type is ObjectiveRelation ComplexType.

OrganizationResources

Contains data regarding the resources used by an organization.

For the Web API the corresponding type is OrganizationResources ComplexType.

OrgOverridableSettingInfo

Internal use only.

OverridableSettingInfo

Internal use only.

OverridableSettingInfoCollection

Internal use only.

ParseImportRequest

Contains the data that is needed to submit an asynchronous job that parses all import files that are associated with the specified import (data import).

ParseImportResponse

Contains the response from the ParseImportRequest class.

PickFromQueueRequest

Contains the data that is needed to assign a queue item to a user and optionally remove the queue item from the queue.

For the Web API use the PickFromQueue Action.

PickFromQueueResponse

Contains the response from the PickFromQueueRequest message.

PrincipalAccess

Contains access rights information for the security principal (user, team, or organization).

ProcessInboundEmailRequest

Contains the data that is needed to process the email responses from a marketing campaign.

For the Web API use the ProcessInboundEmail Action.

ProcessInboundEmailResponse

Contains the response from the ProcessInboundEmailRequest class.

PropagateByExpressionRequest

Contains the data that is needed to create a quick campaign to distribute an activity to accounts, contacts, or leads that are selected by a query.

For the Web API use thePropagateByExpression Action .

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

PropagateByExpressionResponse

Contains the response from the PropagateByExpressionRequest class.

ProposalParty

Represents a party (user, team, or resource) that is needed for the proposed appointment.

For the Web API the corresponding type is ProposalParty ComplexType.

ProvisionLanguageAsyncRequest

Contains the data that is needed to provision a new language using a background job.

ProvisionLanguageAsyncResponse

Contains the response from processing the ProvisionLanguageAsyncRequest message.

ProvisionLanguageRequest

Contains the data that is needed to provision a new language.

For the Web API use the ProvisionLanguage Action.

ProvisionLanguageResponse

Contains the response from the ProvisionLanguageRequest class.

PublishAllXmlAsyncRequest
PublishAllXmlAsyncResponse
PublishAllXmlRequest

Contains the data that is needed to publish all changes to solution components.

For the Web API use the PublishAllXml Action.

PublishAllXmlResponse

Contains the response from the PublishAllXmlRequest class.

PublishDuplicateRuleRequest

Contains the data that is needed to submit an asynchronous job to publish a duplicate rule.

For the Web API use the PublishDuplicateRule Action.

PublishDuplicateRuleResponse

Contains the response from the PublishDuplicateRuleRequest class.

PublisherInformation

Contains information about a publisher.

PublishProductHierarchyRequest

Contain the data that is needed to publish a product family record and all its child records.

For the Web API use the PublishProductHierarchy Action.

PublishProductHierarchyResponse

Contains the response from the PublishProductHierarchyRequest class.

PublishThemeRequest

Contains the data that is needed to publish a theme and set it as the current theme.

For the Web API use the PublishTheme Action.

PublishThemeResponse

Contains the response from the PublishThemeRequest class.

PublishXmlRequest

Contains the data that is needed to publish specified solution components.

For the Web API use the PublishXml Action.

PublishXmlResponse

Contains the response from the PublishXmlRequest class.

QualifyLeadRequest

Contains the data that is needed to qualify a lead and create account, contact, and opportunity records that are linked to the originating lead record.

For the Web API use the QualifyLead Action .

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

QualifyLeadResponse

Contains the response from the QualifyLeadRequest class.

QualifyMemberListRequest

Contains the data that is needed to qualify the specified list and either override the list members or remove them according to the specified option.

For the Web API use the QualifyMemberList Action.

QualifyMemberListResponse

Contains the response from the QualifyMemberListRequest class.

QueryExpressionToFetchXmlRequest

Contains the data that is needed to convert a query, which is represented as a QueryExpression class, to its equivalent query, which is represented as FetchXML.

For the Web API use the QueryExpressionToFetchXml Action .

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

QueryExpressionToFetchXmlResponse

Contains the response from the QueryExpressionToFetchXmlRequest class.

QueryMetadata

Base (common) metadata for a query.

QueryMultipleSchedulesRequest

Contains the data that is needed to search multiple resources for available time block that match the specified parameters.

For the Web API use the QueryMultipleSchedules Function.

QueryMultipleSchedulesResponse

Contains the response from the QueryMultipleSchedulesRequest class.

QueryScheduleRequest

Contains the data that is needed to search the specified resource for an available time block that matches the specified parameters.

For the Web API use the QuerySchedule Function.

QueryScheduleResponse

Contains response from QueryScheduleRequest.

For the Web API the QueryScheduleResponse ComplexType is the response value from the QuerySchedule Function.

QueryWithEntityMetadata

Represents a query along with its dependencies.

QueueUpdateRibbonClientMetadataRequest

Contains the data to queue UpdateRibbonClientMetadata to a background job.

QueueUpdateRibbonClientMetadataResponse

Contains the response from processing the QueueUpdateRibbonClientMetadataRequest message.

ReassignObjectsOwnerRequest

Contains the data that is needed to reassign all records that are owned by the security principal (user, team, or organization) to another security principal (user, team, or organization).

For the Web API use the ReassignObjectsOwner Action.

ReassignObjectsOwnerResponse

Contains the response from the ReassignObjectsOwnerRequest class.

ReassignObjectsSystemUserRequest

Contains the data that is needed to reassign all records that are owned by a specified user to another security principal (user, team, or organization).

For the Web API use the ReassignObjectsSystemUser Action.

ReassignObjectsSystemUserResponse

Contains the response from the ReassignObjectsSystemUserRequest class.

RecalculateRequest

Contains the data that is needed to recalculate system-computed values for rollup fields in the goal hierarchy.

For the Web API use the Recalculate Action.

RecalculateResponse

Contains the response from the RecalculateRequest.

RelationshipAuditDetail

Contains the audited details of a change in a relationship.

ReleaseToQueueRequest

Contains the data that is needed to assign a queue item back to the queue owner so others can pick it.

For the Web API use the ReleaseToQueue Action.

ReleaseToQueueResponse

Contains the response from the ReleaseToQueueRequest message.

RemoveAppComponentsRequest

Contains the data that is needed to remove a component from an app.

For the Web API, use the RemoveAppComponents Action.

RemoveAppComponentsResponse

Contains the response from processing the RemoveAppComponentsRequest message.

RemoveFromQueueRequest

Contains the data that is needed to remove a queue item from a queue.

For the Web API use the RemoveFromQueue Action.

RemoveFromQueueResponse

Contains the response from the RemoveFromQueueRequest message.

RemoveItemCampaignActivityRequest

Contains the data that is needed to remove an item from a campaign activity.

This message does not have a corresponding Web API action or function in Microsoft Dynamics 365 (online & on-premises). More information: Missing functions and actions for some organization service messages.

RemoveItemCampaignActivityResponse

Contains the response from the RemoveItemCampaignActivityRequest class.

RemoveItemCampaignRequest

Contains the data that is needed to remove an item from a campaign.

This message does not have a corresponding Web API action or function in Microsoft Dynamics 365 (online & on-premises). More information: Missing functions and actions for some organization service messages.

RemoveItemCampaignResponse

Contains the response from the RemoveItemCampaignRequest class.

RemoveMemberListRequest

Contains the data that is needed to remove a member from a list (marketing list).

This message does not have a corresponding Web API action or function in Microsoft Dynamics 365 (online & on-premises). More information: Missing functions and actions for some organization service messages.

RemoveMemberListResponse

Contains the response from the RemoveMemberListRequest class.

RemoveMembersTeamRequest

Contains the data that is needed to remove members from a team.

For the Web API use the RemoveMembersTeam Action.

RemoveMembersTeamResponse

Contains the response from the RemoveMembersTeamRequest class.

RemoveParentRequest

Contains the data that is needed to remove the parent for a system user (user) record.

For the Web API use the RemoveParent Action

RemoveParentResponse

Contains the response from the RemoveParentRequest class.

RemovePrivilegeRoleRequest

Contains the data that is needed to remove a privilege from an existing role.

For the Web API use the RemovePrivilegeRole Action.

RemovePrivilegeRoleResponse

Contains the response from the RemovePrivilegeRoleRequest class.

RemoveProductFromKitRequest

Deprecated. Use the ProductAssociation entity. Contains the data that is needed to remove a product from a kit.

RemoveProductFromKitResponse

Deprecated. Use the ProductAssociation entity. Contains the response from the RemoveProductFromKitRequest.

RemoveRelatedRequest

Use the DisassociateRequestclass. Contains the data that is needed to remove the relationship between the specified records for specific relationships.

RemoveRelatedResponse

Contains the response from the RemoveRelatedRequest class.

RemoveSolutionComponentRequest

Contains the data that is needed to remove a component from an unmanaged solution.

For the Web API use the RemoveSolutionComponent Action.

RemoveSolutionComponentResponse

Contains the response from the RemoveSolutionComponentRequest class.

For the Web API the RemoveSolutionComponentResponse ComplexType is the response value from the RemoveSolutionComponent Action.

RemoveSubstituteProductRequest

Deprecated. Use the ProductSubstitute entity.

RemoveSubstituteProductResponse

Deprecated. Use the ProductSubstitute entity.

RemoveUserFromRecordTeamRequest

Contains the data that is needed to remove a user from the auto created access team for the specified record.

For the Web API use the RemoveUserFromRecordTeam Action.

RemoveUserFromRecordTeamResponse

Contains the response from the RemoveUserFromRecordTeamRequest class.

For the Web API the RemoveUserFromRecordTeamResponse ComplexType is the response value from the RemoveUserFromRecordTeam Action.

RenewContractRequest

Contains the data that is needed to renew a contract and create the contract details for a new contract.

For the Web API use the RenewContract Action.

RenewContractResponse

Contains the response from the RenewContractRequest class.

RenewEntitlementRequest

Contains the data that is needed to renew an entitlement.

For the Web API use the RenewEntitlement Action.

RenewEntitlementResponse

Contains the response from the RenewEntitlementRequest message.

ReplacePrivilegesRoleRequest

Contains the data that is needed to replace the privilege set of an existing role.

For the Web API use the ReplacePrivilegesRole Action.

ReplacePrivilegesRoleResponse

Contains the response from the ReplacePrivilegesRoleRequest class.

RequiredResource

Specifies a resource that is required for a scheduling operation.

For the Web API the corresponding type is RequiredResource ComplexType.

RescheduleRequest

Contains the data that is needed to reschedule an appointment, recurring appointment, or service appointment (service activity).

For the Web API use the Reschedule Action.

Web API support for this message was added with Microsoft Dynamics CRM Online 2016 Update 1 and Microsoft Dynamics CRM 2016 Service Pack 1.

RescheduleResponse

Contains the response from the RescheduleRequest class.

ResetUserFiltersRequest

Contains the data that is needed to reset the offline data filters for the calling user to the default filters for the organization.

For the Web API use the ResetUserFilters Action.

ResetUserFiltersResponse

Contains the response from the ResetUserFiltersRequest class.

ResourceInfo

Contains information about a resource that has a scheduling problem for an appointment.

For the Web API the corresponding type is ResourceInfo ComplexType.

RetrieveAadUserPrivilegesRequest
RetrieveAadUserPrivilegesResponse
RetrieveAadUserRolesRequest
RetrieveAadUserRolesResponse
RetrieveAadUserSetOfPrivilegesByIdsRequest
RetrieveAadUserSetOfPrivilegesByIdsResponse
RetrieveAadUserSetOfPrivilegesByNamesRequest
RetrieveAadUserSetOfPrivilegesByNamesResponse
RetrieveAbsoluteAndSiteCollectionUrlRequest

Contains the data that is needed to retrieve the absolute URL and the site collection URL for a SharePoint location record in Microsoft Dynamics 365.

For the Web API use the RetrieveAbsoluteAndSiteCollectionUrl Function.

RetrieveAbsoluteAndSiteCollectionUrlResponse

Contains the response from the RetrieveAbsoluteAndSiteCollectionUrlRequest class.

For the Web API the RetrieveAbsoluteAndSiteCollectionUrlResponse ComplexType is the response value from the RetrieveAbsoluteAndSiteCollectionUrl Function.

RetrieveActivePathRequest

Contains the data to retrieve a collection of stages currently in the active path for a business process flow instance.

For the Web API use the RetrieveActivePath Function.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

RetrieveActivePathResponse

Contains a response from the RetrieveActivePathRequest class.

RetrieveAllChildUsersSystemUserRequest

Contains the data that is needed to retrieve the collection of users that report to the specified system user (user).

For the Web API use the RetrieveAllChildUsersSystemUser Function.

RetrieveAllChildUsersSystemUserResponse

Contains the response from the RetrieveAllChildUsersSystemUserRequest class.

RetrieveAnalyticsStoreDetailsRequest

Contains the data to retrieves Analytics Store (aka 'Azure Data Lake' Storage container) details.

RetrieveAnalyticsStoreDetailsResponse

Contains the response from processing the RetrieveAnalyticsStoreDetailsRequest message.

RetrieveAppComponentsRequest

Contains the data to return components of an App.

RetrieveAppComponentsResponse

Contains the response from processing the RetrieveAppComponentsRequest message.

RetrieveApplicationRibbonRequest

Contains the data that is needed to retrieve the data that defines the content and behavior of the application ribbon.

For the Web API use the RetrieveApplicationRibbon Function.

RetrieveApplicationRibbonResponse

Contains the response from the RetrieveApplicationRibbonRequest class.

For the Web API the RetrieveApplicationRibbonResponse ComplexType is the response value from the RetrieveApplicationRibbon Function.

RetrieveAttributeChangeHistoryRequest

Contains the data that is needed to retrieve all metadata changes to a specific attribute.

RetrieveAttributeChangeHistoryResponse

Contains the response from the RetrieveAttributeChangeHistoryRequest class.

RetrieveAuditDetailsRequest

Contains the data that is needed to retrieve the full audit details from an Audit record.

RetrieveAuditDetailsResponse

Contains the response from the RetrieveAuditDetailsRequest class.

RetrieveAuditPartitionListRequest

Contains the data that is needed to retrieve the list of database partitions that are used to store audited history data.

For the Web API use the RetrieveAuditPartitionList Function.

RetrieveAuditPartitionListResponse

Contains the response from the RetrieveAuditPartitionListRequest class.

For the Web API the RetrieveAuditPartitionListResponse ComplexType is the response value from the RetrieveAuditPartitionList Function.

RetrieveAvailableLanguagesRequest

Contains the data that is needed to retrieve the list of language packs that are installed and enabled on the server.

For the Web API use the RetrieveAvailableLanguages Function.

RetrieveAvailableLanguagesResponse

Contains the response from the RetrieveAvailableLanguagesRequest class.

For the Web API the RetrieveAvailableLanguagesResponse ComplexType is the response value from the RetrieveAvailableLanguages Function.

RetrieveBusinessHierarchyBusinessUnitRequest

Contains the data that is needed to retrieve all business units (including the specified business unit) from the business unit hierarchy.

For the Web API use the RetrieveBusinessHierarchyBusinessUnit Function.

RetrieveBusinessHierarchyBusinessUnitResponse

Contains the response from the RetrieveBusinessHierarchyBusinessUnitRequest class.

RetrieveByGroupResourceRequest

Contains the data that is needed to retrieve all resources that are related to the specified resource group (scheduling group).

For the Web API use the RetrieveByGroupResource Function.

RetrieveByGroupResourceResponse

Contains the response from the RetrieveByGroupResourceRequest class.

RetrieveByResourceResourceGroupRequest

Contains the data that is needed to retrieve the resource groups (scheduling groups) that contain the specified resource.

For the Web API use the RetrieveByResourceResourceGroup Function.

RetrieveByResourceResourceGroupResponse

Contains the response from the RetrieveByResourceResourceGroupRequest class.

RetrieveByResourcesServiceRequest

Contains the data that is needed to retrieve the collection of services that are related to the specified set of resources.

For the Web API use theRetrieveByResourcesService Function .

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

RetrieveByResourcesServiceResponse

Contains the response from the RetrieveByResourcesServiceRequest class.

RetrieveByTopIncidentProductKbArticleRequest

Contains the data that is needed to retrieve the top-ten articles about a specified product from the knowledge base of articles for your organization.

For the Web API use the RetrieveByTopIncidentProductKbArticle Function.

RetrieveByTopIncidentProductKbArticleResponse

Contains the response from the RetrieveByTopIncidentProductKbArticleRequest class.

RetrieveByTopIncidentSubjectKbArticleRequest

Contains the data that is needed to retrieve the top-ten articles about a specified subject from the knowledge base of articles for your organization.

For the Web API use the RetrieveByTopIncidentSubjectKbArticle Function.

RetrieveByTopIncidentSubjectKbArticleResponse

Contains the response from the RetrieveByTopIncidentSubjectKbArticleRequest class.

RetrieveChannelAccessProfilePrivilegesRequest

For internal use only.

RetrieveChannelAccessProfilePrivilegesResponse

For internal use only.

RetrieveCurrentOrganizationRequest

Contains the data that’s needed to retrieve information about the current organization.

For the Web API use the RetrieveCurrentOrganization Function.

RetrieveCurrentOrganizationResponse

Contains the response from processing RetrieveCurrentOrganizationRequest.

For the Web API the RetrieveCurrentOrganizationResponse ComplexType is the response value from the RetrieveCurrentOrganization Function.

RetrieveDependenciesForDeleteRequest

Contains the data that is needed to retrieve a collection of dependency records that describe any solution components that would prevent a solution component from being deleted.

For the Web API use the RetrieveDependenciesForDelete Function.

RetrieveDependenciesForDeleteResponse

Contains the response from the RetrieveDependenciesForDeleteRequest class.

RetrieveDependenciesForUninstallRequest

Contains the data that is needed to retrieve a list of the solution component dependencies that can prevent you from uninstalling a managed solution.

For the Web API use the RetrieveDependenciesForUninstall Function.

RetrieveDependenciesForUninstallResponse

Contains the response from the RetrieveDependenciesForUninstallRequest class.

RetrieveDependentComponentsRequest

Contains the data that is needed to retrieves a list dependencies for solution components that directly depend on a solution component.

For the Web API use the RetrieveDependentComponents Function.

RetrieveDependentComponentsResponse

Contains the response from the RetrieveDependentComponentsRequest class.

RetrieveDeploymentLicenseTypeRequest

Contains the data that is needed to retrieve the type of license for a deployment of Microsoft Dynamics 365.

For the Web API use the RetrieveDeploymentLicenseType Function.

RetrieveDeploymentLicenseTypeResponse

Contains the response from the RetrieveDeploymentLicenseTypeRequest class.

For the Web API the RetrieveDeploymentLicenseTypeResponse ComplexType is the response value from the RetrieveDeploymentLicenseType Function.

RetrieveDeprovisionedLanguagesRequest

Contains the data that is needed to retrieve a list of language packs that are installed on the server that have been disabled.

For the Web API use the RetrieveDeprovisionedLanguages Function.

RetrieveDeprovisionedLanguagesResponse

Contains the response from the RetrieveDeprovisionedLanguagesRequest class.

For the Web API the RetrieveDeprovisionedLanguagesResponse ComplexType is the response value from the RetrieveDeprovisionedLanguages Function.

RetrieveDuplicatesRequest

Contains the data that is needed to detect and retrieve duplicates for a specified record.

For the Web API use the RetrieveDuplicates Function.

RetrieveDuplicatesResponse

Contains the response from the RetrieveDuplicatesRequest class.

RetrieveEntityRibbonRequest

Contains the data that is needed to retrieve ribbon definitions for an entity.

For the Web API use the RetrieveEntityRibbon Function.

RetrieveEntityRibbonResponse

Contains the response from the RetrieveEntityRibbonRequest class.

For the Web API the RetrieveEntityRibbonResponse ComplexType is the response value from the RetrieveEntityRibbon Function.

RetrieveExchangeAppointmentsRequest

Retrieves the appointments for the current user for a specific date range from the exchange web service.

For the Web API use the RetrieveExchangeAppointments Function.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

RetrieveExchangeAppointmentsResponse

RetrieveExchangeRateRequest

Contains the data that is needed to retrieve the exchange rate.

For the Web API use the RetrieveExchangeRate Function.

RetrieveExchangeRateResponse

Contains the response from the RetrieveExchangeRateRequest class.

For the Web API the RetrieveExchangeRateResponse ComplexType is the response value from the RetrieveExchangeRate Function.

RetrieveFeatureControlSettingRequest
RetrieveFeatureControlSettingResponse
RetrieveFeatureControlSettingsByNamespaceRequest
RetrieveFeatureControlSettingsByNamespaceResponse
RetrieveFeatureControlSettingsRequest
RetrieveFeatureControlSettingsResponse
RetrieveFilteredFormsRequest

Contains the data that is needed to retrieve the entity forms that are available for a specified user.

For the Web API use the RetrieveFilteredForms Function.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

RetrieveFilteredFormsResponse

Contains the response from the RetrieveFilteredFormsRequest class.

RetrieveFormattedImportJobResultsRequest

Contains the data that is needed to retrieve the formatted results from an import job.

For the Web API use the RetrieveFormattedImportJobResults Function.

RetrieveFormattedImportJobResultsResponse

Contains the response from the RetrieveFormattedImportJobResultsRequest class.

For the Web API the RetrieveFormattedImportJobResultsResponse ComplexType is the response value from the RetrieveFormattedImportJobResults Function.

RetrieveFormXmlRequest

For internal use only.

RetrieveFormXmlResponse

For internal use only.

RetrieveInstalledLanguagePacksRequest

Contains the data that is needed to retrieve the list of language packs that are installed on the server.

For the Web API use the RetrieveInstalledLanguagePacks Function.

RetrieveInstalledLanguagePacksResponse

Contains the response from the RetrieveInstalledLanguagePacksRequest class.

For the Web API the RetrieveInstalledLanguagePacksResponse ComplexType is the response value from the RetrieveInstalledLanguagePacks Function.

RetrieveInstalledLanguagePackVersionRequest

Contains the data that is needed to retrieve the version of an installed language pack.

For the Web API use the RetrieveLicenseInfo Function.

RetrieveInstalledLanguagePackVersionResponse

Contains the response from the RetrieveInstalledLanguagePackVersionRequest class.

For the Web API the RetrieveInstalledLanguagePackVersionResponse ComplexType is the response value from the RetrieveInstalledLanguagePackVersion Function.

RetrieveLicenseInfoRequest

Contains the data that is needed to retrieve the number of used and available licenses for a deployment of Microsoft Dynamics 365.

For the Web API use the RetrieveLicenseInfo Function.

RetrieveLicenseInfoResponse

Contains the response from the RetrieveLicenseInfoRequest class.

For the Web API the RetrieveLicenseInfoResponse ComplexType is the response value from the RetrieveLicenseInfo Function.

RetrieveLocLabelsRequest

Contains the data that is needed to retrieve localized labels for a limited set of entity attributes.

For the Web API use the RetrieveLocLabels Function.

RetrieveLocLabelsResponse

Contains the response from the RetrieveLocLabelsRequest class.

RetrieveMailboxTrackingFoldersRequest

Contains the data needed to retrieve folder-level tracking rules for a mailbox.

For the Web API use the RetrieveMailboxTrackingFolders Function.

RetrieveMailboxTrackingFoldersResponse

Contains the response from the RetrieveMailboxTrackingFoldersRequest class.

For the Web API the RetrieveMailboxTrackingFoldersResponse ComplexType is the response value from the RetrieveMailboxTrackingFolders Function.

RetrieveMembersBulkOperationRequest

Contains the data that is needed to retrieve the members of a bulk operation.

For the Web API use the RetrieveMembersBulkOperation Function.

RetrieveMembersBulkOperationResponse

Contains the response from the RetrieveMembersBulkOperationRequest class.

RetrieveMembersTeamRequest

Deprecated. Use the RetrieveMultipleRequest class.

RetrieveMembersTeamResponse

Deprecated. Use the RetrieveMultipleRequest class and its associated response class. Contains the response from the RetrieveMembersTeamRequest class.

RetrieveMissingComponentsRequest

Contains the data that is needed to retrieve a list of missing components in the target organization.

For the Web API use the RetrieveMissingComponents Function.

RetrieveMissingComponentsResponse

Contains the response from the RetrieveMissingComponentsRequest class.

For the Web API the RetrieveMissingComponentsResponse ComplexType is the response value from the RetrieveMissingComponents Function.

RetrieveMissingDependenciesRequest

Contains the data that is needed to retrieve any required solution components that are not included in the solution.

For the Web API use the RetrieveMissingDependencies Function.

RetrieveMissingDependenciesResponse

Contains the response from the RetrieveMissingDependenciesRequest class.

RetrieveOrganizationInfoRequest

Contains the data that is needed to retrieve information about an organization such as the instance type and solutions available in the organization.

For the Web API use the RetrieveOrganizationInfo Function.

RetrieveOrganizationInfoResponse

Contains the response from the RetrieveOrganizationInfoRequest class.

For the Web API the RetrieveOrganizationInfoResponse ComplexType is the response value from the RetrieveOrganizationInfo Function.

RetrieveOrganizationResourcesRequest

Contains the data that is needed to retrieve the resources that are used by an organization.

For the Web API use the RetrieveOrganizationResources Function.

RetrieveOrganizationResourcesResponse

Contains the response from the RetrieveOrganizationResourcesRequest class.

For the Web API the RetrieveOrganizationResourcesResponse ComplexType is the response value from the RetrieveOrganizationResources Function.

RetrieveParentGroupsResourceGroupRequest

Contains the data needed to retrieve the collection of the parent resource groups of the specified resource group (scheduling group).

For the Web API use the RetrieveParentGroupsResourceGroup Function.

RetrieveParentGroupsResourceGroupResponse

Contains the response from the RetrieveParentGroupsResourceGroupRequest class.

RetrieveParsedDataImportFileRequest

Contains the data that is needed to retrieve the data from the parse table.

For the Web API use the RetrieveParsedDataImportFile Function.

RetrieveParsedDataImportFileResponse

Contains the response from the RetrieveParsedDataImportFileRequest class.

For the Web API the RetrieveParsedDataImportFileResponse ComplexType is the response value from the RetrieveParsedDataImportFile Function.

RetrievePersonalWallRequest

Contains the data that is needed to retrieve pages of posts, including comments for each post, for all records that the calling user is following.

For the Web API use the RetrievePersonalWall Function.

RetrievePersonalWallResponse

Contains the response from the RetrievePersonalWallRequest class.

RetrievePrincipalAccessInfoRequest
RetrievePrincipalAccessInfoResponse
RetrievePrincipalAccessRequest

Contains the data that is needed to retrieve the access rights of the specified security principal (user, team, or organization) to the specified record.

For the Web API use the RetrievePrincipalAccess Function.

RetrievePrincipalAccessResponse

Contains the response from the RetrievePrincipalAccessRequest class.

RetrievePrincipalAttributePrivilegesRequest

Contains the data that is needed to retrieves all the secured attribute privileges a user or team has through direct or indirect (through team membership) associations with the FieldSecurityProfile entity.

For the Web API use the RetrievePrincipalAttributePrivileges Function.

RetrievePrincipalAttributePrivilegesResponse

Contains the response from the RetrievePrincipalAttributePrivilegesRequest class.

For the Web API the RetrievePrincipalAttributePrivilegesResponse ComplexType is the response value from the RetrievePrincipalAttributePrivileges Function.

RetrievePrincipalSyncAttributeMappingsRequest

For internal use only.

For the Web API use the RetrievePrincipalSyncAttributeMappings Function.

RetrievePrincipalSyncAttributeMappingsResponse

For internal use only.

For the Web API the RetrievePrincipalSyncAttributeMappingsResponse ComplexType is the response value from the RetrievePrincipalSyncAttributeMappings Function.

RetrievePrivilegeSetRequest

Contains the data needed to retrieve the set of privileges defined in the system.

For the Web API use the RetrievePrivilegeSet Function.

RetrievePrivilegeSetResponse

Contains the response from the RetrievePrivilegeSetRequest class.

RetrieveProcessInstancesRequest

Contains the data that is needed to retrieve all the process instances for an entity record across all business process definitions.

For the Web API use the RetrieveProcessInstances Function.

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

RetrieveProcessInstancesResponse

Contains a response from the RetrieveProcessInstancesRequest class.

RetrieveProductPropertiesRequest

Contains data that is needed to retrieve all the property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice.

For the Web API use the RetrieveProductProperties Function.

RetrieveProductPropertiesResponse

Contains the response from the RetrieveProductPropertiesRequest class.

RetrieveProvisionedLanguagePackVersionRequest

Contains the data that is needed to retrieve the version of a provisioned language pack.

For the Web API use the RetrieveProvisionedLanguagePackVersion Function.

RetrieveProvisionedLanguagePackVersionResponse

Contains the response from the RetrieveProvisionedLanguagePackVersionRequest class.

RetrieveProvisionedLanguagesRequest

Contains the data that is needed to retrieve the list of provisioned languages.

For the Web API use the RetrieveProvisionedLanguages Function.

RetrieveProvisionedLanguagesResponse

Contains the response from the RetrieveProvisionedLanguagesRequest class.

RetrieveRecordChangeHistoryRequest

Contains the data that is needed to retrieve all attribute data changes for a specific entity.

RetrieveRecordChangeHistoryResponse

Contains the response from the RetrieveRecordChangeHistoryRequest class.

RetrieveRecordWallRequest

Contains the data that is needed to retrieve pages of posts, including comments for each post, for a specified record.

For the Web API use the RetrieveRecordWall Function.

RetrieveRecordWallResponse

Contains the response from the RetrieveRecordWallRequest class.

RetrieveRequiredComponentsRequest

Contains the data that is needed to retrieve a collection of solution components that are required for a solution component.

For the Web API use the RetrieveRequiredComponents Function.

RetrieveRequiredComponentsResponse

Contains the response from the RetrieveRequiredComponentsRequest class.

RetrieveRolePrivilegesRoleRequest

Contains the data that is needed to retrieve the privileges that are assigned to the specified role.

For the Web API use the RetrieveRolePrivilegesRole Function.

RetrieveRolePrivilegesRoleResponse

Contains the response from the RetrieveRolePrivilegesRoleRequest class.

For the Web API the RetrieveRolePrivilegesRoleResponse ComplexType is the response value from the RetrieveRolePrivilegesRole Function.

RetrieveSharedLinksRequest
RetrieveSharedLinksResponse
RetrieveSharedPrincipalsAndAccessRequest

Contains the data that is needed to retrieve all security principals (users, teams, and organizations) that have access to, and access rights for, the specified record because it was shared with them.

RetrieveSharedPrincipalsAndAccessResponse

Contains the response from the RetrieveSharedPrincipalsAndAccessRequest class.

RetrieveSubGroupsResourceGroupRequest

Contains the data that is needed to retrieve the collection of child resource groups from the specified Scheduling Group (ResourceGroup).

RetrieveSubGroupsResourceGroupResponse

Contains the response from the RetrieveSubGroupsResourceGroupRequest class.

RetrieveSubsidiaryTeamsBusinessUnitRequest

Deprecated. Use the RetrieveMultipleRequest class.

Contains the data needed to retrieve a collection of entity instances based on the specified query criteria.

RetrieveSubsidiaryTeamsBusinessUnitResponse

Deprecated. Use the RetrieveMultipleRequest class and its associated response class.

RetrieveSubsidiaryUsersBusinessUnitRequest

Deprecated. Use the RetrieveMultipleRequest class.

Contains the data needed to retrieve all user information from the child business units of the specified business unit.

RetrieveSubsidiaryUsersBusinessUnitResponse

Deprecated. Use the RetrieveMultipleRequest class and its associated response class.

Contains the response from the RetrieveSubsidiaryUsersBusinessUnitRequest message.

RetrieveTeamPrivilegesRequest

Contains the data that is needed to retrieve the privileges for a team.

RetrieveTeamPrivilegesResponse

Contains the response from the RetrieveTeamPrivilegesRequest class.

RetrieveTeamsSystemUserRequest

Deprecated. Use the RetrieveMultipleRequest class.

Contains the data needed to retrieve the list of teams of which the specified user is a member.

RetrieveTeamsSystemUserResponse

Deprecated. Use the RetrieveMultipleRequest class and its associated response class.

Contains the response from the RetrieveTeamsSystemUserRequest message.

RetrieveTimelineWallRecordsRequest

Contains the data to retrieve all the activity pointer entities along with the parties and attachments as dictated by the FetchXML query.

RetrieveTimelineWallRecordsResponse

Contains the response from processing the RetrieveTimelineWallRecordsRequest message.

RetrieveTotalRecordCountRequest

Contains the data to retrieve the total entity record count from within the last 24 hours.

RetrieveTotalRecordCountResponse

Contains the response from processing the RetrieveTotalRecordCountRequest message.

RetrieveUnpublishedMultipleRequest

Contains the data that is needed to retrieve a collection of unpublished organization-owned records that satisfy the specified query criteria.

RetrieveUnpublishedMultipleResponse

Contains the response from the RetrieveUnpublishedMultipleRequest class.

RetrieveUnpublishedRequest

Contains the data that is needed to retrieve an unpublished record.

RetrieveUnpublishedResponse

Contains the response from the RetrieveUnpublishedRequest class.

RetrieveUserLicenseInfoRequest

Contains the data needed to retrieve the license information for the specified system user (user).

RetrieveUserLicenseInfoResponse

Contains the response from the RetrieveUserLicenseInfoRequest class.

RetrieveUserPrivilegeByPrivilegeIdRequest

Retrieves the list of privileges for a system user (user) from all direct roles associated with the system user and from all indirect roles associated with teams in which the system user is a member of based on the specified privilege ID.

RetrieveUserPrivilegeByPrivilegeIdResponse

Contains the response from the RetrieveUserPrivilegeByPrivilegeIdRequest class.

RetrieveUserPrivilegeByPrivilegeNameRequest

Retrieves the list of privileges for a system user (user) from all direct roles associated with the system user and from all indirect roles associated with teams in which the system user is a member of based on the specified privilege name.

RetrieveUserPrivilegeByPrivilegeNameResponse

Contains the response from the RetrieveUserPrivilegeByPrivilegeNameRequest class.

RetrieveUserPrivilegesRequest

Contains the data needed to retrieve the privileges a system user (user) has through his or her roles in the specified business unit.

RetrieveUserPrivilegesResponse

Contains the response from the RetrieveUserPrivilegesRequest class.

RetrieveUserQueuesRequest

Contains the data needed to retrieve all private queues of a specified user and optionally all public queues.

RetrieveUserQueuesResponse

Contains the response from the RetrieveUserQueuesRequest message.

RetrieveUserSetOfPrivilegesByIdsRequest

Contains the data to retrieve the filtered privileges a system user (user) has through their roles in the specified business unit.

RetrieveUserSetOfPrivilegesByIdsResponse

Contains the response from the RetrieveUserSetOfPrivilegesByIdsRequest class.

RetrieveUserSetOfPrivilegesByNamesRequest

Contains the data to retrieve the filtered privileges a system user (user) has through his or her roles in the specified business unit.

RetrieveUserSetOfPrivilegesByNamesResponse

Contains the response from the RetrieveUserSetOfPrivilegesByNamesRequest class.

RetrieveUserSettingsSystemUserRequest

Deprecated. Use the RetrieveMultipleRequest class.

Contains the data needed to retrieve the user settings for the specified system user (user).

RetrieveUserSettingsSystemUserResponse

Deprecated. Use the RetrieveMultipleRequest class and its associated response class.

RetrieveUsersPrivilegesThroughTeamsRequest

Contains the data to retrieve privileges which the user gets through team memberships.

RetrieveUsersPrivilegesThroughTeamsResponse

Contains the response from processing the RetrieveUsersPrivilegesThroughTeamsRequest message.

RetrieveVersionRequest

Contains the data that is needed to retrieve the Dataverse version number.

RetrieveVersionResponse

Contains the response from the RetrieveVersionRequest class.

RevertProductRequest

Contains the data that is needed to revert changes done to properties of a product family, product, or bundle record, and set it back to its last published (active) state.

RevertProductResponse

Contains the response from the RevertProductRequest class.

ReviseQuoteRequest

Contains the data that is needed to set the state of a quote to Draft.

ReviseQuoteResponse

Contains the response from the ReviseQuoteRequest class.

RevokeAccessRequest

Contains the data that is needed to replace the access rights on the target record for the specified security principal (user, team, or organization).

RevokeAccessResponse

Contains the response from the RevokeAccessRequest class.

RevokeSharedLinkRequest

Contains the data to revoke an existing SharedLink. All users who clicked on the link will lose access.

RevokeSharedLinkResponse

Contains the response from the RevokeSharedLinkRequest class.

RolePrivilege

Contains information about a privilege.

RolePrivilegeAuditDetail

Represents audited changes to the privileges of a security role.

RollupRequest

Contains the data that is needed to retrieve all the entity records that are related to the specified record.

RollupResponse

Contains the response from the RollupRequest class.

RouteToRequest

Contains the data that is needed to route a queue item to a queue, a user, or a team.

RouteToResponse

Contains the response from the RouteToRequest message.

SearchByBodyKbArticleRequest

Contains the data that is needed to search for knowledge base articles that contain the specified body text.

SearchByBodyKbArticleResponse

Contains the response from the SearchByBodyKbArticleRequest class.

SearchByKeywordsKbArticleRequest

Contains the data that is needed to search for knowledge base articles that contain the specified keywords.

SearchByKeywordsKbArticleResponse

Contains the response from the SearchByKeywordsKbArticleRequest class.

SearchByTitleKbArticleRequest

Contains the data that is needed to search for knowledge base articles that contain the specified title.

SearchByTitleKbArticleResponse

Contains the response from the SearchByTitleKbArticleRequest class.

SearchRequest

Contains the data needed to search for available time slots that fulfill the specified appointment request.

SearchResponse

Contains the response from the SearchRequest class.

SearchResults

Contains the results from the SearchRequest message.

SendBulkMailRequest

Contains the data that is needed to send bulk email messages.

SendBulkMailResponse

Contains the response from the SendBulkMailRequest class.

SendEmailFromTemplateRequest

Contains the data that is needed to send an email message using a template.

SendEmailFromTemplateResponse

Contains the response from the SendEmailFromTemplateRequest class.

SendEmailRequest

Contains the data that is needed to send an email message.

SendEmailResponse

Contains the response from the BackgroundSendEmailRequest class.

SendFaxRequest

Contains the data that is needed to send a fax.

SendFaxResponse

Contains the response from the SendFaxRequest class.

SendTemplateRequest

Contains the data that is needed to send a bulk email message that is created from a template.

SendTemplateResponse

Contains the response from the SendTemplateRequest class.

SetAutoNumberSeed1Request

For internal use only.

SetAutoNumberSeed1Response

For internal use only.

SetAutoNumberSeedRequest

Requests the seed number being used for autonumber generation.

SetAutoNumberSeedResponse

There is no return value from this operation.

SetBusinessEquipmentRequest

Deprecated. Contains the data that is needed to assign equipment (facility/equipment) to a specific business unit.

SetBusinessEquipmentResponse

Contains the response from the SetBusinessEquipmentRequest class.

SetBusinessSystemUserRequest

Deprecated. Contains the data that is needed to move a system user (user) to a different business unit.

SetBusinessSystemUserResponse

Contains the response from the SetBusinessSystemUserRequest class.

SetFeatureStatusRequest

For internal use only.

SetFeatureStatusResponse

Contains the response from the SetFeatureStatusRequest class.

SetLocLabelsRequest

Contains the data that is needed to set localized labels for a limited set of entity attributes.

SetLocLabelsResponse

Contains the response from the SetLocLabelsRequest class.

SetParentBusinessUnitRequest

Contains the data that is needed to set the parent business unit for a business unit.

SetParentBusinessUnitResponse

Contains the response from the SetParentBusinessUnitRequest class.

SetParentSystemUserRequest

Deprecated. Contains the data needed to set a new parent system user (user) for the specified user.

SetParentSystemUserResponse

Contains the response from the SetParentSystemUserRequest class.

SetParentTeamRequest

Deprecated. Contains the data needed to set the parent business unit of a team.

SetParentTeamResponse

Contains the response from the SetParentTeamRequest class.

SetProcessRequest

Contains the data that is needed to set another business process flow instance as the active process instance for the target entity.

SetProcessResponse

Contains the response from executing the SetProcessRequest class.

SetRelatedRequest

Contains the data needed to create a relationship between a set of records that participate in specific relationships.

SetRelatedResponse

Contains the response from the SetRelatedRequest class.

SetReportRelatedRequest

Contains the data needed to link an instance of a report entity to related entities.

SetReportRelatedResponse

Contains the response from SetReportRelatedRequest.

SetStateRequest

Deprecated. Contains the data that's needed to set the state of an entity record.

SetStateResponse

Contains the response from the SetStateRequest class.

SettingDetail

Provides information about a setting.

SettingDetailCollection
ShareAuditDetail

Represents a shared audit detail record.

SolutionComponentCountCollection

For internal use only.

SolutionComponentCountInfo

For internal use only.

StageAndUpgradeAsyncRequest
StageAndUpgradeAsyncResponse
StageAndUpgradeRequest

Contains the data to import a solution, stage it for upgrade, and apply the upgrade as the default (when applicable).

StageAndUpgradeResponse

Contains the service response from processing StageAndUpgradeRequest.

StageSolutionRequest

Contains the data needed to stage a solution.

StageSolutionResponse

Contains the service response from processing StageSolutionRequest.

SyncBulkOperationRequest

Contains data to perform bulk operations to cancel, resume, or pause workflows.

SyncBulkOperationResponse

Contains the service response from processing SyncBulkOperationRequest.

TimeInfo

Specifies a set of time blocks with appointment information.

TraceInfo

Specifies the results of a scheduling operation using the ValidateRequest, BookRequest, RescheduleRequest, or SearchRequest messages.

TransformImportRequest

Contains the data that is needed to submit an asynchronous job that transforms the parsed data.

TransformImportResponse

Contains the response from the TransformImportRequest class.

TriggerServiceEndpointCheckRequest

Contains the data that is needed to validate the configuration of a Microsoft Azure Service Bus solution's service endpoint.

TriggerServiceEndpointCheckResponse

Contains the response from the TriggerServiceEndpointCheckRequest.

UninstallSampleDataRequest

Uninstalls the sample data.

UninstallSampleDataResponse

Contains the response from the UninstallSampleDataRequest class.

UninstallSolutionAsyncRequest
UninstallSolutionAsyncResponse
UnlockInvoicePricingRequest

Contains the data that is needed to unlock pricing for an invoice.

UnlockInvoicePricingResponse

Contains the response from the UnlockInvoicePricingRequest class.

UnlockSalesOrderPricingRequest

Contains the data that is needed to unlock pricing for a sales order (order).

UnlockSalesOrderPricingResponse

Contains the response from the UnlockSalesOrderPricingRequest class.

UnpublishDuplicateRuleRequest

Contains the data that is needed to submit an asynchronous job to unpublish a duplicate rule.

UnpublishDuplicateRuleResponse

Contains the response from the UnpublishDuplicateRuleRequest class.

UpdateFeatureConfigRequest

For internal use only.

UpdateFeatureConfigResponse

Contains the response from the UpdateFeatureConfigRequest class.

UpdateProductPropertiesRequest

Contains the data that is needed to update values of the property instances (dynamic property instances) for a product added to an opportunity, quote, order, or invoice.

UpdateProductPropertiesResponse

Contains the response from the UpdateProductPropertiesRequest class.

UpdateRibbonClientMetadataRequest

For internal use only.

UpdateRibbonClientMetadataResponse

Contains the response from the UpdateRibbonClientMetadataRequest class.

UpdateSolutionComponentRequest

Contains the data that is needed to update a component in an unmanaged solution.

UpdateSolutionComponentResponse

Contains the response from executing the UpdateSolutionComponentRequest class.

UpdateUserSettingsSystemUserRequest

Deprecated. Use the UpdateRequest class.

UpdateUserSettingsSystemUserResponse

Deprecated. Use the UpdateRequest class and its associated response class.

UploadBlockRequest

Contains the data needed to upload a block of data to storage.

UploadBlockResponse

Contains the response from the UploadBlockRequest class.

UserAccessAuditDetail

Contains data used for user access auditing.

UserDetails

For internal use only.

UtcTimeFromLocalTimeRequest

Contains the data that is needed to retrieve the Coordinated Universal Time (UTC) for the specified local time.

UtcTimeFromLocalTimeResponse

Contains the response from the UtcTimeFromLocalTimeRequest class.

ValidateAppRequest

Contains the data to validate an App.

ValidateAppResponse

Contains the response from processing the ValidateAppRequest message.

ValidateFetchXmlExpressionRequest
ValidateFetchXmlExpressionResponse
ValidateRecurrenceRuleRequest

Contains the data that is needed to validate a rule for a recurring appointment.

ValidateRecurrenceRuleResponse

Contains the response from the ValidateRecurrenceRuleRequest class.

ValidateRequest

Contains the data that is needed to verify that an appointment or service appointment (service activity) has valid available resources for the activity, duration, and site, as appropriate.

ValidateResponse

Contains the response from the ValidateRequest class.

ValidateSavedQueryRequest

Contains the data that is needed to validate a saved query (view).

ValidateSavedQueryResponse

Contains the response from the ValidateSavedQueryRequest class.

ValidateUnpublishedRequest

Contains the data to validate that a mobile offline profile, including unpublished changes, can be published.

ValidateUnpublishedResponse

Contains the response from the ValidateUnpublishedRequest class.

ValidationIssue
ValidationResult

Contains the result from the ValidateRequest, BookRequest, or RescheduleRequest messages.

WebResourceDetails

For internal use only.

WebResourceInfo

For internal use only.

WebResourceInformation

For internal use only.

WhoAmIRequest

Contains the data that is needed to retrieve the system user ID for the currently logged on user or the user under whose context the code is running.

WhoAmIResponse

Contains the response from the WhoAmIRequest class.

WinOpportunityRequest

Contains the data that is needed to set the state of an opportunity to Won.

WinOpportunityResponse

Contains the response from the WinOpportunityRequest class.

WinQuoteRequest

Contains the data that is needed to set the state of a quote to Won.

WinQuoteResponse

Contains the response from the WinQuoteRequest class.

Interfaces

IAppInformation
IAppModuleDescriptor
IAppModuleDetails
IAppModuleInfo
IAppSettingDetails
ICanvasAppsDetails
ILocalizedLabelDetails
ILocalizedLabelInfo
IUserDetails
IWebResourceDetails

Enums

AccessRights

Contains the possible access rights for a user.

BulkOperationSource

Contains the possible sources of a bulk operation.

BusinessNotificationParameterType

For internal use only.

BusinessNotificationSeverity

For internal use only.

ChannelAccessProfilePrivilegeDepth

For internal use only.

EntitySource

Describes which members of a bulk operation to retrieve.

ErrorType

ExportDynamicToExcelType

For internal use only.

PrivilegeDepth

Contains the possible values for the depth of a privilege within a role. This enumeration is used to compare and set values in records returned from Fetch or QueryExpression queries. If you use LINQ, the privilege depth is returned as a bit mask. In this case you can use the following constants to determine the privilege depth.

public const int BASIC_MASK = 0x00000001; public const int LOCAL_MASK = 0x00000002; public const int DEEP_MASK = 0x00000004; public const int GLOBAL_MASK = 0x00000008;

For the Web API use the PrivilegeDepth EnumType.

PropagationOwnershipOptions

Contains the possible values for propagation ownership options.

For the Web API use the PropagationOwnershipOptions EnumType.

RelationshipType

The type of relationship.

RibbonLocationFilters

Contains the values for ribbon filters for an entity.

RollupType

Contains the possible values for the RollupType property in the RollupRequest class, which you use to retrieve all the entity records for a specified record.

SearchDirection

Contains the possible values for the search direction in an appointment request.

SubCode

Contains the possible values for a subcode, used in scheduling appointments.

TargetFieldType

Indicates the attribute type for the target of the InitializeFromRequest message.

TimeCode

Contains the possible values for a time code, used when querying a schedule.