Del via


Microsoft.Crm.Sdk.Messages Namespace

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Classes

Class Description
System_CAPS_pubclass AddChannelAccessProfilePrivilegesRequest

For internal use only.

System_CAPS_pubclass AddChannelAccessProfilePrivilegesResponse

For internal use only.

System_CAPS_pubclass AddItemCampaignActivityRequest

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

For the Web API use the AddItemCampaignActivity Action.

System_CAPS_pubclass AddItemCampaignActivityResponse

Contains the response from the AddItemCampaignActivityRequest class.

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

System_CAPS_pubclass AddItemCampaignRequest

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

For the Web API use AddItemCampaign Action.

System_CAPS_pubclass AddItemCampaignResponse

Contains the response from the AddItemCampaignRequest class.

System_CAPS_pubclass AddListMembersListRequest

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

For the Web API use the AddListMembersList Action.

System_CAPS_pubclass AddListMembersListResponse

Contains the response from the AddListMembersListRequest class.

System_CAPS_pubclass AddMemberListRequest

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

For the Web API use the AddMemberList Action.

System_CAPS_pubclass AddMemberListResponse

Contains the response from the AddMemberListRequest class.

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

System_CAPS_pubclass AddMembersTeamRequest

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

For the Web API use the AddMembersTeam Action.

System_CAPS_pubclass AddMembersTeamResponse

Contains the response from the AddMembersTeamRequest class.

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

System_CAPS_pubclass AddPrincipalToQueueResponse

Contains the response from the AddPrincipalToQueueRequest message.

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

System_CAPS_pubclass AddPrivilegesRoleResponse

Contains the response from the AddPrivilegesRoleRequest class.

System_CAPS_pubclass AddProductToKitRequest

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

System_CAPS_pubclass AddProductToKitResponse

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

System_CAPS_pubclass AddRecurrenceRequest

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

For the Web API use the AddRecurrence Action.

System_CAPS_pubclass AddRecurrenceResponse

Contains the response from the AddRecurrenceRequest class.

System_CAPS_pubclass AddSolutionComponentRequest

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

For the Web API use the AddSolutionComponent Action.

System_CAPS_pubclass AddSolutionComponentResponse

Contains the response from the AddSolutionComponentRequest message.

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

System_CAPS_pubclass AddSubstituteProductRequest

Deprecated. Use the AssociateRequest class.

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

System_CAPS_pubclass AddSubstituteProductResponse

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

Contains the response from the AddSubstituteProductRequest class.

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

System_CAPS_pubclass AddToQueueResponse

Contains the response from the AddToQueueRequest class.

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

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

System_CAPS_pubclass AddUserToRecordTeamResponse

Contains the response from the AddUserToRecordTeamRequest class.

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

System_CAPS_pubclass AppContext

System_CAPS_pubclass AppEntityInfo

System_CAPS_pubclass AppInfo

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

System_CAPS_pubclass ApplyRecordCreationAndUpdateRuleResponse

Contains the response from the ApplyRecordCreationAndUpdateRuleRequest class.

System_CAPS_pubclass ApplyRoutingRuleRequest

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

For the Web API use the ApplyRoutingRule Action.

System_CAPS_pubclass ApplyRoutingRuleResponse

Contains the response from the ApplyRoutingRuleRequest message.

System_CAPS_pubclass AppModuleCollection

System_CAPS_pubclass AppModuleInfo

System_CAPS_pubclass AppModuleValidationResponse

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

System_CAPS_pubclass AppointmentRequest

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

For the Web API the corresponding type is AppointmentRequest ComplexType.

System_CAPS_pubclass AppointmentsToIgnore

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

For the Web API the corresponding type is AppointmentsToIgnore ComplexType.

System_CAPS_pubclass ArtifactIdType

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

System_CAPS_pubclass AssignResponse

Contains the response from the AssignRequest.

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

System_CAPS_pubclass AssociateEntitiesResponse

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

Contains the response from the AssociateEntitiesRequest class.

System_CAPS_pubclass AttributeAuditDetail

Contains the details of changes to entity attributes.

System_CAPS_pubclass AuditDetail

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

System_CAPS_pubclass AuditDetailCollection

Contains a collection of AuditDetail objects.

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

System_CAPS_pubclass AuditPartitionDetailCollection

Contains a data collection of AuditDetail objects.

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

System_CAPS_pubclass AutoMapEntityResponse

Contains the response from the AutoMapEntityRequest class.

System_CAPS_pubclass BackgroundSendEmailRequest

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

System_CAPS_pubclass BackgroundSendEmailResponse

Contains the response from the BackgroundSendEmailRequest class.

System_CAPS_pubclass 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

System_CAPS_pubclass BookResponse

Contains the response from the BookRequest class.

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

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)

System_CAPS_pubclass BulkDeleteResponse

Contains the response from the BulkDeleteRequest class.

System_CAPS_pubclass 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)

System_CAPS_pubclass BulkDetectDuplicatesResponse

Contains the response from the BulkDetectDuplicatesRequest class.

System_CAPS_pubclass BusinessNotification

For internal use only.

System_CAPS_pubclass BusinessNotificationParameter

For internal use only.

System_CAPS_pubclass BusinessProcessFlowContext

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

System_CAPS_pubclass CalculateActualValueOpportunityResponse

Contains the response from the CalculateActualValueOpportunityRequest class.

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

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

System_CAPS_pubclass CalculatePriceResponse

Contains the response from the CalculatePriceRequest class.

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

System_CAPS_pubclass CalculateRollupFieldResponse

Contains the response from the CalculateRollupFieldRequest class.

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

System_CAPS_pubclass CalculateTotalTimeIncidentResponse

Contains the response from the CalculateTotalTimeIncidentRequest class.

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

System_CAPS_pubclass CancelContractRequest

Contains the data that is needed to cancel a contract.

For the Web API use the CancelContract Action.

System_CAPS_pubclass CancelContractResponse

Contains the response from the CancelContractRequest class.

System_CAPS_pubclass CancelSalesOrderRequest

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

For the Web API use the CancelSalesOrder Action.

System_CAPS_pubclass CancelSalesOrderResponse

Contains the response from the CancelSalesOrderRequest class.

System_CAPS_pubclass ChannelAccessProfilePrivilege

For internal use only.

System_CAPS_pubclass ChannelAccessProfileWithPrivileges

For internal use only.

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

System_CAPS_pubclass CheckIncomingEmailResponse

Contains the response from the CheckIncomingEmailRequest class.

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

System_CAPS_pubclass CheckPromoteEmailResponse

Contains the response from the CheckPromoteEmailRequest class.

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

System_CAPS_pubclass 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

System_CAPS_pubclass CloneAsPatchResponse

Contains the response from executing the CloneAsPatchRequest class.

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

System_CAPS_pubclass 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

System_CAPS_pubclass CloneAsSolutionResponse

Contains the response from executing the CloneAsSolutionRequest class.

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

System_CAPS_pubclass CloneContractRequest

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

For the Web API use the CloneContract Action.

System_CAPS_pubclass CloneContractResponse

Contains the response from the CancelContractRequest class.

System_CAPS_pubclass CloneMobileOfflineProfileRequest

For the Web API use the CloneMobileOfflineProfile Action.

For internal use only.

System_CAPS_pubclass CloneMobileOfflineProfileResponse

For internal use only.

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

System_CAPS_pubclass CloneProductResponse

Contains the response from the CloneProductRequest class.

System_CAPS_pubclass CloseIncidentRequest

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

For the Web API use the CloseIncident Action.

System_CAPS_pubclass CloseIncidentResponse

Contains the response from the CloseIncidentRequest class.

System_CAPS_pubclass CloseQuoteRequest

Contains the data that is needed to close a quote.

For the Web API use the CloseQuote Action.

System_CAPS_pubclass CloseQuoteResponse

Contains the response from the CloseQuoteRequest class.

System_CAPS_pubclass Component

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

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

System_CAPS_pubclass CompoundCreateResponse

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

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

System_CAPS_pubclass CompoundUpdateDuplicateDetectionRuleResponse

Contains the response from the CompoundUpdateDuplicateDetectionRuleRequest class.

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

System_CAPS_pubclass CompoundUpdateResponse

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

Contains the response from the CompoundUpdateRequest class.

System_CAPS_pubclass ConstraintRelation

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

For the Web API the corresponding type is ConstraintRelation ComplexType.

System_CAPS_pubclass ConvertKitToProductRequest

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

System_CAPS_pubclass ConvertKitToProductResponse

Deprecated. Contains the response from the ConvertKitToProductRequest class.

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

System_CAPS_pubclass ConvertOwnerTeamToAccessTeamResponse

Contains the response from the ConvertOwnerTeamToAccessTeamRequest class.

System_CAPS_pubclass ConvertProductToKitRequest

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

For the Web API use the ConvertProductToKit Action.

System_CAPS_pubclass ConvertProductToKitResponse

Deprecated. Contains the response from the ConvertProductToKitRequest class.

System_CAPS_pubclass ConvertQuoteToSalesOrderRequest

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

For the Web API use the ConvertQuoteToSalesOrder Action.

System_CAPS_pubclass ConvertQuoteToSalesOrderResponse

Contains the response from the ConvertQuoteToSalesOrderRequest class.

System_CAPS_pubclass ConvertSalesOrderToInvoiceRequest

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

For the Web API use the ConvertSalesOrderToInvoice Action.

System_CAPS_pubclass ConvertSalesOrderToInvoiceResponse

Contains the response from the ConvertSalesOrderToInvoiceRequest class.

System_CAPS_pubclass CopyCampaignRequest

Contains the data that is needed to copy a campaign.

For the Web API use the CopyCampaign Action.

System_CAPS_pubclass CopyCampaignResponse

Contains the response from the CopyCampaignRequest class.

System_CAPS_pubclass CopyCampaignResponseRequest

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

For the Web API use the CopyCampaignResponse Action.

System_CAPS_pubclass CopyCampaignResponseResponse

Contains the response from the CopyCampaignResponseRequest class.

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

System_CAPS_pubclass CopyDynamicListToStaticResponse

Contains the response from the CopyDynamicListToStaticRequest class.

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

System_CAPS_pubclass CopyMembersListResponse

Contains the response from the CopyMembersListRequest class.

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

System_CAPS_pubclass CopySystemFormResponse

Contains the response from the CopySystemFormRequest class.

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

System_CAPS_pubclass CreateActivitiesListResponse

Contains the response from the CreateActivitiesListRequest class.

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

System_CAPS_pubclass CreateExceptionRequest

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

For the Web API use the CreateException Action.

System_CAPS_pubclass CreateExceptionResponse

Contains the response from the CreateExceptionRequest class.

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

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

System_CAPS_pubclass CreateInstanceResponse

Contains the response from the CreateInstanceRequest class.

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

System_CAPS_pubclass CreateKnowledgeArticleTranslationRequest

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

For the Web API use the CreateKnowledgeArticleTranslation Action.

System_CAPS_pubclass CreateKnowledgeArticleTranslationResponse

Contains the response from the CreateKnowledgeArticleTranslationRequest class.

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

System_CAPS_pubclass CreateKnowledgeArticleVersionResponse

Contains the response from the CreateKnowledgeArticleVersionRequest class.

System_CAPS_pubclass CreateWorkflowFromTemplateRequest

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

For the Web API use the CreateWorkflowFromTemplate Action.

System_CAPS_pubclass CreateWorkflowFromTemplateResponse

Contains the response from the CreateWorkflowFromTemplateRequest class.

System_CAPS_pubclass DeleteAndPromoteRequest

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

System_CAPS_pubclass DeleteAndPromoteResponse

Contains the response from executing the DeleteAndPromoteRequest class.

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

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

System_CAPS_pubclass DeleteAuditDataResponse

Contains the response from the DeleteAuditDataRequest class.

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

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

System_CAPS_pubclass DeleteOpenInstancesResponse

Contains the response from the DeleteOpenInstancesRequest class.

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

System_CAPS_pubclass DeliverIncomingEmailResponse

Contains the response from the DeliverIncomingEmailRequest class.

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

System_CAPS_pubclass DeliverPromoteEmailResponse

Contains the response from the DeliverPromoteEmailRequest class.

System_CAPS_pubclass DeprovisionLanguageRequest

Contains the data that is needed to deprovision a language.

For the Web API use the DeprovisionLanguage Action.

System_CAPS_pubclass DeprovisionLanguageResponse

Contains the response from the DeprovisionLanguageRequest class.

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

System_CAPS_pubclass DisassociateEntitiesResponse

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

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

System_CAPS_pubclass DistributeCampaignActivityResponse

Contains the response from the DistributeCampaignActivityRequest class.

System_CAPS_pubclass DownloadReportDefinitionRequest

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

For the Web API use the DownloadReportDefinition Function.

System_CAPS_pubclass DownloadReportDefinitionResponse

Contains the response from the DownloadReportDefinitionRequest class.

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

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

System_CAPS_pubclass ExecuteByIdSavedQueryRequest

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

System_CAPS_pubclass ExecuteByIdSavedQueryResponse

Contains the response from the ExecuteByIdSavedQueryRequest class.

System_CAPS_pubclass ExecuteByIdUserQueryRequest

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

System_CAPS_pubclass ExecuteByIdUserQueryResponse

Contains the response from the ExecuteByIdUserQueryRequest class.

System_CAPS_pubclass ExecuteFetchRequest

Deprecated. Use the RetrieveMultipleRequest class.

System_CAPS_pubclass ExecuteFetchResponse

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

System_CAPS_pubclass 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) .

System_CAPS_pubclass ExecuteWorkflowResponse

Contains the response from the ExecuteWorkflowResponse class.

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

System_CAPS_pubclass ExpandCalendarResponse

Contains the response from the ExpandCalendarRequest class.

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

System_CAPS_pubclass ExportFieldTranslationRequest

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

For the Web API use ExportFieldTranslation Function.

System_CAPS_pubclass ExportFieldTranslationResponse

Contains the response from the ExportFieldTranslationRequest class.

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

System_CAPS_pubclass ExportMappingsImportMapRequest

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

System_CAPS_pubclass ExportMappingsImportMapResponse

Contains the response from the ExportMappingsImportMapRequest class.

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

System_CAPS_pubclass ExportSolutionRequest

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

For the Web API use the ExportSolution Action.

System_CAPS_pubclass ExportSolutionResponse

Contains the response from the ExportSolutionRequest class.

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

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

System_CAPS_pubclass ExportTranslationResponse

Contains the response from the ExportTranslationRequest class.

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

System_CAPS_pubclass 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) .

System_CAPS_pubclass FetchXmlToQueryExpressionResponse

Contains the response from the FetchXmlToQueryExpressionRequest class.

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

System_CAPS_pubclass FindParentResourceGroupResponse

Contains the response from the FindParentResourceGroupRequest class.

System_CAPS_pubclass FulfillSalesOrderRequest

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

For the Web API use the FulfillSalesOrder Action.

System_CAPS_pubclass FulfillSalesOrderResponse

Contains the response from the FulfillSalesOrderRequest class.

System_CAPS_pubclass 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) .

System_CAPS_pubclass FullTextSearchKnowledgeArticleResponse

Contains the response from the FullTextSearchKnowledgeArticleRequest class.

System_CAPS_pubclass GenerateInvoiceFromOpportunityRequest

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

For the Web API use the GenerateInvoiceFromOpportunity Action.

System_CAPS_pubclass GenerateInvoiceFromOpportunityResponse

Contains the response from the GenerateInvoiceFromOpportunityRequest class.

System_CAPS_pubclass GenerateQuoteFromOpportunityRequest

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

For the Web API use the GenerateQuoteFromOpportunity Action.

System_CAPS_pubclass GenerateQuoteFromOpportunityResponse

Contains the response from the GenerateQuoteFromOpportunityRequest class.

System_CAPS_pubclass GenerateSalesOrderFromOpportunityRequest

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

For the Web API use the GenerateSalesOrderFromOpportunity Action.

System_CAPS_pubclass GenerateSalesOrderFromOpportunityResponse

Contains the response from the GenerateSalesOrderFromOpportunityRequest class.

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

System_CAPS_pubclass GenerateSocialProfileResponse

Contains the response from the GenerateSocialProfileRequest message.

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

System_CAPS_pubclass GetAllTimeZonesWithDisplayNameResponse

Contains the response from the GetAllTimeZonesWithDisplayNameRequest class.

System_CAPS_pubclass GetDecryptionKeyRequest

For internal use only. See RetrieveDataEncryptionKeyRequest.

System_CAPS_pubclass GetDecryptionKeyResponse

For internal use only.

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

System_CAPS_pubclass GetDefaultPriceLevelResponse

Contains the response from the GetDefaultPriceLevelRequest class.

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

System_CAPS_pubclass GetDistinctValuesImportFileResponse

Contains the response from the GetDistinctValuesImportFileRequest class.

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

System_CAPS_pubclass GetHeaderColumnsImportFileResponse

Contains the response from the GetHeaderColumnsImportFileRequest class.

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

System_CAPS_pubclass GetInvoiceProductsFromOpportunityResponse

Contains the response from the GetInvoiceProductsFromOpportunityRequest class.

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

System_CAPS_pubclass GetQuantityDecimalResponse

Contains the response from the GetQuantityDecimalRequest class.

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

System_CAPS_pubclass GetQuoteProductsFromOpportunityResponse

Contains the response from the GetQuoteProductsFromOpportunityRequest class.

System_CAPS_pubclass GetReportHistoryLimitRequest

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

For the Web API use the GetReportHistoryLimit Function.

System_CAPS_pubclass GetReportHistoryLimitResponse

Contains the response from the GetReportHistoryLimitRequest class.

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

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

System_CAPS_pubclass GetSalesOrderProductsFromOpportunityResponse

Contains the response from the GetSalesOrderProductsFromOpportunityRequest class.

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

System_CAPS_pubclass GetTimeZoneCodeByLocalizedNameResponse

Contains the response from the GetTimeZoneCodeByLocalizedNameRequest class.

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

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

System_CAPS_pubclass GetTrackingTokenEmailResponse

Contains the response from the GetTrackingTokenEmailRequest class.

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

System_CAPS_pubclass GrantAccessRequest

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

System_CAPS_pubclass GrantAccessResponse

Contains the response from the GrantAccessRequest class.

System_CAPS_pubclass ImportFieldTranslationRequest

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

For the Web API use the ImportFieldTranslation Action.

System_CAPS_pubclass ImportFieldTranslationResponse

Contains the response from the ImportFieldTranslationRequest class.

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

System_CAPS_pubclass ImportMappingsImportMapResponse

Contains the response from the ImportMappingsImportMapRequest class.

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

System_CAPS_pubclass ImportRecordsImportResponse

Contains the response from the ImportRecordsImportRequest class.

System_CAPS_pubclass ImportSolutionRequest

Contains the data that is needed to import a solution.

For the Web API use the ImportSolution Action.

System_CAPS_pubclass ImportSolutionResponse

Contains the response from the ImportSolutionRequest class.

System_CAPS_pubclass ImportTranslationRequest

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

For the Web API use the ImportTranslation Action.

System_CAPS_pubclass ImportTranslationResponse

Contains the response from the ImportTranslationRequest class.

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

System_CAPS_pubclass IncrementKnowledgeArticleViewCountResponse

Contains the response from the IncrementKnowledgeArticleViewCountRequest class.

System_CAPS_pubclass InitializeFromRequest

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

For the Web API use the InitializeFrom Function.

System_CAPS_pubclass InitializeFromResponse

Contains the response from the InitializeFromRequest class.

System_CAPS_pubclass InputArgument

Contains custom application data.

System_CAPS_pubclass InputArgumentCollection

Contains a collection of InputArgument objects.

System_CAPS_pubclass InstallSampleDataRequest

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

For the Web API use the InstallSampleData Action.

System_CAPS_pubclass InstallSampleDataResponse

Contains the response from the InstallSampleDataRequest class.

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

System_CAPS_pubclass InstantiateFiltersResponse

Contains the response from the InstantiateFiltersRequest class.

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

System_CAPS_pubclass InstantiateTemplateResponse

Contains the response from the InstantiateTemplateRequest class.

System_CAPS_pubclass IsBackOfficeInstalledRequest

Deprecated. Checks whether Microsoft Dynamics GP 9.0 is installed.

System_CAPS_pubclass IsBackOfficeInstalledResponse

Deprecated.

System_CAPS_pubclass IsComponentCustomizableRequest

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

For the Web API use the IsComponentCustomizable Function.

System_CAPS_pubclass IsComponentCustomizableResponse

Contains the response from the IsComponentCustomizableRequest class.

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

System_CAPS_pubclass IsValidStateTransitionRequest

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

For the Web API use the IsValidStateTransition Function.

System_CAPS_pubclass IsValidStateTransitionResponse

Contains the response from the IsValidStateTransitionRequest class.

System_CAPS_pubclass LocalTimeFromUtcTimeRequest

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

System_CAPS_pubclass LocalTimeFromUtcTimeResponse

Contains the response from the LocalTimeFromUtcTimeRequest class.

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

System_CAPS_pubclass LockInvoicePricingResponse

Contains the response from the LockInvoicePricingRequest class.

System_CAPS_pubclass LockSalesOrderPricingRequest

Contains the data that is needed to lock the total price of products and services that are specified in the sales order (order).

For the Web API use the LockSalesOrderPricing Action.

System_CAPS_pubclass LockSalesOrderPricingResponse

Contains the response from the LockSalesOrderPricingRequest class.

System_CAPS_pubclass LoseOpportunityRequest

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

For the Web API use the LoseOpportunity Action.

System_CAPS_pubclass LoseOpportunityResponse

Contains the response from the LoseOpportunityRequest class.

System_CAPS_pubclass MakeAvailableToOrganizationReportRequest

Deprecated. Use the UpdateRequest class.

System_CAPS_pubclass MakeAvailableToOrganizationReportResponse

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

System_CAPS_pubclass MakeAvailableToOrganizationTemplateRequest

Deprecated. Use the UpdateRequest class.

System_CAPS_pubclass MakeAvailableToOrganizationTemplateResponse

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

System_CAPS_pubclass MakeUnavailableToOrganizationReportRequest

Deprecated. Use the UpdateRequest class.

System_CAPS_pubclass MakeUnavailableToOrganizationReportResponse

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

System_CAPS_pubclass MakeUnavailableToOrganizationTemplateRequest

Deprecated. Use the UpdateRequest class.

System_CAPS_pubclass MakeUnavailableToOrganizationTemplateResponse

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

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

System_CAPS_pubclass MergeResponse

Contains the response from the MergeRequest class.

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

System_CAPS_pubclass ModifyAccessRequest

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

System_CAPS_pubclass ModifyAccessResponse

Contains the response from the ModifyAccessRequest class.

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

System_CAPS_pubclass OrganizationResources

Contains data regarding the resources used by an organization.

For the Web API the corresponding type is OrganizationResources ComplexType.

System_CAPS_pubclass 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).

System_CAPS_pubclass ParseImportResponse

Contains the response from the ParseImportRequest class.

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

System_CAPS_pubclass PickFromQueueResponse

Contains the response from the PickFromQueueRequest message.

System_CAPS_pubclass PrincipalAccess

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

System_CAPS_pubclass ProcessInboundEmailRequest

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

For the Web API use the ProcessInboundEmail Action.

System_CAPS_pubclass ProcessInboundEmailResponse

Contains the response from the ProcessInboundEmailRequest class.

System_CAPS_pubclass 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) .

System_CAPS_pubclass PropagateByExpressionResponse

Contains the response from the PropagateByExpressionRequest class.

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

System_CAPS_pubclass ProvisionLanguageRequest

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

For the Web API use the ProvisionLanguage Action.

System_CAPS_pubclass ProvisionLanguageResponse

Contains the response from the ProvisionLanguageRequest class.

System_CAPS_pubclass PublishAllXmlRequest

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

For the Web API use the PublishAllXml Action.

System_CAPS_pubclass PublishAllXmlResponse

Contains the response from the PublishAllXmlRequest class.

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

System_CAPS_pubclass PublishDuplicateRuleResponse

Contains the response from the PublishDuplicateRuleRequest class.

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

System_CAPS_pubclass PublishProductHierarchyResponse

Contains the response from the PublishProductHierarchyRequest class.

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

System_CAPS_pubclass PublishThemeResponse

Contains the response from the PublishThemeRequest class.

System_CAPS_pubclass PublishXmlRequest

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

For the Web API use the PublishXml Action.

System_CAPS_pubclass PublishXmlResponse

Contains the response from the PublishXmlRequest class.

System_CAPS_pubclass 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) .

System_CAPS_pubclass QualifyLeadResponse

Contains the response from the QualifyLeadRequest class.

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

System_CAPS_pubclass QualifyMemberListResponse

Contains the response from the QualifyMemberListRequest class.

System_CAPS_pubclass 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) .

System_CAPS_pubclass QueryExpressionToFetchXmlResponse

Contains the response from the QueryExpressionToFetchXmlRequest class.

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

System_CAPS_pubclass QueryMultipleSchedulesResponse

Contains the response from the QueryMultipleSchedulesRequest class.

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

System_CAPS_pubclass QueryScheduleResponse

Contains response from QueryScheduleRequest.

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

System_CAPS_pubclass ReassignObjectsOwnerRequest

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

For the Web API use the ReassignObjectsOwner Action.

System_CAPS_pubclass ReassignObjectsOwnerResponse

Contains the response from the ReassignObjectsOwnerRequest class.

System_CAPS_pubclass ReassignObjectsSystemUserRequest

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

For the Web API use the ReassignObjectsSystemUser Action.

System_CAPS_pubclass ReassignObjectsSystemUserResponse

Contains the response from the ReassignObjectsSystemUserRequest class.

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

System_CAPS_pubclass RecalculateResponse

Contains the response from the RecalculateRequest.

System_CAPS_pubclass RelationshipAuditDetail

Contains the audited details of a change in a relationship.

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

System_CAPS_pubclass ReleaseToQueueResponse

Contains the response from the ReleaseToQueueRequest message.

System_CAPS_pubclass RemoveFromQueueRequest

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

For the Web API use the RemoveFromQueue Action.

System_CAPS_pubclass RemoveFromQueueResponse

Contains the response from the RemoveFromQueueRequest message.

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

System_CAPS_pubclass RemoveItemCampaignActivityResponse

Contains the response from the RemoveItemCampaignActivityRequest class.

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

System_CAPS_pubclass RemoveItemCampaignResponse

Contains the response from the RemoveItemCampaignRequest class.

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

System_CAPS_pubclass RemoveMemberListResponse

Contains the response from the RemoveMemberListRequest class.

System_CAPS_pubclass RemoveMembersTeamRequest

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

For the Web API use the RemoveMembersTeam Action.

System_CAPS_pubclass RemoveMembersTeamResponse

Contains the response from the RemoveMembersTeamRequest class.

System_CAPS_pubclass 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

System_CAPS_pubclass RemoveParentResponse

Contains the response from the RemoveParentRequest class.

System_CAPS_pubclass RemovePrivilegeRoleRequest

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

For the Web API use the RemovePrivilegeRole Action.

System_CAPS_pubclass RemovePrivilegeRoleResponse

Contains the response from the RemovePrivilegeRoleRequest class.

System_CAPS_pubclass RemoveProductFromKitRequest

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

System_CAPS_pubclass RemoveProductFromKitResponse

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

System_CAPS_pubclass RemoveRelatedRequest

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

System_CAPS_pubclass RemoveRelatedResponse

Contains the response from the RemoveRelatedRequest class.

System_CAPS_pubclass RemoveSolutionComponentRequest

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

For the Web API use the RemoveSolutionComponent Action.

System_CAPS_pubclass RemoveSolutionComponentResponse

Contains the response from the RemoveSolutionComponentRequest class.

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

System_CAPS_pubclass RemoveSubstituteProductRequest

Deprecated. Use the ProductSubstitute entity.

System_CAPS_pubclass RemoveSubstituteProductResponse

Deprecated. Use the ProductSubstitute entity.

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

System_CAPS_pubclass RemoveUserFromRecordTeamResponse

Contains the response from the RemoveUserFromRecordTeamRequest class.

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

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

System_CAPS_pubclass RenewContractResponse

Contains the response from the RenewContractRequest class.

System_CAPS_pubclass RenewEntitlementRequest

Contains the data that is needed to renew an entitlement.

For the Web API use the RenewEntitlement Action.

System_CAPS_pubclass RenewEntitlementResponse

Contains the response from the RenewEntitlementRequest message.

System_CAPS_pubclass ReplacePrivilegesRoleRequest

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

For the Web API use the ReplacePrivilegesRole Action.

System_CAPS_pubclass ReplacePrivilegesRoleResponse

Contains the response from the ReplacePrivilegesRoleRequest class.

System_CAPS_pubclass RequiredResource

Specifies a resource that is required for a scheduling operation.

For the Web API the corresponding type is RequiredResource ComplexType.

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

System_CAPS_pubclass RescheduleResponse

Contains the response from the RescheduleRequest class.

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

System_CAPS_pubclass ResetUserFiltersResponse

Contains the response from the ResetUserFiltersRequest class.

System_CAPS_pubclass ResourceInfo

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

For the Web API the corresponding type is ResourceInfo ComplexType.

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

System_CAPS_pubclass RetrieveAbsoluteAndSiteCollectionUrlResponse

Contains the response from the RetrieveAbsoluteAndSiteCollectionUrlRequest class.

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

System_CAPS_pubclass 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) .

System_CAPS_pubclass RetrieveActivePathResponse

Contains a response from the RetrieveActivePathRequest class.

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

System_CAPS_pubclass RetrieveAllChildUsersSystemUserResponse

Contains the response from the RetrieveAllChildUsersSystemUserRequest class.

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

System_CAPS_pubclass RetrieveApplicationRibbonResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveApplicationRibbonRequest class.

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

System_CAPS_pubclass RetrieveAttributeChangeHistoryRequest

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

System_CAPS_pubclass RetrieveAttributeChangeHistoryResponse

Contains the response from the RetrieveAttributeChangeHistoryRequest class.

System_CAPS_pubclass RetrieveAuditDetailsRequest

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

System_CAPS_pubclass RetrieveAuditDetailsResponse

Contains the response from the RetrieveAuditDetailsRequest class.

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

System_CAPS_pubclass RetrieveAuditPartitionListResponse

Contains the response from the RetrieveAuditPartitionListRequest class.

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

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

System_CAPS_pubclass RetrieveAvailableLanguagesResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveAvailableLanguagesRequest class.

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

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

System_CAPS_pubclass RetrieveBusinessHierarchyBusinessUnitResponse

Contains the response from the RetrieveBusinessHierarchyBusinessUnitRequest class.

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

System_CAPS_pubclass RetrieveByGroupResourceResponse

Contains the response from the RetrieveByGroupResourceRequest class.

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

System_CAPS_pubclass RetrieveByResourceResourceGroupResponse

Contains the response from the RetrieveByResourceResourceGroupRequest class.

System_CAPS_pubclass 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) .

System_CAPS_pubclass RetrieveByResourcesServiceResponse

Contains the response from the RetrieveByResourcesServiceRequest class.

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

System_CAPS_pubclass RetrieveByTopIncidentProductKbArticleResponse

Contains the response from the RetrieveByTopIncidentProductKbArticleRequest class.

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

System_CAPS_pubclass RetrieveByTopIncidentSubjectKbArticleResponse

Contains the response from the RetrieveByTopIncidentSubjectKbArticleRequest class.

System_CAPS_pubclass RetrieveChannelAccessProfilePrivilegesRequest

For internal use only.

System_CAPS_pubclass RetrieveChannelAccessProfilePrivilegesResponse

For internal use only.

System_CAPS_pubclass RetrieveCurrentOrganizationRequest

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

For the Web API use the RetrieveCurrentOrganization Function.

System_CAPS_pubclass RetrieveCurrentOrganizationResponse

Contains the response from processing RetrieveCurrentOrganizationRequest.

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

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

System_CAPS_pubclass RetrieveDependenciesForDeleteResponse

Contains the response from the RetrieveDependenciesForDeleteRequest class.

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

System_CAPS_pubclass RetrieveDependenciesForUninstallResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveDependenciesForUninstallRequest class.

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

System_CAPS_pubclass RetrieveDependentComponentsResponse

Contains the response from the RetrieveDependentComponentsRequest class.

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

System_CAPS_pubclass RetrieveDeploymentLicenseTypeResponse

Contains the response from the RetrieveDeploymentLicenseTypeRequest class.

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

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

System_CAPS_pubclass RetrieveDeprovisionedLanguagesResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveDeprovisionedLanguagesRequest class.

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

System_CAPS_pubclass RetrieveDuplicatesRequest

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

For the Web API use the RetrieveDuplicates Function.

System_CAPS_pubclass RetrieveDuplicatesResponse

Contains the response from the RetrieveDuplicatesRequest class.

System_CAPS_pubclass RetrieveEntityRibbonRequest

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

For the Web API use the RetrieveEntityRibbon Function.

System_CAPS_pubclass RetrieveEntityRibbonResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveEntityRibbonRequest class.

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

System_CAPS_pubclass 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) .

System_CAPS_pubclass RetrieveExchangeAppointmentsResponse

System_CAPS_pubclass RetrieveExchangeRateRequest

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

For the Web API use the RetrieveExchangeRate Function.

System_CAPS_pubclass RetrieveExchangeRateResponse

Contains the response from the RetrieveExchangeRateRequest class.

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

System_CAPS_pubclass 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) .

System_CAPS_pubclass RetrieveFilteredFormsResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveFilteredFormsRequest class.

System_CAPS_pubclass RetrieveFormattedImportJobResultsRequest

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

For the Web API use the RetrieveFormattedImportJobResults Function.

System_CAPS_pubclass RetrieveFormattedImportJobResultsResponse

Contains the response from the RetrieveFormattedImportJobResultsRequest class.

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

System_CAPS_pubclass RetrieveFormXmlRequest

For internal use only.

System_CAPS_pubclass RetrieveFormXmlResponse

For internal use only.

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

System_CAPS_pubclass RetrieveInstalledLanguagePacksResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveInstalledLanguagePacksRequest class.

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

System_CAPS_pubclass RetrieveInstalledLanguagePackVersionRequest

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

For the Web API use the RetrieveLicenseInfo Function.

System_CAPS_pubclass RetrieveInstalledLanguagePackVersionResponse

Contains the response from the RetrieveInstalledLanguagePackVersionRequest class.

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

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

System_CAPS_pubclass RetrieveLicenseInfoResponse

Contains the response from the RetrieveLicenseInfoRequest class.

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

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

System_CAPS_pubclass RetrieveLocLabelsResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveLocLabelsRequest class.

System_CAPS_pubclass RetrieveMailboxTrackingFoldersRequest

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

For the Web API use the RetrieveMailboxTrackingFolders Function.

System_CAPS_pubclass RetrieveMailboxTrackingFoldersResponse

Contains the response from the RetrieveMailboxTrackingFoldersRequest class.

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

System_CAPS_pubclass RetrieveMembersBulkOperationRequest

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

For the Web API use the RetrieveMembersBulkOperation Function.

System_CAPS_pubclass RetrieveMembersBulkOperationResponse

Contains the response from the RetrieveMembersBulkOperationRequest class.

System_CAPS_pubclass RetrieveMembersTeamRequest

Deprecated. Use the RetrieveMultipleRequest class.

System_CAPS_pubclass RetrieveMembersTeamResponse

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

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

System_CAPS_pubclass RetrieveMissingComponentsResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveMissingComponentsRequest class.

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

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

System_CAPS_pubclass RetrieveMissingDependenciesResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveMissingDependenciesRequest class.

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

System_CAPS_pubclass RetrieveOrganizationResourcesResponse

Contains the response from the RetrieveOrganizationResourcesRequest class.

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

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

System_CAPS_pubclass RetrieveParentGroupsResourceGroupResponse

Contains the response from the RetrieveParentGroupsResourceGroupRequest class.

System_CAPS_pubclass RetrieveParsedDataImportFileRequest

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

For the Web API use the RetrieveParsedDataImportFile Function.

System_CAPS_pubclass RetrieveParsedDataImportFileResponse

Contains the response from the RetrieveParsedDataImportFileRequest class.

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

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

System_CAPS_pubclass RetrievePersonalWallResponse

Contains the response from the RetrievePersonalWallRequest class.

System_CAPS_pubclass RetrievePrincipalAccessRequest

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

For the Web API use the RetrievePrincipalAccess Function.

System_CAPS_pubclass RetrievePrincipalAccessResponse

Contains the response from the RetrievePrincipalAccessRequest class.

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

System_CAPS_pubclass RetrievePrincipalAttributePrivilegesResponse

Contains the response from the RetrievePrincipalAttributePrivilegesRequest class.

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

System_CAPS_pubclass RetrievePrincipalSyncAttributeMappingsRequest

For internal use only.

For the Web API use the RetrievePrincipalSyncAttributeMappings Function.

System_CAPS_pubclass RetrievePrincipalSyncAttributeMappingsResponse

For internal use only.

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

System_CAPS_pubclass RetrievePrivilegeSetRequest

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

For the Web API use the RetrievePrivilegeSet Function.

System_CAPS_pubclass RetrievePrivilegeSetResponse

Contains the response from the RetrievePrivilegeSetRequest class.

System_CAPS_pubclass 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) .

System_CAPS_pubclass RetrieveProcessInstancesResponse

Contains a response from the RetrieveProcessInstancesRequest class.

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

System_CAPS_pubclass RetrieveProductPropertiesResponse

Contains the response from the RetrieveProductPropertiesRequest class.

System_CAPS_pubclass RetrieveProvisionedLanguagePackVersionRequest

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

For the Web API use the RetrieveProvisionedLanguagePackVersion Function.

System_CAPS_pubclass RetrieveProvisionedLanguagePackVersionResponse

Contains the response from the RetrieveProvisionedLanguagePackVersionRequest class.

System_CAPS_pubclass RetrieveProvisionedLanguagesRequest

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

For the Web API use the RetrieveProvisionedLanguages Function.

System_CAPS_pubclass RetrieveProvisionedLanguagesResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveProvisionedLanguagesRequest class.

System_CAPS_pubclass RetrieveRecordChangeHistoryRequest

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

System_CAPS_pubclass RetrieveRecordChangeHistoryResponse

Contains the response from the RetrieveRecordChangeHistoryRequest class.

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

System_CAPS_pubclass RetrieveRecordWallResponse

Contains the response from the RetrieveRecordWallRequest class.

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

System_CAPS_pubclass RetrieveRequiredComponentsResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveRequiredComponentsRequest class.

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

System_CAPS_pubclass RetrieveRolePrivilegesRoleResponse

Contains the response from the RetrieveRolePrivilegesRoleRequest class.

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

System_CAPS_pubclass RetrieveSharedPrincipalsAndAccessRequest

Contains the data that is needed to retrieve all security principals (users or teams) that have access to, and access rights for, the specified record.

System_CAPS_pubclass RetrieveSharedPrincipalsAndAccessResponse

Contains the response from the RetrieveSharedPrincipalsAndAccessRequest class.

System_CAPS_pubclass RetrieveSubGroupsResourceGroupRequest

Contains the data that is needed to retrieve the collection of child resource groups from the specified resource group (scheduling group).

For the Web API use the RetrieveSubGroupsResourceGroup Function.

System_CAPS_pubclass RetrieveSubGroupsResourceGroupResponse

Contains the response from the RetrieveSubGroupsResourceGroupRequest class.

System_CAPS_pubclass RetrieveSubsidiaryTeamsBusinessUnitRequest

Deprecated. Use the RetrieveMultipleRequest class.

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

System_CAPS_pubclass RetrieveSubsidiaryTeamsBusinessUnitResponse

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

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

System_CAPS_pubclass RetrieveSubsidiaryUsersBusinessUnitResponse

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

Contains the response from the RetrieveSubsidiaryUsersBusinessUnitRequest message.

System_CAPS_pubclass RetrieveTeamPrivilegesRequest

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

For the Web API use the RetrieveTeamPrivileges Function.

System_CAPS_pubclass RetrieveTeamPrivilegesResponse

Contains the response from the RetrieveTeamPrivilegesRequest class.

For the Web API the RetrieveTeamPrivilegesResponse ComplexType is the response value from the RetrieveTeamPrivileges Function.

System_CAPS_pubclass RetrieveTeamsSystemUserRequest

Deprecated. Use the RetrieveMultipleRequest class.

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

System_CAPS_pubclass RetrieveTeamsSystemUserResponse

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

Contains the response from the RetrieveTeamsSystemUserRequest message.

System_CAPS_pubclass RetrieveUnpublishedMultipleRequest

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

For the Web API use the RetrieveUnpublishedMultiple Function.

System_CAPS_pubclass RetrieveUnpublishedMultipleResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveUnpublishedMultipleRequest class.

System_CAPS_pubclass RetrieveUnpublishedRequest

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

System_CAPS_pubclass RetrieveUnpublishedResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.RetrieveUnpublishedRequest class.

System_CAPS_pubclass RetrieveUserPrivilegesRequest

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

For the Web API use the RetrieveUserPrivileges Function.

System_CAPS_pubclass RetrieveUserPrivilegesResponse

Contains the response from the RetrieveUserPrivilegesRequest class.

For the Web API the RetrieveUserPrivilegesResponse ComplexType is the response value from the RetrieveUserPrivileges Function.

System_CAPS_pubclass RetrieveUserQueuesRequest

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

For the Web API use the RetrieveUserQueues Function.

System_CAPS_pubclass RetrieveUserQueuesResponse

Contains the response from the RetrieveUserQueuesRequest message.

System_CAPS_pubclass RetrieveUserSettingsSystemUserRequest

Deprecated. Use the RetrieveMultipleRequest class.

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

System_CAPS_pubclass RetrieveUserSettingsSystemUserResponse

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

System_CAPS_pubclass RetrieveVersionRequest

Contains the data that is needed to retrieve the version number of the Microsoft Dynamics 365 Server.

For the Web API use the RetrieveVersion Function.

System_CAPS_pubclass RetrieveVersionResponse

Contains the response from the RetrieveVersionRequest class.

For the Web API the RetrieveVersionResponse ComplexType is the response value from the RetrieveVersion Function.

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

For the Web API use the RevertProduct Action.

System_CAPS_pubclass RevertProductResponse

Contains the response from the RevertProductRequest class.

System_CAPS_pubclass ReviseQuoteRequest

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

For the Web API use the ReviseQuote Action.

System_CAPS_pubclass ReviseQuoteResponse

Contains the response from the ReviseQuoteRequest class.

System_CAPS_pubclass RevokeAccessRequest

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

For the Web API use the RevokeAccess Action.

System_CAPS_pubclass RevokeAccessResponse

Contains the response from the RevokeAccessRequest class.

System_CAPS_pubclass RolePrivilege

Contains information about a privilege.

For the Web API the corresponding type is RolePrivilege ComplexType.

System_CAPS_pubclass RolePrivilegeAuditDetail

Represents audited changes to the privileges of a security role.

System_CAPS_pubclass RollupRequest

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

For the Web API use the Rollup 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) .

System_CAPS_pubclass RollupResponse

Contains the response from the RollupRequest class.

System_CAPS_pubclass RouteToRequest

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

For the Web API use the RouteTo Action.

System_CAPS_pubclass RouteToResponse

Contains the response from the RouteToRequest message.

System_CAPS_pubclass SearchByBodyKbArticleRequest

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

For the Web API use the SearchByBodyKbArticle Function.

System_CAPS_pubclass SearchByBodyKbArticleResponse

Contains the response from the SearchByBodyKbArticleRequest class.

System_CAPS_pubclass SearchByKeywordsKbArticleRequest

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

For the Web API use the SearchByKeywordsKbArticle Function.

System_CAPS_pubclass SearchByKeywordsKbArticleResponse

Contains the response from the SearchByKeywordsKbArticleRequest class.

System_CAPS_pubclass SearchByTitleKbArticleRequest

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

For the Web API use the SearchByTitleKbArticle Function.

System_CAPS_pubclass SearchByTitleKbArticleResponse

Contains the response from the SearchByTitleKbArticleRequest class.

System_CAPS_pubclass SearchRequest

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

For the Web API use the Search Function.

System_CAPS_pubclass SearchResponse

Contains the response from the SearchRequest class.

For the Web API the SearchResponse ComplexType is the response value from the Search Function.

System_CAPS_pubclass SearchResults

Contains the results from the SearchRequest message.

For the Web API the corresponding type is SearchResults ComplexType.

System_CAPS_pubclass SendBulkMailRequest

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

For the Web API use the SendBulkMail 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) .

System_CAPS_pubclass SendBulkMailResponse

Contains the response from the SendBulkMailRequest class.

System_CAPS_pubclass SendEmailFromTemplateRequest

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

For the Web API use the SendEmailFromTemplate Action.

System_CAPS_pubclass SendEmailFromTemplateResponse

Contains the response from the SendEmailFromTemplateRequest class.

System_CAPS_pubclass SendEmailRequest

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

For the Web API use the SendEmail Action.

System_CAPS_pubclass SendEmailResponse

Contains the response from the BackgroundSendEmailRequest class.

For the Web API the SendEmailResponse ComplexType is the response value from the SendEmail Action.

System_CAPS_pubclass SendFaxRequest

Contains the data that is needed to send a fax.

For the Web API use the SendFax Action.

System_CAPS_pubclass SendFaxResponse

Contains the response from the SendFaxRequest class.

System_CAPS_pubclass SendTemplateRequest

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

For the Web API use the SendTemplate Action.

System_CAPS_pubclass SendTemplateResponse

Contains the response from the SendTemplateRequest class.

System_CAPS_pubclass SetBusinessEquipmentRequest

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

For the Web API use the SetBusinessEquipment Action.

System_CAPS_pubclass SetBusinessEquipmentResponse

Contains the response from the SetBusinessEquipmentRequest class.

System_CAPS_pubclass SetBusinessSystemUserRequest

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

For the Web API use the SetBusinessSystemUser Action.

System_CAPS_pubclass SetBusinessSystemUserResponse

Contains the response from the SetBusinessSystemUserRequest class.

System_CAPS_pubclass SetFeatureStatusRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

For the Web API use the SetFeatureStatus 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) .

System_CAPS_pubclass SetFeatureStatusResponse

This API supports the product infrastructure and is not intended to be used directly from your code.

System_CAPS_pubclass SetLocLabelsRequest

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

For the Web API use the SetLocLabels Action.

System_CAPS_pubclass SetLocLabelsResponse

Contains the response from the T:Microsoft.crm.Sdk.Messages.SetLocLabelsRequest class.

System_CAPS_pubclass SetParentBusinessUnitRequest

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

System_CAPS_pubclass SetParentBusinessUnitResponse

Contains the response from the SetParentBusinessUnitRequest class.

System_CAPS_pubclass SetParentSystemUserRequest

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

System_CAPS_pubclass SetParentSystemUserResponse

Contains the response from the SetParentSystemUserRequest class.

System_CAPS_pubclass SetParentTeamRequest

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

System_CAPS_pubclass SetParentTeamResponse

Contains the response from the SetParentTeamRequest class.

System_CAPS_pubclass SetProcessRequest

Contains the data that is needed to set another business process flow instance as the active process instance for the target entity. If there isn't any active business process flow instance for the target entity record and the specified business process flow definition, a new business process flow instance will be created and set as the active instance.

For the Web API use the SetProcess Action.

System_CAPS_pubclass SetProcessResponse

Contains the response from executing the SetProcessRequest class.

System_CAPS_pubclass SetRelatedRequest

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

System_CAPS_pubclass SetRelatedResponse

Contains the response from the SetRelatedRequest class.

System_CAPS_pubclass SetReportRelatedRequest

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

For the Web API use the SetReportRelated Action.

System_CAPS_pubclass SetReportRelatedResponse

Contains the response from SetReportRelatedRequest.

System_CAPS_pubclass SetStateRequest

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

System_CAPS_pubclass SetStateResponse

Contains the response from the SetStateRequest class.

System_CAPS_pubclass ShareAuditDetail

Represents a shared audit detail record.

System_CAPS_pubclass TimeInfo

Specifies a set of time blocks with appointment information.

For the Web API the corresponding type is TimeInfo ComplexType.

System_CAPS_pubclass TraceInfo

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

For the Web API the corresponding type is TraceInfo ComplexType.

System_CAPS_pubclass TransformImportRequest

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

For the Web API use the TransformImport Action.

System_CAPS_pubclass TransformImportResponse

Contains the response from the TransformImportRequest class.

System_CAPS_pubclass TriggerServiceEndpointCheckRequest

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

System_CAPS_pubclass TriggerServiceEndpointCheckResponse

Contains the response from the TriggerServiceEndpointCheckRequest.

System_CAPS_pubclass UninstallSampleDataRequest

System_CAPS_pubclass UninstallSampleDataResponse

System_CAPS_pubclass UnlockInvoicePricingRequest

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

For the Web API use the UnlockInvoicePricing Action.

System_CAPS_pubclass UnlockInvoicePricingResponse

Contains the response from the UnlockInvoicePricingRequest class.

System_CAPS_pubclass UnlockSalesOrderPricingRequest

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

For the Web API use the UnlockSalesOrderPricing Action.

System_CAPS_pubclass UnlockSalesOrderPricingResponse

Contains the response from the UnlockSalesOrderPricingRequest class.

System_CAPS_pubclass UnpublishDuplicateRuleRequest

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

For the Web API use the UnpublishDuplicateRule Action.

System_CAPS_pubclass UnpublishDuplicateRuleResponse

Contains the response from the UnpublishDuplicateRuleRequest class.

System_CAPS_pubclass UpdateFeatureConfigRequest

This API supports the product infrastructure and is not intended to be used directly from your code.

For the Web API use the UpdateFeatureConfig 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) .

System_CAPS_pubclass UpdateFeatureConfigResponse

This API supports the product infrastructure and is not intended to be used directly from your code.

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

For the Web API use the UpdateProductProperties Action.

System_CAPS_pubclass UpdateProductPropertiesResponse

Contains the response from the UpdateProductPropertiesRequest class.

System_CAPS_pubclass UpdateSolutionComponentRequest

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

System_CAPS_pubclass UpdateSolutionComponentResponse

Contains the response from executing the UpdateSolutionComponentRequest class.

System_CAPS_pubclass UpdateUserSettingsSystemUserRequest

Deprecated. Use the UpdateRequest class.

System_CAPS_pubclass UpdateUserSettingsSystemUserResponse

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

System_CAPS_pubclass UserAccessAuditDetail

For internal use only.

System_CAPS_pubclass UtcTimeFromLocalTimeRequest

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

System_CAPS_pubclass UtcTimeFromLocalTimeResponse

Contains the response from the UtcTimeFromLocalTimeRequest class.

System_CAPS_pubclass ValidateRecurrenceRuleRequest

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

For the Web API use the ValidateRecurrenceRule Function.

System_CAPS_pubclass ValidateRecurrenceRuleResponse

Contains the response from the ValidateRecurrenceRuleRequest class.

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

For the Web API use the Validate Action.

System_CAPS_pubclass ValidateResponse

Contains the response from the ValidateRequest class.

For the Web API the ValidateResponse ComplexType is the response value from the Validate Action.

System_CAPS_pubclass ValidateSavedQueryRequest

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

For the Web API use the ValidateSavedQuery Action.

System_CAPS_pubclass ValidateSavedQueryResponse

Contains the response from the ValidateSavedQueryRequest class.

System_CAPS_pubclass ValidationIssue

System_CAPS_pubclass ValidationResult

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

For the Web API the corresponding type is ValidationResult ComplexType.

System_CAPS_pubclass WebResourceInfo

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

For the Web API use the WhoAmI Function.

System_CAPS_pubclass WhoAmIResponse

Contains the response from the WhoAmIRequest class.

For the Web API the WhoAmIResponse ComplexType is the response value from the WhoAmI Function.

System_CAPS_pubclass WinOpportunityRequest

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

For the Web API use the WinOpportunity Action.

System_CAPS_pubclass WinOpportunityResponse

Contains the response from the WinOpportunityRequest class.

System_CAPS_pubclass WinQuoteRequest

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

For the Web API use the WinQuote Action.

System_CAPS_pubclass WinQuoteResponse

Contains the response from the WinQuoteRequest class.

Enumerations

Enumeration Description
System_CAPS_pubenum AccessRights

Contains the possible access rights for a user.

System_CAPS_pubenum BulkOperationSource

Contains the possible sources of a bulk operation.

System_CAPS_pubenum BusinessNotificationParameterType

For internal use only.

System_CAPS_pubenum BusinessNotificationSeverity

For internal use only.

System_CAPS_pubenum ChannelAccessProfilePrivilegeDepth

For internal use only.

System_CAPS_pubenum EntitySource

Describes which members of a bulk operation to retrieve.

System_CAPS_pubenum ErrorType

System_CAPS_pubenum ExportDynamicToExcelType

For internal use only.

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

System_CAPS_pubenum PropagationOwnershipOptions

Contains the possible values for propagation ownership options.

For the Web API use the PropagationOwnershipOptions EnumType.

System_CAPS_pubenum RibbonLocationFilters

Contains the values for ribbon filters for an entity.

For the Web API use the RibbonLocationFilters EnumType.

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

System_CAPS_pubenum SearchDirection

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

For the Web API use the SearchDirection EnumType.

System_CAPS_pubenum SubCode

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

For the Web API use the SubCode EnumType.

System_CAPS_pubenum TargetFieldType

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

System_CAPS_pubenum TimeCode

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

For the Web API use the TimeCode EnumType.

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright