ImportSolutionRequest ImportSolutionRequest ImportSolutionRequest ImportSolutionRequest Class

Definition

Contains the data that is needed to import a solution.

For the Web API use the ImportSolution Action.

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
type ImportSolutionRequest = class
    inherit OrganizationRequest
Public NotInheritable Class ImportSolutionRequest
Inherits OrganizationRequest
Inheritance
ImportSolutionRequestImportSolutionRequestImportSolutionRequestImportSolutionRequest
Attributes

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. For the complete sample, see the link later in this topic.


  // Install or Upgrade a Solution                  
     byte[] fileBytes = File.ReadAllBytes(ManagedSolutionLocation);
 var impSolReq = new ImportSolutionRequest()
 {
     CustomizationFile = fileBytes
};
     svc.Execute(impSolReq);
     Console.WriteLine("Imported Solution from {0}", ManagedSolutionLocation);

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. For the complete sample, see the link later in this topic.

solutions#WorkWithSolutions8 solutionsVB#WorkWithSolutions8

Remarks

Message Availability

For this message to work, the caller must be connected to the server.

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() ImportSolutionRequest() ImportSolutionRequest() ImportSolutionRequest()

Initializes a new instance of the ImportSolutionRequest class

Properties

ConvertToManaged ConvertToManaged ConvertToManaged ConvertToManaged

Direct the system to convert any matching unmanaged customizations into your managed solution. Optional.

CustomizationFile CustomizationFile CustomizationFile CustomizationFile

Gets or sets the compressed solutions file to import. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
HoldingSolution HoldingSolution HoldingSolution HoldingSolution

ImportJobId ImportJobId ImportJobId ImportJobId

Gets or sets the ID of the import job that will be created to perform this import. Required.

Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
LayerDesiredOrder LayerDesiredOrder LayerDesiredOrder LayerDesiredOrder
OverwriteUnmanagedCustomizations OverwriteUnmanagedCustomizations OverwriteUnmanagedCustomizations OverwriteUnmanagedCustomizations

Gets or sets whether any unmanaged customizations that have been applied over existing managed solution components should be overwritten. Required.

Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
PublishWorkflows PublishWorkflows PublishWorkflows PublishWorkflows

Gets or sets whether any processes (workflows) included in the solution should be activated after they are imported. Required.

RequestId RequestId RequestId RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional.

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
SkipProductUpdateDependencies SkipProductUpdateDependencies SkipProductUpdateDependencies SkipProductUpdateDependencies

Gets or sets whether enforcement of dependencies related to product updates should be skipped.

SkipRibbonMetadataProcessing SkipRibbonMetadataProcessing SkipRibbonMetadataProcessing SkipRibbonMetadataProcessing

Applies to