dataverse-webapi

Dataverse Web Api TypeScript Module

Usage no npm install needed!

<script type="module">
  import dataverseWebapi from 'https://cdn.skypack.dev/dataverse-webapi';
</script>

README

dataverse-webapi

NPM
npm

A Dataverse 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 dataverse-webapi

Usage

Browser

import { parseGuid, retrieve, WebApiConfig } from 'dataverse-webapi';

const config = new WebApiConfig('9.1')

const account = await retrieve(config, 'accounts', parseGuid('00000000-0000-0000-0000-000000000000'), '$select=name');

console.log(account.name);

Node

import { parseGuid, retrieve, WebApiConfig } from 'dataverse-webapi/lib/node';

const config = new WebApiConfig('9.1', 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 'dataverse-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 using Azure Object Id

Samples

See samples.ts for examples

Useful Links

Web API Reference