Partager via


Classe RetrieveRelationshipRequest

S'applique à: CRM 2015 on-prem, CRM Online

Contains the data that is needed to retrieve entity relationship metadata.

Espace de noms: Microsoft.Xrm.Sdk.Messages
Assembly: Microsoft.Xrm.Sdk (dans Microsoft.Xrm.Sdk.dll)

Syntaxe

'Déclaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/xrm/2011/Contracts")> _
Public NotInheritable Class RetrieveRelationshipRequest
    Inherits OrganizationRequest
[DataContractAttribute(Namespace="https://schemas.microsoft.com/xrm/2011/Contracts")] 
public sealed class RetrieveRelationshipRequest : OrganizationRequest

Exemple

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.


//You can use either the Name or the MetadataId of the relationship.

//Retrieve the One-to-many relationship using the MetadataId.
RetrieveRelationshipRequest retrieveOneToManyRequest =
    new RetrieveRelationshipRequest { MetadataId = _oneToManyRelationshipId };
RetrieveRelationshipResponse retrieveOneToManyResponse =
    (RetrieveRelationshipResponse)_serviceProxy.Execute(retrieveOneToManyRequest);

Console.WriteLine("Retrieved {0} One-to-many relationship by id", retrieveOneToManyResponse.RelationshipMetadata.SchemaName);

//Retrieve the Many-to-many relationship using the Name.
RetrieveRelationshipRequest retrieveManyToManyRequest =
    new RetrieveRelationshipRequest { Name = _manyToManyRelationshipName};
RetrieveRelationshipResponse retrieveManyToManyResponse =
    (RetrieveRelationshipResponse)_serviceProxy.Execute(retrieveManyToManyRequest);

Console.WriteLine("Retrieved {0} Many-to-Many relationship by Name", retrieveManyToManyResponse.RelationshipMetadata.MetadataId);

Remarques

Message Availability

Ce message fonctionne, que l'appelant soit connecté au serveur ou en mode hors connexion.

Usage

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

Privileges and Access Rights

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

Notes for Callers

You can use either the Name or the MetadataId of the relationship.

Hiérarchie d'héritage

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Xrm.Sdk.Messages.RetrieveRelationshipRequest

Cohérence de thread

Tous les membres statiques publics (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres d'instance ne sont pas garantis thread-safe.

Plateformes

Plateformes de développement

Windows Vista, Windows Server 2003 et

Plateformes cibles

Windows Vista,Windows XP

Change History

Voir aussi

Référence

Membres RetrieveRelationshipRequest
Espace de noms Microsoft.Xrm.Sdk.Messages

Autres ressources

Sample: Create Entity Relationships
Customize Entity Relationship Metadata

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