Retrieving Data with the Dynamics Web API

So after I worked that whole plural entity name thing on getting data from Dynamics, I now had my data coming back to me in a wonderful Json format.  When interacting with data from the Web API you query for information via the rest interface of your URL. (more on MSDN).

As an example, if I wanted to retrieve some information on a custom entity I could do it using this query syntax.

HttpResponseMessage response = await httpClient.GetAsync(dyanmicsTenant + "/api/data/v8.1/enc_medias?$select=dat_name,_dat_customer_value,dat_dataid&$filter=dat_name eq '" + SearchParameter + "'");

Which would return a Json package in the format of

{
"@odata.context":"https://myCrmTenant.crm.dynamics.com/api/data/v8.1/$metadata#datas(dat_dataid,dat_name)","value":[
{
"@odata.etag":"W/\"874140\"","dat_dataid":"fd95bfa1-ddb8-e711-8114-c4346bdcf161","_dat_customer_value":"{00665E23-779E-4C8C-A5D4-36213C41EA27}","dat_name":"0000000006"
}
]
}

A few things…

What is _dat_customer_value?

In my query, I wanted to get the lookup for a customerid, the field itself is called data_customerid, however, when accessing lookups you must prepend “_” to the field and append “_value” to the end of the field.  Once done this will return to you the guid of the record that is your lookup.

What’s the easiest way to get at the data?

You can write a converter to parse your JSON data to an OData object.  I ran into a few problems here but also wanted to understand things a little more so I used a JObject.

var s = await response.Content.ReadAsStringAsync();

JObject results = Newtonsoft.Json.JsonConvert.DeserializeObject<JObject>(s);

With the JObject, I was then able to access the “value” node of the results and access my data in a similar fashion as I would if I was LateBinding entities with the old SDK.  It’s not super pretty, but it’s solid, it works and you can easily see grasp what’s happening here.

if (results["value"].HasValues)
 {
 record.Id = new Guid(results["value"][0]["dat_dataid"].ToString());
 record.Name = results["value"][0]["dat_name"].ToString();
 record.Customer = new Guid(results["value"][0]["_dat_customer_value"].ToString());

 }

So now we can query and retrieve our data in the most simplest of manners.

Getting Started with the Dynamics Web API

The Dynamics Web API is the new “preferred” method for interacting with Dynamics entities from web-based applications.  If you are writing plugins and coded workflow activities, you would still use the pre-existing Dynamics SDK.

Getting familiar with the Web API is a bit of a leap of knowledge as you will dabble in Azure Authentication, JSON and Async implementations (if you’re not familiar with it).

Even though the API has been around since 2016, it’s disheartening to see there not being a singular location for Dynamics developers to bridge their current knowledge of the Dynamics SDK to the Web API.

Lots of trial and error still exists and this isn’t helped by the naming of the API either.

Also note, if you are hoping to get away with the now “vintage” Dynamics SDK, in new ASP.NET Web API Core projects, this API is unsupported due to its requirements for embedded Network Credentials.

The first thing you need to do in making your first connection is to authorize yourself in your tenant’s azure environment before doing anything.  The MSDN walkthrough will take you through this in a straightforward way.

One caveat that I cannot stress enough is the redirect URL of your application.  In the scenario, I am running through it is a basic console application so in this case, I don’t have a redirect URL to go to, but you need one.  And when providing the initial connection from your application, you’ll need to include it for your connection to work.

For my connection, I used the following value.

Capture2

The following is the heart of your initial connection and only requires references to the Microsoft.IdentityModel.Clients.ActiveDirectory and Newtonsoft.Json packages.

Untitled

The tenant id is the URL to your Azure tenant while the dynamicCRMTenant is the url to your own Dynamics tenant.  The key thing to note in your initial request to get “all your accounts” is that you are no longer querying for an entity by their schema name but rather the plural name – “accounts”.

So now, you have the simplest method of establishing your base connection.

Accessing the Dynamics SDK in v9

If you are moving your work from an old Dynamics instance to v9, there are a few SDK to know about before you get started.

First – there is no SDK to download anymore.

Well, there is, but you do it through Nuget (and it’s great).

To install the core SDK framework – use the following Nuget command.

Install-Package Microsoft.CrmSdk.CoreAssemblies -Version 9.0.0.7

This will install all the core assemblies you need (i.e., not things like workflow assemblies).

To get the workflows you would need to execute the following Nuget command;

Install-Package Microsoft.CrmSdk.Workflow -Version 9.0.0.7

Different from the last few versions of Dynamics where you could get away with re-using SDK tools between different versions, with v9, you now need to download the updated set of tools via Powershell and use them from there.

Before downloading the tools, make sure you are in the right directory to where you want them installed (i.e., not system32).

After you have downloaded them, the usage of the tools is relatively the same (I’ve only played around with the PlugIn workflow registration tool).