Export (0) Print
Expand All

RetrieveAttributeRequest Class

Contains the data that is needed to retrieve attribute metadata.

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

public sealed class RetrieveAttributeRequest : OrganizationRequest

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.

// Create the request
RetrieveAttributeRequest attributeRequest = new RetrieveAttributeRequest
    EntityLogicalName = Contact.EntityLogicalName,
    LogicalName = "new_string",
    RetrieveAsIfPublished = true

// Execute the request
RetrieveAttributeResponse attributeResponse =

Console.WriteLine("Retrieved the attribute {0}.",

Message Availability

This message works regardless whether the caller is connected to the server or offline.


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

Privileges and Access Rights

To perform this action, the caller must have privileges listed in RetrieveAttribute Privileges.

Notes for Callers

You can use either the LogicalName or the MetadataId to specify the attribute you want to retrieve.


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

Development Platforms

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

Target Platforms

Windows Server 2008,Windows Server 2012,Windows 7

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

Community Additions

© 2015 Microsoft