ImportSolutionRequest Class

Definition

Namespace:

Microsoft.Crm.Sdk.Messages

Assembly:

Microsoft.Crm.Sdk.Proxy.dll

Package:

Microsoft.PowerPlatform.Dataverse.Client v1.1.17

Contains the data that is needed to import a solution.

public ref class ImportSolutionRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class ImportSolutionRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type ImportSolutionRequest = class
    inherit OrganizationRequest

Public NotInheritable Class ImportSolutionRequest
Inherits OrganizationRequest

Inheritance

Object

OrganizationRequest

ImportSolutionRequest

Attributes

DataContractAttribute

Examples

The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface instance. For the complete sample, see the link later in this topic.

Remarks

For the Web API use the ImportSolution action.

Learn more about working with solutions using code.

Usage

This request is the only one that can be called either synchronously or asynchronously.

To use this messages synchronously, pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of ImportSolutionResponse.

To use this message asynchronously, instantiate a ExecuteAsyncRequest and set the Request property to an instance of this class. Use the Execute(OrganizationRequest) method to return an ExecuteAsyncResponse. The Results property will contain the ImportSolutionResponse. Use the ExecuteAsyncResponse.AsyncJobId to track the success of the solution import.

Privileges and Access Rights

To perform this action, the caller must have privileges listed in ImportSolution message privileges.

Notes for Callers

Constructors

ImportSolutionRequest()

Initializes a new instance of the ImportSolutionRequest class

Properties

AsyncRibbonProcessing	Gets or sets the list of entities to overwrite values from the solution.
ComponentParameters	Gets or sets the list of entities to overwrite values from the solution.
ConvertToManaged	Direct the system to convert any matching unmanaged customizations into your managed solution. Optional.
CustomizationFile	Gets or sets the compressed solutions file to import. Required.
ExtensionData	Gets or sets the structure that contains extra data. Optional. (Inherited from OrganizationRequest)
HoldingSolution	Gets or sets whether a solution is imported and staged as a holding solution.
ImportJobId	Gets or sets the ID of the import job that will be created to perform this import. Required.
IsTemplateMode	Internal use only.
Item[String]	Gets or sets the indexer for the Parameters collection. (Inherited from OrganizationRequest)
LayerDesiredOrder	For internal use only.
OverwriteUnmanagedCustomizations	Gets or sets whether any unmanaged customizations that have been applied over existing managed solution components should be overwritten. Required.
Parameters	Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)
PublishWorkflows	Gets or sets whether any processes (workflows) included in the solution should be activated after they are imported. Required.
RequestId	Gets or sets the ID of the request. Optional. (Inherited from OrganizationRequest)
RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)
SkipProductUpdateDependencies	Gets or sets whether enforcement of dependencies related to product updates should be skipped.
SkipQueueRibbonJob	For internal use only.
SolutionParameters	Additional solution parameters.
TemplateDisplayNamePrefix
TemplateSuffix	Internal use only.