❤
npm
Sign UpSign In

crm-sdk

4.0.9 • Public • Published

CRM-SDK

npm npm npm

Javascript Software Development Kit for Dynamics CRM Web API.

Recommendation

This library was written while Microsoft was still inventing Xrm.WebApi. Nowadays the Xrm Api will do most for you. This library may still be usefull when implementing a SPA, but we recommend using another NPM package to develop your D365 project.

Please have a look at the HSO D365 Command Line Interface. That @hso/d365-cli package also contains a WebApi as wrapper to help you building odata queries in an easier way.

Why another library

There are several SDK's available, so why another one?

  • This library does paging for you (using @odata-nextLink to do multiple requests)
  • This library always finds correct entitySetName (which is not always: LogicalName + 's')
  • This library is promise based
  • This library supports modules
  • This library supports default WebAPI like other libraries, but also
  • This library supports extra Entity abstraction
  • This library supports annotations
  • This library supports getting OptionSet
  • This library supports Webresource uploading/publishing
  • This library supports Translation

Table of contents

Install

Install with Npm

$ npm install crm-sdk

Modules

//app.js
import {WebAPI} from "crm-sdk";
 
WebAPI.retrieveEntity("account", "475b158c-541c-e511-80d3-3863bb347ba8").then(function (data) {
    //todo logic here
});

Require

//app.js
var CRMSDK = require("crm-sdk"); //umd
var WebAPI = CRMSDK.WebAPI;
 
WebAPI.retrieveEntity("account", "475b158c-541c-e511-80d3-3863bb347ba8").then(function (data) {
    //todo logic here
});

Install via download

Download latest release and put reference to dist/CRMSDK.js in your index.html.

In example below, the app.js is your own application code. If you only need CRMSDK.WebAPI, you can include WebAPI.js in index.html instead of CRMSDK.js.

<html>
<body>
    <script type="text/javascript" src="CRMSDK.js"/>
    <script type="text/javascript" src="app.js"/>
</body>
</html>

In app.js, The WebAPI will be available on window.CRMSDK scope. Example for using WebAPI below:

//app.js
var WebAPI = window.CRMSDK.WebAPI;
 
WebAPI.retrieveEntity("account", "475b158c-541c-e511-80d3-3863bb347ba8").then(function (data) {
    //todo logic here 
});

WebAPI example

Index.html

<html>
<body>
    <script type="text/javascript" src="WebAPI.js"/>
    <script type="text/javascript" src="app.js"/>
</body>
</html>

app.js

    WebAPI.retrieveEntity("account", "475b158c-541c-e511-80d3-3863bb347ba8")
    .then(function (accountData) {
        WebAPI.updateEntity("account", accountData.accountid, {
            emailaddress1: "test2@company.com"
        }).then(function (data) {
            console.log("saved " + data.accountid);
        });
    });

Entity abstraction example

Index.html

<html>
<body>
    <script type="text/javascript" src="CRMSDK.js"/>
    <script type="text/javascript" src="app.js"/>
</body>
</html>

app.js

    var WebAPI = CRMSDK.WebAPI;
    var Entity = CRMSDK.Entity;
 
    Entity.get("account", "475b158c-541c-e511-80d3-3863bb347ba8")
    .then(function (account) {
        account.emailaddress1 = "test2@company.com";
        account.save().then(function () {
            console.log("saved! " + account.accountid);
        });
    });

Copyright and license

Code and documentation copyright 2011-2017 Dynamics Software. Code released under the MIT License.

Dependents (0)

Package Sidebar

Install

npm i crm-sdk

Repository

github.com/hso-nn/crm-sdk

Homepage

github.com/hso-nn/crm-sdk#readme

Weekly Downloads

21

Version

4.0.9

License

MIT

Unpacked Size

389 kB

Total Files

42

Last publish

Collaborators

  • dys-solutions
  • nsteenbeek
Try on RunKit
Report malware