Ready to get started?

Learn more about CData API Server or sign up for a free trial:

Learn More

Query Microsoft CDS Data from Node.js

The API Server exposes Web services that allow connectivity to your data. Use the OData endpoint of the CData API Server to execute CRUD queries to Microsoft CDS data from Node.js.

The CData API Server, when paired with the ADO.NET Provider for Microsoft CDS, exposes Microsoft CDS data (or data from any of 160+ other ADO.NET Providers) as an OData endpoint, which can be queried from Node.js using simple HTTP requests. This article shows how to use the API Server to request JSON-formatted Microsoft CDS data in Node.js.

Set Up the API Server

Follow the steps below to begin producing secure Microsoft CDS OData services:

Deploy

The API Server runs on your own server. On Windows, you can deploy using the stand-alone server or IIS. On a Java servlet container, drop in the API Server WAR file. See the help documentation for more information and how-tos.

The API Server is also easy to deploy on Microsoft Azure, Amazon EC2, and Heroku.

Connect to Microsoft CDS

After you deploy the API Server and the ADO.NET Provider for Microsoft CDS, provide authentication values and other connection properties needed to connect to Microsoft CDS by clicking Settings -> Connections and adding a new connection in the API Server administration console.

You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • OrganizationUrl: Set this to the organization URL you are connecting to, such as https://myorganization.crm.dynamics.com.
  • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

When you connect the Common Data Service OAuth endpoint opens in your default browser. Log in and grant permissions. The OAuth process completes automatically.

You can then choose the Microsoft CDS entities you want to allow the API Server access to by clicking Settings -> Resources.

Authorize API Server Users

After determining the OData services you want to produce, authorize users by clicking Settings -> Users. The API Server uses authtoken-based authentication and supports the major authentication schemes. Access can also be restricted based on IP address; all IP addresses except the local machine are restricted by default. You can authenticate as well as encrypt connections with SSL.

Consume Microsoft CDS OData Feeds from Node.js

OData feeds are easy to work with in Node.js. You can use the HTTP client in Node.js to request JSON-formatted data from the API Server's OData endpoint. After making the request, you can construct the body of the response and call the JSON.parse() function to parse it into records.

The code below will make an authenticated request for Accounts data. The example URL below applies a simple filter that searches for records with a value of MyAccount in the Name column.

var http = require('http'); http.get({ protocol: "http:", hostname: "MyServer.com", port: MyPort, path: "/api.rsc/Accounts?$filter=" + encodeURIComponent("Name eq 'MyAccount'"), auth: 'MyUser:MyAuthtoken' }, function(res) { var body = ''; res.on('data', function(chunk) { body += chunk; }); res.on('end', function() { console.log(body); var jsonData = JSON.parse(body); }); }).on('error', function(e) { console.log("Error: ", e); });