RetrieveRequest Class

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to retrieve a deployment entity or configuration settings record.

Namespace: Microsoft.Xrm.Sdk.Deployment
Assembly: Microsoft.Xrm.Sdk.Deployment (in Microsoft.Xrm.Sdk.Deployment.dll)

Syntax

'Declaration
<DebuggerStepThroughAttribute> _
<DataContractAttribute(Name:="RetrieveRequest", Namespace:="http://schemas.microsoft.com/xrm/2011/Contracts/Deployment")> _
<GeneratedCodeAttribute("System.Runtime.Serialization", "4.0.0.0")> _
Public Class RetrieveRequest
    Inherits DeploymentServiceRequest
[DebuggerStepThroughAttribute] 
[DataContractAttribute(Name="RetrieveRequest", Namespace="http://schemas.microsoft.com/xrm/2011/Contracts/Deployment")] 
[GeneratedCodeAttribute("System.Runtime.Serialization", "4.0.0.0")] 
public class RetrieveRequest : DeploymentServiceRequest

Example

// By instantiating the DeploymentServiceClient in a using statement you ensure that the client
// communication channel is closed and the object is disposed when it goes out of scope.

// CustomBinding_IDeploymenService is the name of the configuration setting for the CustomBinding

using (DeploymentServiceClient client = new DeploymentServiceClient("CustomBinding_IDeploymentService"))
{
             
    //The EntityIstanceId class is used to identify the object you want to
    // retrieve. You have the option of using name or ID.
    EntityInstanceId id = new EntityInstanceId
    {
        Name = "AlpineSkiHouse"
    };
    //Retrieve the organization
    Organization organization = (Organization)client.Retrieve(DeploymentEntityType.Organization, id);
             
    client.Close();
}

The following is an example of an Organization class instance serialized to XML:

<?xml version="1.0" encoding="utf-8"?>
<Organization xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <ExtensionData />
  <BaseCurrencyCode>USD</BaseCurrencyCode>
  <BaseCurrencyName>US Dollar</BaseCurrencyName>
  <BaseCurrencyPrecision>2</BaseCurrencyPrecision>
  <BaseCurrencySymbol>$</BaseCurrencySymbol>
  <BaseLanguageCode>1033</BaseLanguageCode>
  <DatabaseName>AlpineSkiHouse_MSCRM</DatabaseName>
  <FriendlyName>Alpine Ski House</FriendlyName>
  <Id>273c0010-5973-43d4-b666-8d899ca8c6ab</Id>
  <SqlCollation>Latin1_General_CI_AI</SqlCollation>
  <SqlServerName>CRM01</SqlServerName>
  <SqmIsEnabled>false</SqmIsEnabled>
  <SrsUrl>http://crm01/reportserver</SrsUrl>
  <State>Pending</State>
  <UniqueName>AlpineSkiHouse</UniqueName>

Remarks

Pass an instance of this class to the Execute method, which returns an instance of RetrieveResponse.

You can use this message to retrieve any of the valid entity types as specified by the DeploymentEntityType enumeration.

An organization deployment object has five possible states as defined by the OrganizationState enumeration.

You can also use the corresponding Windows PowerShell command for the deployment entity you want to retrieve, for example, Get-CrmOrganization or Get-CrmSetting. For more information, see Administer the deployment using Windows PowerShel.

Note that this is for the Deployment Web service. To retrieve organization data records, use RetrieveRequest.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.Deployment.DeploymentServiceRequest
    Microsoft.Xrm.Sdk.Deployment.RetrieveRequest

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows 98,Windows 2000,Windows 2000 Server,Windows CE,Windows Server 2008,Windows 98 Second Edition,Pocket PC,Smart Phone,Windows Server 2003,Windows XP Professional,Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions), ,Windows 8 (All Versions)

Change History

See Also

Reference

RetrieveRequest Members
Microsoft.Xrm.Sdk.Deployment Namespace
RetrieveResponse

Other Resources

Use Deployment Entities and Deployment Configuration Settings

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.