SharePoint Journey

Sunday, January 30, 2022

CRUD operations with Xrm.WebApi.online.execute and Xrm.WebApi.online.executeMultiple

CRUD (create, read, update, delete) operations using the Xrm.WebApi.online.execute and Xrm.WebApi.online.executeMultiple methods of the Dynamics 365 Client API, with JavaScript, are not very well documented in the official Microsoft documentation. The Xrm.WebApi.online.execute (Client API reference) documentation has no code samples for CRUD opertations.

So, here are code samples to get you going…

CRUD Opertations with Xrm.WebApi.online.execute

Below are some code samples for running CRUD operations using the Xrm.WebApi.online.execute method.

Create

var Sdk = window.Sdk || {};

/**
 * Request to create a record
 * @param {string} entityTypeName - The entity type name.
 * @param {Object} payload - The entity payload.
 */
Sdk.CreateRequest = function (entityTypeName, payload) {
    this.etn = entityTypeName;
    this.payload = payload;
    this.getMetadata = function () {
        return {
            boundParameter: null,
            parameterTypes: {},
            operationType: 2,
            operationName: "Create",
        };
    };
};

// Construct a request object from the metadata
var request = new Sdk.CreateRequest("new_entity", { "new_name": "Foo Bar" });

// Use the request object to execute the function
Xrm.WebApi.online.execute(request).then(
    (result) => {
        if (result.ok) {
            console.log(`${result.status} ${result.statusText}`);
        }
    },
    (error) => {
        console.log(error.message);
    }
);

view raw xrm-webapi-online-execute-create.js hosted with ❤ by GitHub

Retrieve

var Sdk = window.Sdk || {};

/**
 * Request to update a record
 * @param {Object} entityReference - The entity reference.
 * @param {Array} columns - The columns.
 */
Sdk.RetrieveRequest = function (entityReference, columns) {
    this.entityReference = entityTypeName;
    this.columns = columns;
    this.getMetadata = function () {
        return {
            boundParameter: null,
            parameterTypes: {},
            operationType: 2,
            operationName: "Retrieve",
        };
    };
};

// Construct a request object from the metadata
var request = new Sdk.RetrieveRequest({ etn: "new_entity", id: "00000000-0000-0000-0000-000000000000" }, ["new_name"]);

// Use the request object to execute the function
Xrm.WebApi.online.execute(request).then(
    (result) => {
        if (result.ok) {
            console.log(`${result.status} ${result.statusText}`);
        }
    },
    (error) => {
        console.log(error.message);
    }
);

view raw xrm-webapi-online-execute-retrieve.js hosted with ❤ by GitHub

Update

var Sdk = window.Sdk || {};

/**
 * Request to update a record
 * @param {string} entityTypeName - The entity type name.
 * @param {string} id - The record ID.
 * @param {Object} payload - The entity payload.
 */
Sdk.UpdateRequest = function (entityTypeName, id, payload) {
    this.etn = entityTypeName;
    this.id = id;
    this.payload = payload;
    this.getMetadata = function () {
        return {
            boundParameter: null,
            parameterTypes: {},
            operationType: 2,
            operationName: "Update",
        };
    };
};

// Construct a request object from the metadata
var request = new Sdk.UpdateRequest("new_entity", "00000000-0000-0000-0000-000000000000", { "new_name": "Foo Bar" });

// Use the request object to execute the function
Xrm.WebApi.online.execute(request).then(
    (result) => {
        if (result.ok) {
            console.log(`${result.status} ${result.statusText}`);
        }
    },
    (error) => {
        console.log(error.message);
    }
);

view raw xrm-webapi-online-execute-update.js hosted with ❤ by GitHub

Delete

var Sdk = window.Sdk || {};

/**
 * Request to delete a record
 * @param {Object} entityReference - The entity reference.
 */
Sdk.DeleteRequest = function (entityReference) {
    this.entityReference = entityReference;
    this.getMetadata = function () {
        return {
            boundParameter: null,
            parameterTypes: {},
            operationType: 2,
            operationName: "Delete",
        };
    };
};

// Construct a request object from the metadata
var request = new Sdk.DeleteRequest({ entityType: "new_entity", id: "00000000-0000-0000-0000-000000000000" });

// Use the request object to execute the function
Xrm.WebApi.online.execute(request).then(
    (result) => {
        if (result.ok) {
            console.log(`${result.status} ${result.statusText}`);
        }
    },
    (error) => {
        console.log(error.message);
    }
);

view raw xrm-webapi-online-execute-delete.js hosted with ❤ by GitHub

CRUD Opertations with Xrm.WebApi.online.executeMultiple

Below are some of code samples for running CRUD operations using the Xrm.WebApi.online.executeMultiple method.

Note: As per the OData v4 specifications, you cannot include read operations as part of a change set.

Create

var Sdk = window.Sdk || {};

/**
 * Request to create a record
 * @param {string} entityTypeName - The entity type name.
 * @param {Object} payload - The entity payload.
 */
Sdk.CreateRequest = function (entityTypeName, payload) {
    this.etn = entityTypeName;
    this.payload = payload;
    this.getMetadata = function () {
        return {
            boundParameter: null,
            parameterTypes: {},
            operationType: 2,
            operationName: "Create",
        };
    };
};

// Construct a request object array from the metadata
var requests = [
    new Sdk.CreateRequest("new_entity", { "new_name": "Foo" }),
    new Sdk.CreateRequest("new_entity", { "new_name": "Bar" })
];

// Use the request object array to execute the function
Xrm.WebApi.online.executeMultiple(requests).then(
    (result) => {
        if (result.ok) {
            console.log(`${result.status} ${result.statusText}`);
        }
    },
    (error) => {
        console.log(error.message);
    }
);

view raw xrm-webapi-online-executemultiple-create.js hosted with ❤ by GitHub

Retrieve

var Sdk = window.Sdk || {};

/**
 * Request to update a record
 * @param {Object} entityReference - The entity reference.
 * @param {Array} columns - The columns.
 */
Sdk.RetrieveRequest = function (entityReference, columns) {
    this.entityReference = entityTypeName;
    this.columns = columns;
    this.getMetadata = function () {
        return {
            boundParameter: null,
            parameterTypes: {},
            operationType: 2,
            operationName: "Retrieve",
        };
    };
};

// Construct a request object array from the metadata
var requests = [
    new Sdk.RetrieveRequest({ etn: "new_entity", id: "00000000-0000-0000-0000-000000000000" }, ["new_name"]),
    new Sdk.RetrieveRequest({ etn: "new_entity", id: "00000000-0000-0000-0000-000000000000" }, ["new_name"])
];

// Use the request object array to execute the function
Xrm.WebApi.online.executeMultiple(requests).then(
    (result) => {
        if (result.ok) {
            console.log(`${result.status} ${result.statusText}`);
        }
    },
    (error) => {
        console.log(error.message);
    }
);

view raw xrm-webapi-online-executemultiple-retrieve.js hosted with ❤ by GitHub

Update

var Sdk = window.Sdk || {};

/**
 * Request to update a record
 * @param {string} entityTypeName - The entity type name.
 * @param {string} id - The record ID.
 * @param {Object} payload - The entity payload.
 */
Sdk.UpdateRequest = function (entityTypeName, id, payload) {
    this.etn = entityTypeName;
    this.id = id;
    this.payload = payload;
    this.getMetadata = function () {
        return {
            boundParameter: null,
            parameterTypes: {},
            operationType: 2,
            operationName: "Update",
        };
    };
};

// Construct a request object array from the metadata
var requests = [
    new Sdk.UpdateRequest("new_entity", "00000000-0000-0000-0000-000000000000", { "new_name": "Foo" }),
    new Sdk.UpdateRequest("new_entity", "00000000-0000-0000-0000-000000000000", { "new_name": "Bar" })
];

// Use the request object array to execute the function
Xrm.WebApi.online.executeMultiple(requests).then(
    (result) => {
        if (result.ok) {
            console.log(`${result.status} ${result.statusText}`);
        }
    },
    (error) => {
        console.log(error.message);
    }
);

view raw xrm-webapi-online-executemultiple-update.js hosted with ❤ by GitHub

Delete

var Sdk = window.Sdk || {};

/**
 * Request to delete a record
 * @param {Object} entityReference - The entity reference.
 */
Sdk.DeleteRequest = function (entityReference) {
    this.entityReference = entityReference;
    this.getMetadata = function () {
        return {
            boundParameter: null,
            parameterTypes: {},
            operationType: 2,
            operationName: "Delete",
        };
    };
};

// Construct a request object array from the metadata
var requests = [
    new Sdk.DeleteRequest({ entityType: "new_entity", id: "00000000-0000-0000-0000-000000000000" }),
    new Sdk.DeleteRequest({ entityType: "new_entity", id: "00000000-0000-0000-0000-000000000000" })
];

// Use the request object array to execute the function
Xrm.WebApi.online.executeMultiple(requests).then(
    (results) => {
        console.log(`${result.status} ${result.statusText}`);
    },
    (error) => {
        console.log(error.message);
    }
);

CRUD Opertations with Xrm.WebApi.online

<title>Modal Dialog</title>

.footer {

position: fixed;

bottom: 0;

right: 0;

padding-bottom: 10px;

padding-right: 10px;

}

.footerButton {

width: 150px;

}

</style>

var Category = {

PreferredCustomer : 1,

Standard: 2

};

var accountId = '';//'6869103d-d281-ec11-8d21-000d3ac9f173';

$(document).ready(function () {

//retrieveMultiple();

//createRecord();

//updateRecord();

//deleteRecord();

retrieveMultiple();

});

function getUrlParameters() {

var queryString = location.search.substring(1);

return queryString;

}

function createRecord()

{

var accountInfo = '';

var accountName = "Alex Ferguson";

var primaryContactId = "9fd4a450-cb0c-ea11-a813-000d3a1b1223"; //-- Amrit Consultancies

var primaryContactName = "Dwayne Elijah";

var accountCategoryCode = Category.Standard;

var annualRevenue = 7500000;

var entityData =

{

"name": accountName,

"revenue": annualRevenue, // Currency (money type) ---Display Text = Annual Revenue

"donotphone": false, //Two Option (boolean type) ---Display Text = Do not allow Phone Calls

"address1_longitude": 112.512634, //Floating Point Number (decimal type) --- Display Text = Address 1: Longitude

"address1_composite": "This is address 1", //Multiple Lines of Text (memo type) --- Display Text = Address 1

"accountcategorycode": accountCategoryCode, // Option Set --- Display Text = Category

"primarycontactid@odata.bind": "/contacts(" + primaryContactId + ")" //--- Lookup --- Display Text = Primary Contact

}

window.parent.Xrm.WebApi.createRecord("account", entityData).then(

function success(result) {

//Success - No Return Data

accountId = result.id;

var accountInfo = '';

accountInfo += 'Account Name = ' + accountName + '\n';

accountInfo += 'Primary Contact = ' + primaryContactName + '\n';

accountInfo += 'Category = Standard \n';

accountInfo += 'Annual Revenue = ' + annualRevenue + '\n';

alert("Account created. Details are given below : \n\n" + accountInfo + "\n\n" + "Going to update this record now.");

//updateRecord();

//return accountId;

function (error) {

alert(error.message);

}

);

}

function updateRecord() {

if (accountId != '') {

var accountInfo = '';

var accountName = "Modified - Alex Ferguson";

var primaryContactId = "cdd6a450-cb0c-ea11-a813-000d3a1b1223"; //-- Adrian Dumitrascu

var primaryContactName = "Haroun Stormonth";

var accountCategoryCode = Category.PreferredCustomer;

var annualRevenue = 800000;

var telephone1 = "8587016875";

var entityData =

{

"name": accountName,

"revenue": annualRevenue, // Currency (money type) ---Display Text = Annual Revenue

"donotphone": true, //Two Option (boolean type) ---Display Text = Do not allow Phone Calls

"address1_longitude": 78.23625, //Floating Point Number (decimal type) --- Display Text = Address 1: Longitude

"address1_composite": "Modified - This is address 1", //Multiple Lines of Text (memo type) --- Display Text = Address 1

"accountcategorycode": accountCategoryCode, // Option Set --- Display Text = Category

"telephone1": telephone1,

//--Contact Name = Adrian Dumitrascu

"primarycontactid@odata.bind": "/contacts(" + primaryContactId + ")" //--- Lookup --- Display Text = Primary Contact

}

window.parent.Xrm.WebApi.updateRecord("account", accountId, entityData).then(

function success(result) {

var accountInfo = '';

accountInfo += 'Account Name = ' + accountName + '\n';

accountInfo += 'Primary Contact = ' + primaryContactName + '\n';

accountInfo += 'Category = Preferred Customer \n';

accountInfo += 'Annual Revenue = ' + annualRevenue + '\n';

alert("Account updated successfully. Details are given below : \n\n" + accountInfo + "\n\n" + "Going to retrieve record.");

function (error) {

debugger;

// handle error conditions

console.log(error.message);

reject(error.message);

}

);

}

function deleteRecord() {

if (accountId != '') {

window.parent.Xrm.WebApi.deleteRecord("account", accountId).then(

function success(result) {

alert("Account deleted successfully. \n\n" + "Going to call retrieveMultiple() function now.");

// perform operations on record deletion

//retrieveMultiple();

function (error) {

debugger;

console.log(error.message);

// handle error conditions

});

}

function retrieveMultiple()

{

var query = '?$select=accountcategorycode,address1_addressid,address1_longitude,donotphone,name,_primarycontactid_value,revenue';

window.parent.Xrm.WebApi.online.retrieveMultipleRecords("account", query).then(

function success(accounts)

{

var results = accounts.entities;

var accountRecords = [];

results.forEach(function (result, index, array)

{

var _primarycontactid_value = result["_primarycontactid_value"];

var _primarycontactid_navigation_property = result["_primarycontactid_value@Microsoft.Dynamics.CRM.associatednavigationproperty"];

var _primarycontactid_value_lookuplogicalname = result["_primarycontactid_value@Microsoft.Dynamics.CRM.lookuplogicalname"];

var _primarycontactid_value_formatted = result["_primarycontactid_value@OData.Community.Display.V1.FormattedValue"];

var _transactioncurrencyid_value = result["_transactioncurrencyid_value"];

var _transactioncurrencyid_navigation_property = result["_transactioncurrencyid_value@Microsoft.Dynamics.CRM.associatednavigationproperty"];

var _transactioncurrencyid_value_lookuplogicalname = result["_transactioncurrencyid_value@Microsoft.Dynamics.CRM.lookuplogicalname"];

var _transactioncurrencyid_value_formatted = result["_transactioncurrencyid_value@OData.Community.Display.V1.FormattedValue"];

var accountcategorycode = result["accountcategorycode"];

var accountcategorycode_formatted = result["accountcategorycode@OData.Community.Display.V1.FormattedValue"];

var accountid = result["accountid"];

var address1_addressid = result["address1_addressid"];

var address1_longitude = result["address1_longitude"];

var address1_longitude_formatted = result["address1_longitude@OData.Community.Display.V1.FormattedValue"];

var donotphone = result["donotphone"];

var donotphone_formatted = result["donotphone@OData.Community.Display.V1.FormattedValue"];

var name = result["name"];

var revenue = result["revenue"];

var revenue_formatted = result["revenue@OData.Community.Display.V1.FormattedValue"];

var accountRecord = {};

accountRecord =

{

'name': name,

'account': accountid,

'revenue': revenue,

'id': accountid,

'editcode':'<a href="javascript:void(0);" onclick="(function(){accountId=\''+_primarycontactid_value+'\'; openEditForm();})();return false;">Edit</a>'

}

accountRecords.push(accountRecord);

});

$('table').bootstrapTable({ data: accountRecords });

//alert("Executed function retrieveMultipleRecords() successfully. \n\n "+ "Total Accounts retrieved = " + results.length);

function (error) {

debugger;

console.log(error.message);

// Reject promise

reject(Error(error.message));

});

}

function openEditForm()

{ // REDIRECT TO FORM

var entityFormOptions = {};

//Entity Name of which form is to open

entityFormOptions["entityName"] = "contact";

//Below parameter is required if you want ot edit a particular record

//entityFormOptions["entityId"] = accountId;

//Below parameter is required if you wish to open Quick Edit Form

entityFormOptions["useQuickCreateForm"] = true;

// Open the form.

window.parent.Xrm.Navigation.openForm(entityFormOptions).then(

function (success) {

console.log(success);

function (error) {

console.log(error);

});

}

function loadRecords(recordId) {

var $table = $("#leadtable");

var req = new XMLHttpRequest();

req.open("GET", parent.Xrm.Page.context.getClientUrl() + "/api/data/v9.1/leads?$select=_accountid_value,createdon,description,fullname", false);

req.setRequestHeader("OData-MaxVersion", "4.0");

req.setRequestHeader("OData-Version", "4.0");

req.setRequestHeader("Accept", "application/json");

req.setRequestHeader("Content-Type", "application/json; charset=utf-8");

req.setRequestHeader("Prefer", "odata.include-annotations=\"*\"");

req.onreadystatechange = function () {

if (this.readyState === 4) {

req.onreadystatechange = null;

if (this.status === 200) {

var results = JSON.parse(this.response);

var leadRecords = [];

for (var i = 0; i < results.value.length; i++) {

var _accountid_value = results.value[i]["_accountid_value"];

var _accountid_value_formatted = results.value[i]["_accountid_value@OData.Community.Display.V1.FormattedValue"];

var _accountid_value_lookuplogicalname = results.value[i]["_accountid_value@Microsoft.Dynamics.CRM.lookuplogicalname"];

var createdon = results.value[i]["createdon"];

var description = results.value[i]["description"];

var fullname = results.value[i]["fullname"];

var leadid = results.value[i]["leadid"];

var leadRecord = {};

leadRecord =

{

'name': fullname,

'account': _accountid_value,

'description': description,

'id': leadid

}

leadRecords.push(leadRecord);

}

$('table').bootstrapTable({ data: leadRecords });

}

else {

Xrm.Utility.alertDialog(this.statusText);

}

};

req.send();

}

</script>

<div>

<thead>

<tr>

<th data-field="account" data-sortable="true">Account</th>

<th data-field="revenue" data-sortable="true">Description</th>

</tr>

</thead>

</table>

</div>

</body></html>

Search This Blog

Sunday, January 30, 2022

CRUD operations with Xrm.WebApi.online.execute and Xrm.WebApi.online.executeMultiple

CRUD Opertations with Xrm.WebApi.online.execute

Create

Retrieve

Update

Delete

CRUD Opertations with Xrm.WebApi.online.executeMultiple

Create

Retrieve

Update

Delete

CRUD Opertations with Xrm.WebApi.online

My Latest Top 10 Post Of Ram Share Point Journey With Details

	var Sdk = window.Sdk \|\| {};

	/**
	* Request to create a record
	* @param {string} entityTypeName - The entity type name.
	* @param {Object} payload - The entity payload.
	*/
	Sdk.CreateRequest = function (entityTypeName, payload) {
	this.etn = entityTypeName;
	this.payload = payload;
	this.getMetadata = function () {
	return {
	boundParameter: null,
	parameterTypes: {},
	operationType: 2,
	operationName: "Create",
	};
	};
	};

	// Construct a request object from the metadata
	var request = new Sdk.CreateRequest("new_entity", { "new_name": "Foo Bar" });

	// Use the request object to execute the function
	Xrm.WebApi.online.execute(request).then(
	(result) => {
	if (result.ok) {
	console.log(`${result.status} ${result.statusText}`);
	}
	},
	(error) => {
	console.log(error.message);
	}
	);

	var Sdk = window.Sdk \|\| {};

	/**
	* Request to update a record
	* @param {Object} entityReference - The entity reference.
	* @param {Array} columns - The columns.
	*/
	Sdk.RetrieveRequest = function (entityReference, columns) {
	this.entityReference = entityTypeName;
	this.columns = columns;
	this.getMetadata = function () {
	return {
	boundParameter: null,
	parameterTypes: {},
	operationType: 2,
	operationName: "Retrieve",
	};
	};
	};

	// Construct a request object from the metadata
	var request = new Sdk.RetrieveRequest({ etn: "new_entity", id: "00000000-0000-0000-0000-000000000000" }, ["new_name"]);

	// Use the request object to execute the function
	Xrm.WebApi.online.execute(request).then(
	(result) => {
	if (result.ok) {
	console.log(`${result.status} ${result.statusText}`);
	}
	},
	(error) => {
	console.log(error.message);
	}
	);