CreateEntityRequest Class

Definition

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.

The _customEntityName value is “new_BankAccount”.

// Create Entity 
CreateEntityRequest createrequest = new CreateEntityRequest
{
//Define the entity
 Entity = new EntityMetadata
 {
  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,

 },

 // Define the primary attribute for the entity
 PrimaryAttribute = new StringAttributeMetadata
 {
  SchemaName = "new_accountname",
  RequiredLevel = new AttributeRequiredLevelManagedProperty(AttributeRequiredLevel.None),
  MaxLength = 100,
  FormatName = StringFormatName.Text,
  DisplayName = new Label("Account Name", 1033),
  Description = new Label("The primary attribute for the Bank Account entity.", 1033)
 }
};

svc.Execute(createrequest);
Console.WriteLine("The bank account entity has been created.");

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

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

Properties

Applies to

See also

• CreateEntityResponse