CreateRequest Class

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

Contains the data that is needed to create a record.

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

Syntax

'Declaration
<DataContractAttribute(Namespace:="https://schemas.microsoft.com/xrm/2011/Contracts")> _
Public NotInheritable Class CreateRequest
    Inherits OrganizationRequest

[DataContractAttribute(Namespace="https://schemas.microsoft.com/xrm/2011/Contracts")] 
public sealed class CreateRequest : OrganizationRequest

Example

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.

//Set the Web Resource properties
WebResource wr = new WebResource
{
    Content = getEncodedFileContents(@"../../" + webResource.path),
    DisplayName = webResource.displayName,
    Description = webResource.description,
    Name = _customizationPrefix + webResource.name,
    LogicalName = WebResource.EntityLogicalName,
    WebResourceType = new OptionSetValue(Int32.Parse(webResource.type))
};

// Using CreateRequest because we want to add an optional parameter
CreateRequest cr = new CreateRequest
{
    Target = wr
};
//Set the SolutionUniqueName optional parameter so the Web Resources will be
// created in the context of a specific solution.
cr.Parameters.Add("SolutionUniqueName", _ImportWebResourcesSolutionUniqueName);

CreateResponse cresp = (CreateResponse)_serviceProxy.Execute(cr);

'Set the Web Resource properties
Dim wr As WebResource =
    New WebResource With
    {
        .Content = getEncodedFileContents("../../" _
                                          & awebResource.path),
        .DisplayName = awebResource.displayName,
        .Description = awebResource.description,
        .Name = _customizationPrefix & awebResource.name,
        .LogicalName = WebResource.EntityLogicalName,
        .WebResourceType =
        New OptionSetValue(Int32.Parse(awebResource.type))
    }

' Using CreateRequest because we want to add an optional parameter
Dim cr As CreateRequest = New CreateRequest With {.Target = wr}
'Set the SolutionUniqueName optional parameter so the Web Resources will be
' created in the context of a specific solution.
cr.Parameters.Add("SolutionUniqueName",
                  _ImportWebResourcesSolutionUniqueName)

Dim cresp As CreateResponse = CType(_serviceProxy.Execute(cr), 
    CreateResponse)

Remarks

Message Availability

Not all entity types support this message offline. For some supported entities, this message works regardless whether the caller is connected to the server or offline. For other entities, the caller must be connected to the server before the message works. For more information, see Supported Entities later in this topic.

Usage

Pass an instance of this class to the Execute method, which returns an instance of the CreateResponse class.

This message supports one or more optional parameters. For more information, see Pass Optional Parameters in Messages.

Privileges and Access Rights

To perform this action, the caller must have privileges on the specified entity in the entity parameter. For a list of the required privileges, see Create Privileges.

Notes for Callers

This message creates a record with related records in one transaction. For a less complex method that creates a single record, use the Create method.

By default, the caller becomes the owner for the new record. For this message to work, the caller must have both Create and Read privileges for the entity. For more information, see Privileges by Entity. Or you can set the ownerid attribute for the record to the ID of another user.

Supported Entities

You can use this method to create any record of an entity (includes custom entities) that supports the CreateRequest message.

The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server.

Inheritance Hierarchy

System.Object
   Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Xrm.Sdk.Messages.CreateRequest

Thread Safety

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

Platforms

Development Platforms

Windows Server 2008, Windows Server 2012, Windows 7 (All Versions), Windows 8 (All Versions)

Target Platforms

Windows Server 2008, ,Windows Server 2012, ,Windows 7 (All Versions),

Change History

See Also

Reference

CreateRequest Members
Microsoft.Xrm.Sdk.Messages Namespace
CreateResponse
IOrganizationService.Create Method
Create a New Entity Record Using the Early-bound Entity Classes and the Organization Service Context

Other Resources

Sample: Importing Files as Web Resources
Privileges by Entity

Send comments about this topic to Microsoft.
© 2013 Microsoft Corporation. All rights reserved.