Wondering what’s next for npm?Check out our public roadmap! »

    xrm-webapi
    TypeScript icon, indicating that this package has built-in type declarations

    7.1.3 • Public • Published

    xrm-webapi

    Build NPM
    Build Status npm

    A Dynamics 365 Web Api TypeScript module for use in web resources or external web apps in the browser or node.

    All requests return Promises. To support Internet Explorer, be sure to include a promise polyfill when deploying to CRM.

    Requires Dynamics CRM 2016 Online/On-Prem or later

    Installation

    Node
    npm install xrm-webapi
    

    Usage

    Browser

    import { parseGuid, retrieve, WebApiConfig } from "xrm-webapi";
     
    const config = new WebApiConfig("8.2");
     
    const account = await retrieve(config, "accounts", parseGuid("00000000-0000-0000-0000-000000000000"), "$select=name");
     
    console.log(account.name);

    Node

    import { parseGuid, retrieve, WebApiConfig } from "xrm-webapi/dist/xrm-webapi-node";
     
    const config = new WebApiConfig("8.2", tokenFromAdal, 'https://org.crm.dynamics.com');
     
    const account = await retrieve(config, "accounts", parseGuid("00000000-0000-0000-0000-000000000000"), "$select=name");
     
    console.log(account.name);

    Angular

    For use in Angular applications, I'd first recommend using their built in HttpClient. Besides batch operations, most D365 Web Api requests are pretty simple to construct. If you do want to use this library, the usage is the same as the browser usage:

    import { parseGuid, retrieveNode, WebApiConfig } from "xrm-webapi";
     
    const config = new WebApiConfig("8.2", tokenFromAdal, 'https://org.crm.dynamics.com');
     
    const account = await retrieve(config, "accounts", parseGuid("00000000-0000-0000-0000-000000000000"), "$select=name");
     
    console.log(account.name);

    Supported methods

    • Retrieve
    • Retrieve multiple (multiple pages)
    • Retrieve multiple with Fetch XML
    • Create
    • Create with returned data
    • Update
    • Update with returned data
    • Update single property
    • Delete
    • Delete single property
    • Associate
    • Disassociate
    • Web API Functions
    • Web API Actions
    • Batch operations
    • Impersonation

    Samples

    See xrm-webapi-samples.ts for examples

    Useful Links

    Web API Reference

    Install

    npm i xrm-webapi

    DownloadsWeekly Downloads

    195

    Version

    7.1.3

    License

    MIT

    Unpacked Size

    79.2 kB

    Total Files

    17

    Last publish

    Collaborators

    • avatar