CreateEntityRequest Class

Definition

Namespace:

Microsoft.Xrm.Sdk.Messages

Assembly:

Microsoft.Xrm.Sdk.dll

Package:

Microsoft.PowerPlatform.Dataverse.Client v1.0.39

Contains the data that is needed to create a custom entity, and optionally, to add it to a specified unmanaged solution.

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

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

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

Public NotInheritable Class CreateEntityRequest
Inherits OrganizationRequest

Inheritance

Object

OrganizationRequest

CreateEntityRequest

Attributes

DataContractAttribute

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. For the complete sample, see the link later in this topic.

The _customEntityName value is “new_BankAccount”.

Remarks

Usage

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

Privileges and Access Rights

To perform this action, the caller must have the required privileges, as listed in CreateEntity message privileges.

Notes for Callers

When you programmatically create a custom entity, it does not appear in the application navigation pane unless you edit the SiteMap to display the entity in the location where you want it displayed. Alternatively, in the application edit the entity properties to set Areas that display this entity to the location where you want the entity displayed. For more information, see Change application navigation using the SiteMap.

Constructors

CreateEntityRequest()

Initializes a new instance of the CreateEntityRequest class.

Properties

Entity	Gets or sets the metadata for the custom entity that you want to create. Required.
ExtensionData	Gets or sets the structure that contains extra data. Optional. (Inherited from OrganizationRequest)
HasActivities	Gets or sets whether a custom entity is created that has a special relationship to activity entities and is a valid regarding object for the activity. Optional.
HasFeedback	Gets or sets whether the entity will have a special relationship to the Feedback entity. Optional.
HasNotes	Gets or sets whether the custom entity that is created has a special relationship to the annotation entity. Optional.
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)
PrimaryAttribute	Gets or sets the metadata for the primary attribute for the new entity. Required.
RequestId	Gets or sets the ID of the request. Optional. (Inherited from OrganizationRequest)
RequestName	Gets or sets the name of the request. Required, but is supplied by derived classes. (Inherited from OrganizationRequest)
SolutionUniqueName	Gets or sets the name of the unmanaged solution to which you want to add this custom entity. Optional.

See also

• CreateEntityResponse