CreateEntityRequest CreateEntityRequest CreateEntityRequest CreateEntityRequest Class

Definition

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
type CreateEntityRequest = class
    inherit OrganizationRequest
Public NotInheritable Class CreateEntityRequest
Inherits OrganizationRequest
Inheritance
CreateEntityRequestCreateEntityRequestCreateEntityRequestCreateEntityRequest
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.

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

Entities#CreateUpdateEntityMetadata1 EntitiesVB#CreateUpdateEntityMetadata1

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

CreateEntityRequest() CreateEntityRequest() CreateEntityRequest() CreateEntityRequest()

Initializes a new instance of the CreateEntityRequest class.

Properties

Entity Entity Entity Entity

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

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
HasActivities HasActivities HasActivities 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 HasFeedback HasFeedback HasFeedback

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

HasNotes HasNotes HasNotes HasNotes

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

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

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

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

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

Applies to

See also