CreateEntityRequest 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 create a custom entity, and optionally, to add it to a specified unmanaged solution.

Namespace:   Microsoft.Xrm.Sdk.Messages
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)


<DataContractAttribute(Namespace := "")>
Public NotInheritable Class CreateEntityRequest
	Inherits OrganizationRequest


Initializes a new instance of the CreateEntityRequest class.


Gets or sets the metadata for the custom entity that you want to create. Required.


Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)


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.


Gets or sets whether the entity will have a special relationship to the Feedback entity. Optional.


Gets or sets whether the custom entity that is created has a special relationship to the annotation entity. Optional.


Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)


Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


Gets or sets the metadata for the primary attribute for the new entity. Required.


Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)


Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)


Gets or sets the name of the unmanaged solution to which you want to add this custom entity. Optional.


(Inherited from Object.)


(Inherited from Object.)


(Inherited from Object.)


(Inherited from Object.)

Message Availability

For this message to work, the caller must be connected to the server.


Pass an instance of this class to the Execute 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.

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

Dim createrequest As CreateEntityRequest = New CreateEntityRequest With {
 .Entity = New EntityMetadata With {
  .SchemaName = _customEntityName,
  .DisplayName = New Label("Bank Account", 1033),
  .DisplayCollectionName = New Label("Bank Accounts", 1033),
  .Description = New Label("An entity to store information about customer bank accounts", 1033),
  .OwnershipType = OwnershipTypes.UserOwned,
  .IsActivity = False},
 .PrimaryAttribute = New StringAttributeMetadata With {
  .SchemaName = "new_accountname",
  .RequiredLevel = New AttributeRequiredLevelManagedProperty(AttributeRequiredLevel.None),
  .MaxLength = 100,
  .Format = StringFormat.Text,
  .DisplayName = New Label("Account Name", 1033),
  .Description = New Label("The primary attribute for the Bank Account entity.", 1033)
'Define the entity
' Define the primary attribute for the entity
Console.WriteLine("The bank account entity has been created.")

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions