CanBeReferencedRequest Class
Updated: November 29, 2016
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online
Contains the data that is needed to check whether the specified entity can be the primary entity (one) in a one-to-many relationship.
For the Web API use the CanBeReferenced Action.
Assembly: Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)
Microsoft.Xrm.Sdk.OrganizationRequest
Microsoft.Xrm.Sdk.Messages.CanBeReferencedRequest
| Name | Description | |
|---|---|---|
![]() | CanBeReferencedRequest() | Initializes a new instance of the CanBeReferencedRequest class. |
| Name | Description | |
|---|---|---|
![]() | EntityName | Gets or sets the logical entity name to check whether it can be the primary entity in a one-to-many relationship. Required. |
![]() | ExtensionData | Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.) |
![]() | Item[String] | Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.) |
![]() | Parameters | Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) |
![]() | RequestId | Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.) |
![]() | RequestName | Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.) |
| Name | Description | |
|---|---|---|
![]() | Equals(Object) | (Inherited from Object.) |
![]() | GetHashCode() | (Inherited from Object.) |
![]() | GetType() | (Inherited from Object.) |
![]() | ToString() | (Inherited from Object.) |
Message Availability
For this message to work, the caller must be connected to the server.
Usage
Pass an instance of this class to the Execute method, which returns an instance of the CanBeReferencedResponse class.
Privileges and Access Rights
To perform this action, the caller must have the required privileges, as listed in CanBeReferenced message privileges.
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.
/// <summary> /// Determines whether two entities are eligible to participate in a relationship /// </summary> /// <param name="referencedEntity">Primary Entity</param> /// <param name="referencingEntity">Referencing Entity</param> /// <returns></returns> public bool EligibleCreateOneToManyRelationship(string referencedEntity, string referencingEntity) { //Checks whether the specified entity can be the primary entity in one-to-many //relationship. CanBeReferencedRequest canBeReferencedRequest = new CanBeReferencedRequest { EntityName = referencedEntity }; CanBeReferencedResponse canBeReferencedResponse = (CanBeReferencedResponse)_serviceProxy.Execute(canBeReferencedRequest); if (!canBeReferencedResponse.CanBeReferenced) { Console.WriteLine( "Entity {0} can't be the primary entity in this one-to-many relationship", referencedEntity); } //Checks whether the specified entity can be the referencing entity in one-to-many //relationship. CanBeReferencingRequest canBereferencingRequest = new CanBeReferencingRequest { EntityName = referencingEntity }; CanBeReferencingResponse canBeReferencingResponse = (CanBeReferencingResponse)_serviceProxy.Execute(canBereferencingRequest); if (!canBeReferencingResponse.CanBeReferencing) { Console.WriteLine( "Entity {0} can't be the referencing entity in this one-to-many relationship", referencingEntity); } if (canBeReferencedResponse.CanBeReferenced == true && canBeReferencingResponse.CanBeReferencing == true) { return true; } else { return false; } }
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright

