RetrieveAttributeRequest RetrieveAttributeRequest RetrieveAttributeRequest RetrieveAttributeRequest Class

Definition

Contains the data that is needed to retrieve attribute metadata.

public ref class RetrieveAttributeRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class RetrieveAttributeRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type RetrieveAttributeRequest = class
    inherit OrganizationRequest
Public NotInheritable Class RetrieveAttributeRequest
Inherits OrganizationRequest
Inheritance
RetrieveAttributeRequestRetrieveAttributeRequestRetrieveAttributeRequestRetrieveAttributeRequest
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.

// Create the request
RetrieveAttributeRequest attributeRequest = new RetrieveAttributeRequest
{
    EntityLogicalName = Contact.EntityLogicalName,
    LogicalName = "new_string",
    RetrieveAsIfPublished = false
};
// Execute the request
RetrieveAttributeResponse attributeResponse =
    (RetrieveAttributeResponse)svc.Execute(attributeRequest);
Console.WriteLine("Retrieved the attribute {0}.",
    attributeResponse.AttributeMetadata.SchemaName);

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.

// Create the request
RetrieveAttributeRequest attributeRequest = new RetrieveAttributeRequest
{
    EntityLogicalName = Contact.EntityLogicalName,
    LogicalName = "new_string",
    RetrieveAsIfPublished = false
};

// Execute the request RetrieveAttributeResponse attributeResponse = (RetrieveAttributeResponse)svc.Execute(attributeRequest); Console.WriteLine("Retrieved the attribute {0}.", attributeResponse.AttributeMetadata.SchemaName);

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 = false
};

// Execute the request RetrieveAttributeResponse attributeResponse = (RetrieveAttributeResponse)_serviceProxy.Execute(attributeRequest);

Console.WriteLine("Retrieved the attribute {0}.", attributeResponse.AttributeMetadata.SchemaName);

Remarks

Message Availability

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

Usage

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

Privileges and Access Rights

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

Notes for Callers

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

Constructors

RetrieveAttributeRequest() RetrieveAttributeRequest() RetrieveAttributeRequest() RetrieveAttributeRequest()

Initializes a new instance of the RetrieveAttributeRequest class

Properties

ColumnNumber ColumnNumber ColumnNumber ColumnNumber

Gets or sets a column number value to identify an attribute from the Audit.AttributeMask property. Optional.

EntityLogicalName EntityLogicalName EntityLogicalName EntityLogicalName

Gets or sets the logical name of the entity that contains the attribute. Optional.

ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
LogicalName LogicalName LogicalName LogicalName

Gets or sets the logical name of the attribute to be retrieved. Optional.

MetadataId MetadataId MetadataId MetadataId

The unique identifier for the attribute. Optional.

Parameters Parameters Parameters Parameters

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

(Inherited from OrganizationRequest)
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)
RetrieveAsIfPublished RetrieveAsIfPublished RetrieveAsIfPublished RetrieveAsIfPublished

Gets or sets whether to retrieve the metadata that has not been published. Required.

Applies to