Edit

Share via

createRecord (JavaScript API Reference) for Dynamics 365 Channel Integration Framework 1.0

  • Article

Creates an entity record.

Syntax

Microsoft.CIFramework.createRecord(entityLogicalName, data).then(successCallback, errorCallback);

Parameters

Name Type Required Description
entityLogicalName String Yes Logical name of the entity you want to create. For example: "account".
data String Yes String defining the attributes and values for the new entity record.
successCallback Function No A function to call when a record is created.
errorCallback Function No A function to call when the operation fails.

Return Value

On success, returns a promise containing a string with the attributes and their values.

Examples

The sample code demonstrates how to create a sample contact record.

var entityLogicalName = "contact";
var data = {
    "firstname": "Sample",
    "lastname": "Contact",
    "fullname": "Sample Contact",
    "emailaddress1": "[email protected]",
    "jobtitle": "Sr. Marketing Manager",
    "telephone1": "555-0109",
    "description": "Default values for this record were set programmatically."
}
// create contact record
var jsonData = JSON.stringify(data);
Microsoft.CIFramework.createRecord(entityLogicalName,jsonData).then(
    function success (result) {
      res=JSON.parse(result);
          console.log("Contact created with ID: " + res.id);
          //perform operations on record creation
      },
      function (error) {
          console.log(error);
          //handle error conditions
      }
  );

The following example shows how you can pass a lookup value instead of plain text in the variable data.

var data =
    {
        "name": "Sample Account",
        "[email protected]": "/contacts(3518ddae-2f46-e911-8190-000d3a6ce16d)"
    }
var jsonData = JSON.stringify(data);
Microsoft.CIFramework.createRecord("account",jsonData).then(
    function success (result) {
      res=JSON.parse(result);
          console.log("Contact created with ID: " + res.id);
          //perform operations on record creation
      },
      function (error) {
          console.log(error);
          //handle error conditions
      }
);