GetValidReferencedEntitiesRequest Class

Reference

Definition

Namespace:: Microsoft.Xrm.Sdk.Messages

Assembly:: Microsoft.Xrm.Sdk.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.0.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Contains the data that is needed to retrieve a list of entity logical names that are valid as the primary entity (one) from the specified entity in a one-to-many relationship.

For the Web API use GetValidReferencedEntities Function.

public ref class GetValidReferencedEntitiesRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class GetValidReferencedEntitiesRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type GetValidReferencedEntitiesRequest = class
    inherit OrganizationRequest

Public NotInheritable Class GetValidReferencedEntitiesRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
GetValidReferencedEntitiesRequest

Attributes: DataContractAttribute

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 GetValidReferencedEntitiesResponse.

Privileges and Access Rights

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

Notes for Callers

If no entity is specified, this message returns all entities that can be the primary entity in a one-to-many relationship.

Constructors

GetValidReferencedEntitiesRequest()

Initializes a new instance of the GetValidReferencedEntitiesRequest class

Properties

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)
ReferencingEntityName	Gets or sets the logical name of the entity to get valid referenced entities. Optional.
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)

Applies to