CanBeReferencedRequest CanBeReferencedRequest CanBeReferencedRequest CanBeReferencedRequest Class

Definition

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.

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


public bool EligibleCreateOneToManyRelationship(string referencedEntity, 
    string referencingEntity)
{
    //Checks whether the specified entity can be the primary entity in one-to-many
    //relationship.
    var canBeReferencedRequest = new CanBeReferencedRequest
    {
        EntityName = referencedEntity
    };

CanBeReferencedResponse canBeReferencedResponse =(CanBeReferencedResponse)svc.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. var canBereferencingRequest = new CanBeReferencingRequest { EntityName = referencingEntity };

var canBeReferencingResponse =(CanBeReferencingResponse)svc.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; } }

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.

relationships#WorkWithRelationships4 relationshipsVB#WorkWithRelationships4

Remarks

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(OrganizationRequest) 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.

Constructors

CanBeReferencedRequest() CanBeReferencedRequest() CanBeReferencedRequest() CanBeReferencedRequest()

Initializes a new instance of the CanBeReferencedRequest class.

Properties

EntityName EntityName EntityName 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 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)
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)

Applies to

See also