Batch operation ($batch) using OData API Dynamics 365

What is Issue?

There are OData API provided by Microsoft to perform operations on D365 Tables like Create, update, delete and retrieve. These operations can be perform individually by building the OData API using some tools or with your knowledge. But some time there are the cases where you need to call the bulk create, bulk update, bulk delete or some bulk create and bulk update/delete simultaneously. If there are more than one records, you need to hit OData API one by one multiple times which takes cost in terms of time and performance of the application which is calling OData API. Is there a way to combine these all requests in one call and execute?

The Reason-

There is way to perform the CRUD operations on D365 Tables using OData, but everyone aware of the single operations. Microsoft provides the way to perform Batch operation on Tables using OData API. Lets see in solution for this.

Solution-

Microsoft D365 provides the OData for batch operation to perform using “$batch” like-

https://your_org.crm8.dynamics.com/api/data/v8.2/$batch

You need to include the all other CRUD (POST, PATCH, DELETE, GET) OData APIs in the body for the above request URL.

This request works like all other OData APIs using OAuth2.0 authentication with proper headers added.

Lets take .Net application where I need to perform the Create, update and some delete operation in one call.

You have to prepare your request as below-

Preparing the Batch Call-

#region prepare Batch Call
        private string BatchQueryCall(string crmRestQuery, string batchName, string requestBody)
        {
            string funResponse = null;
            try
            {
                HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, crmRestQuery);
                //add header parameters
                request.Headers.Add("Authorization", "Bearer " + oauthToken);
                request.Headers.Add("Accept", "application/json");
                request.Content = new StringContent(requestBody);
                request.Content.Headers.ContentType = MediaTypeHeaderValue.Parse("multipart/mixed;boundary=" + batchName);

                HttpResponseMessage response = httpClient.SendAsync(request).Result;
                string responseString = response.Content.ReadAsStringAsync().Result;

                if (response.IsSuccessStatusCode)
                {
                    funResponse = responseString;
                }
                else
                    funResponse = responseString;

            }
            catch (Exception ex)
            {
                funResponse = ex.Message;
            }
            return funResponse;
        }
        #endregion

Preparing to Call Batch Operation-

Suppose I have to create one record, update one record and delete 2 records in same call.
Below code helps you to understand preparing the Batch call-

  #region bulk Operations
        public string BulkOperationsAPI(string entityname)
        {
            #region Local Variable
            string crmRestQuery = apiUrl + "$batch";
            string batchName = "batch_bt123";
            string changeSetVar = "changeset_ch123";
            int coRelId = 1;
            string changeSet1 = null;
            string requestBody = "--" + batchName + Environment.NewLine
                             + "Content-Type:multipart/mixed;boundary=" + changeSetVar + Environment.NewLine + Environment.NewLine + Environment.NewLine;
            #endregion

            #region Create
                //Creating one record
                CreateUpdateOpportunity entity = new CreateUpdateOpportunity();

                entity.transactioncurrencyid_odata_bind = "/transactioncurrencies(c63ba581-6bc6-e811-a96f-000d3af04fb0)";
                entity.estimatedvalue = 1000;
                entity.estimatedclosedate = "2021-01-01";
                entity.name = "Generated From C# Code";
                entity.parentaccountid_odata_bind = "/accounts(3b3b7c71-61d2-ea11-a813-000d3af0205e)";

                changeSet1 = PrepareReuqestBody("POST", changeSetVar, coRelId++, entityname, null, entity);

                if (!string.IsNullOrEmpty(changeSet1))
                    requestBody += changeSet1 + Environment.NewLine;
            
            #endregion

            #region Update
                //updating One record
                CreateUpdateOpportunity entity1 = new CreateUpdateOpportunity();

                entity1.transactioncurrencyid_odata_bind = "/transactioncurrencies(c63ba581-6bc6-e811-a96f-000d3af04fb0)";
                entity1.estimatedvalue = 1000;
                entity1.estimatedclosedate = "2021-01-01";
                entity1.name = "Generated From CSharp Code";
                entity1.parentaccountid_odata_bind = "/accounts(3b3b7c71-61d2-ea11-a813-000d3af0205e)";

                changeSet1 = PrepareReuqestBody("PATCH", changeSetVar, coRelId++, entityname, "20e6bb72-2861-eb11-a812-0022486e93ce", entity1);

                if (!string.IsNullOrEmpty(changeSet1))
                    requestBody += changeSet1 + Environment.NewLine;
            #endregion

            #region Delete
            //delete 1st record  
            changeSet1 = PrepareReuqestBody("DELETE", changeSetVar, coRelId++, entityname, "29e6bb72-2861-eb11-a812-0022486e93ce", null);
                if (!string.IsNullOrEmpty(changeSet1))
                    requestBody += changeSet1 + Environment.NewLine;

            //delete 2nd record
            changeSet1 = PrepareReuqestBody("DELETE", changeSetVar, coRelId++, entityname, "27e6bb72-2861-eb11-a812-0022486e93ce", null);
            if (!string.IsNullOrEmpty(changeSet1))
                requestBody += changeSet1 + Environment.NewLine;
            #endregion


            requestBody += "--" + changeSetVar + "--" + Environment.NewLine;
            requestBody += "--" + batchName + "--";
            
            //format the body URLs
            requestBody = requestBody.Replace("\\/", "/");  

            //call the batch Operations
            return BatchQueryCall(crmRestQuery, batchName, requestBody);
        }
        #endregion

Preparing the body content of Batch call-

In above code there is call made to the function PrepareRequestBody-
This function will prepare the body content of Batch call.

        #region Prepare Request Body
        private string PrepareReuqestBody(string method, string changeset, int contentId, string entityName, string recordid, object entity)
        {

            string x = null;
            switch (method.ToUpper())
            {
                case "PATCH":
                    using (MemoryStream streamOpportunitySerialize = new MemoryStream())
                    {
                        DataContractJsonSerializer ser = new DataContractJsonSerializer(entity.GetType());
                        ser.WriteObject(streamOpportunitySerialize, entity);
                        streamOpportunitySerialize.Position = 0;
                        StreamReader srOpportunity = new StreamReader(streamOpportunitySerialize);
                        string objectJSON = srOpportunity.ReadToEnd();
                        objectJSON = objectJSON.Replace("_odata_bind", "@odata.bind");

                        x = "--" + changeset + Environment.NewLine
                            + "Content-Type: application/http" + Environment.NewLine
                            + "Content-Transfer-Encoding: binary" + Environment.NewLine
                            + "Content-ID: " + contentId + Environment.NewLine + Environment.NewLine
                            + "PATCH " + apiUrl + entityName + "(" + recordid + ") HTTP/1.1" + Environment.NewLine
                            + "Content-Type: application/json;type=entry" + Environment.NewLine
                            + "Accept:application/json" + Environment.NewLine + Environment.NewLine
                            + objectJSON + Environment.NewLine + Environment.NewLine;
                    }
                    break;
                case "POST":
                    using (MemoryStream streamOpportunitySerialize = new MemoryStream())
                    {
                        DataContractJsonSerializer ser = new DataContractJsonSerializer(entity.GetType());
                        ser.WriteObject(streamOpportunitySerialize, entity);
                        streamOpportunitySerialize.Position = 0;
                        StreamReader srOpportunity = new StreamReader(streamOpportunitySerialize);
                        string objectJSON = srOpportunity.ReadToEnd();
                        objectJSON = objectJSON.Replace("_odata_bind", "@odata.bind");

                        x = "--" + changeset + Environment.NewLine
                            + "Content-Type: application/http" + Environment.NewLine
                            + "Content-Transfer-Encoding: binary" + Environment.NewLine
                            + "Content-ID: " + contentId + Environment.NewLine + Environment.NewLine
                            + "POST " + apiUrl + entityName + " HTTP/1.1" + Environment.NewLine
                            + "Content-Type: application/json;type=entry" + Environment.NewLine
                            + "Accept:application/json" + Environment.NewLine + Environment.NewLine
                            + objectJSON + Environment.NewLine + Environment.NewLine;
                    }

                    break;
                case "DELETE":
                    x = "--" + changeset + Environment.NewLine
                    + "Content-Type: application/http" + Environment.NewLine
                    + "Content-Transfer-Encoding: binary" + Environment.NewLine
                    + "Content-ID: " + contentId + Environment.NewLine + Environment.NewLine
                    + "DELETE " + apiUrl + entityName + "(" + recordid + ") HTTP/1.1" + Environment.NewLine
                    + "Accept:application/json" + Environment.NewLine + Environment.NewLine;
                    break;
            }

            return x;
        }
        #endregion

Request Body content will look like-

--batch_bt123
Content-Type:multipart/mixed;boundary=changeset_ch123


--changeset_ch123
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: 1

POST https://your_org.crm8.dynamics.com/api/data/v8.2/opportunities HTTP/1.1
Content-Type: application/json;type=entry
Accept:application/json

{"estimatedclosedate":"2021-01-01","estimatedvalue":1000,"name":"Generated From C# Code","parentaccountid@odata.bind":"/accounts(3b3b7c71-61d2-ea11-a813-000d3af0205e)","transactioncurrencyid@odata.bind":"/transactioncurrencies(c63ba581-6bc6-e811-a96f-000d3af04fb0)"}


--changeset_ch123
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: 2

PATCH https://your_org.crm8.dynamics.com/api/data/v8.2/opportunities(d659b4d6-0f5b-eb11-a812-6045bd727e64) HTTP/1.1
Content-Type: application/json;type=entry
Accept:application/json

{"estimatedclosedate":"2021-01-01","estimatedvalue":1000,"name":"Generated From CSharp Code","parentaccountid@odata.bind":"/accounts(3b3b7c71-61d2-ea11-a813-000d3af0205e)","transactioncurrencyid@odata.bind":"/transactioncurrencies(c63ba581-6bc6-e811-a96f-000d3af04fb0)"}


--changeset_ch123
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: 3

DELETE https://your_org.crm8.dynamics.com/api/data/v8.2/opportunities(46c9eab1-5ac2-4673-a55a-51cb886db902) HTTP/1.1
Accept:application/json


--changeset_ch123
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: 4

DELETE https://your_org.crm8.dynamics.com/api/data/v8.2/opportunities(d659b4d6-0f5b-eb11-a812-6045bd727e64) HTTP/1.1
Accept:application/json


--changeset_ch123--
--batch_bt123--

Response recieved will be like-

  --batchresponse_319a4c10-b7fe-4bf0-b4a6-da016d1c0319
Content-Type: multipart/mixed; boundary=changesetresponse_ee30dcdb-1094-4c24-8170-262eae9336a4

--changesetresponse_ee30dcdb-1094-4c24-8170-262eae9336a4
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: 1

HTTP/1.1 204 No Content
OData-Version: 4.0
Location: https://your_org.crm8.dynamics.com/api/data/v8.2/opportunities(3d4916b4-3861-eb11-a812-0022486e93ce)
OData-EntityId: https://your_org.crm8.dynamics.com/api/data/v8.2/opportunities(3d4916b4-3861-eb11-a812-0022486e93ce)


--changesetresponse_ee30dcdb-1094-4c24-8170-262eae9336a4
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: 2

HTTP/1.1 204 No Content
OData-Version: 4.0
Location: https://your_org.crm8.dynamics.com/api/data/v8.2/opportunities(d659b4d6-0f5b-eb11-a812-6045bd727e64)
OData-EntityId: https://your_org.crm8.dynamics.com/api/data/v8.2/opportunities(d659b4d6-0f5b-eb11-a812-6045bd727e64)


--changesetresponse_ee30dcdb-1094-4c24-8170-262eae9336a4
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: 3

HTTP/1.1 204 No Content
OData-Version: 4.0


--changesetresponse_ee30dcdb-1094-4c24-8170-262eae9336a4
Content-Type: application/http
Content-Transfer-Encoding: binary
Content-ID: 4

HTTP/1.1 204 No Content
OData-Version: 4.0


--changesetresponse_ee30dcdb-1094-4c24-8170-262eae9336a4--
--batchresponse_319a4c10-b7fe-4bf0-b4a6-da016d1c0319--

For Token Generation you can refer the code in my last blog – https://mscrm16tech.com/2021/01/21/crud-operations-on-dynamics-365-crm-tables-with-odata-api/

Hope this will help…
Enjoy Ms CRM!!!

Follow on Facebook- FB: MSCRM16Tech

CRUD Operations on Dynamics 365 CRM Tables with ODATA API

What is Issue?

Performing CRUD operation on Dynamics 365 CRM using API (Rest/ODATA) from other applications.

The Reason-

While performing integration of other application with CRM, creating custom Web API and webservice is having much efforts in terms of time and development. Microsoft already made developers job easy by providing the ODATA API available for their products. How to consume that API in other applications.

Solution-

While performing integration of other application with CRM, rather than creating the custom API or webservice, we can utilize ODATA APIs that can be consumed with the OAuth 2.0 authentication.

Lets take .net application which is consuming ODATA API.

Some time we don’t want to include any third party dll due to some environmental restrictions. so the sample code added below is using only system libraries.

(In case of Json serialization, you can utilize Newtonsoft.Json to avoid the classes to be written manually)

Create records using ODATA API-

#region Create API Call
        /// <summary>
        /// Create the entity Record using API Call
        /// </summary>
        /// <param name="entityname">entity Name</param>
        /// <param name="entity">entity Object with parameter values</param>
        /// <returns></returns>
        public string CreateAPI(string entityname, object entity)
        {
            string funResponse = null;
            string query = entityname;
            string crmRestQuery = apiUrl + query;

            try
            {
                using (MemoryStream streamOpportunitySerialize = new MemoryStream())
                {
                    DataContractJsonSerializer ser = new DataContractJsonSerializer(entity.GetType());
                    ser.WriteObject(streamOpportunitySerialize, entity);
                    streamOpportunitySerialize.Position = 0;
                    StreamReader srOpportunity = new StreamReader(streamOpportunitySerialize);
                    string objectJSON = srOpportunity.ReadToEnd();
                    objectJSON = objectJSON.Replace("_odata_bind", "@odata.bind");

                    HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Post, crmRestQuery);
                    //add header parameters
                    request.Headers.Add("Authorization", "Bearer " + oauthToken);
                    request.Content = new StringContent(objectJSON);
                    request.Content.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json; charset=utf-8");

                    HttpResponseMessage response = httpClient.SendAsync(request).Result;
                    string responseString = response.Content.ReadAsStringAsync().Result;

                    if (response.IsSuccessStatusCode)
                    {
                        string _recordUrl = response.Headers.GetValues("OData-EntityId").FirstOrDefault();
                        string[] splitRetrievedData = _recordUrl.Split('[', '(', ')', ']');
                        funResponse = splitRetrievedData[1];
                    }
                    else
                        funResponse = responseString;

                }
            }
            catch (Exception ex)
            {
                funResponse = ex.Message;
            }
            return funResponse;
        }
        #endregion

Update records using ODATA API-

  #region Update API Call
        /// <summary>
        /// Update the entity record using API Call
        /// </summary>
        /// <param name="entityname">entity name</param>
        /// <param name="entityid">entity id</param>
        /// <param name="entity">entity Object with parameter values</param>
        /// <returns></returns>
        public string UpdateAPI(string entityname, string entityid, object entity)
        {
            string funResponse = null;
            string query = entityname + "(" + entityid + ")";
            string crmRestQuery = apiUrl + query;
            try
            {
                using (MemoryStream streamOpportunitySerialize = new MemoryStream())
                {

                    DataContractJsonSerializer ser = new DataContractJsonSerializer(entity.GetType());
                    ser.WriteObject(streamOpportunitySerialize, entity);
                    streamOpportunitySerialize.Position = 0;
                    StreamReader srOpportunity = new StreamReader(streamOpportunitySerialize);
                    string objectJSON = srOpportunity.ReadToEnd();
                    objectJSON = objectJSON.Replace("_odata_bind", "@odata.bind");

                    HttpMethod method = new HttpMethod("PATCH");
                    HttpRequestMessage request = new HttpRequestMessage(method, crmRestQuery);
                    //add header parameters
                    request.Headers.Add("Authorization", "Bearer " + oauthToken);
                    request.Headers.Add("If-Match", "*");      //preventing creation of new record if no record found with ID
                    request.Content = new StringContent(objectJSON);
                    request.Content.Headers.ContentType = MediaTypeHeaderValue.Parse("application/json; charset=utf-8");

                    HttpResponseMessage response = httpClient.SendAsync(request).Result;
                    string responseString = response.Content.ReadAsStringAsync().Result;
                    if (response.IsSuccessStatusCode)
                    {
                        funResponse = "Sucessfully Updated Record!!";
                    }
                    else
                        funResponse = responseString;
                }
            }
            catch (Exception ex)
            {
                funResponse = ex.Message;
            }
            return funResponse;
        }
        #endregion

Delete records using ODATA API-

#region Delete API Call
        /// <summary>
        /// Delete the entity Record using API Call
        /// </summary>
        /// <param name="entityname">entity Name</param>
        /// <param name="entityid">Entity id</param>
        /// <returns></returns>
        public string DeleteAPI(string entityname, string entityid)
        {
            string funResponse = null;
            string query = entityname + "(" + entityid + ")";
            string crmRestQuery = apiUrl + query;

            try
            {
                HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Delete, crmRestQuery);
                //add header parameters
                request.Headers.Add("Authorization", "Bearer " + oauthToken);
                request.Headers.Add("Accept", "application/json; charset=utf-8");

                HttpResponseMessage response = httpClient.SendAsync(request).Result;
                string responseString = response.Content.ReadAsStringAsync().Result;
                if (response.IsSuccessStatusCode)
                    funResponse = "Deleted!!!";
                else
                    funResponse = responseString;
            }
            catch (Exception ex)
            {
                funResponse = ex.Message;
            }
            return funResponse;
        }
        #endregion

Retrieve Single record using ODATA API-

 /// <summary>
        /// Retrieve single using API Call
        /// </summary>
        /// <param name="entityPluralName">entity Name</param>
        /// <param name="entityId">entity id</param>
        /// <param name="entityObject">blank entity object</param>
        /// <param name="selectColumns">select columns to retrieve in API Call</param>
        /// <returns>Object of entity</returns>
        public object RetrieveSingle(string entityPluralName,string entityId,object entityObject, string selectColumns=null)
        {
            string query = "("+entityId+")";
            if (selectColumns != null) {
                query += "?$select=" + selectColumns;
            }
            string crmRestQuery = apiUrl + entityPluralName + query;
            try
            {
                    HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, crmRestQuery);
                    //add header parameters
                    request.Headers.Add("Prefer", "odata.include-annotations=\"*\"");//for formatted values
                    request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/XML"));
                    request.Headers.Add("Authorization", "Bearer " + oauthToken);

                    //send request
                    HttpResponseMessage response = httpClient.SendAsync(request).Result;
                    string responseString = response.Content.ReadAsStringAsync().Result;
                    responseString = FormatResponse(responseString);

                    using (var ms = new MemoryStream(Encoding.Unicode.GetBytes(responseString)))
                    {
                        // Deserialization from JSON  
                        DataContractJsonSerializer deserializer = new DataContractJsonSerializer(entityObject.GetType());
                    entityObject = (object)deserializer.ReadObject(ms);
                    }
                    
            }
            catch (Exception ex){ throw ex; }
            return entityObject;
        }

Retrieve Multiple records using ODATA API-

  /// <summary>
        /// Retrieve multiple using Fetch XML in API Call
        /// </summary>
        /// <param name="entityPluralName">entity name</param>
        /// <param name="fetchXML">fetchXML string</param>
        /// <returns>List of retrieved Objects</returns>
        public List<RetrieveOpportunity> RetrieveMultiple(string entityPluralName, string fetchXML)
        {
            fetchXML = fetchXML.Replace("<fetch", "<fetch {0} ");
            int page = 1;
            var cookie = string.Format("page='{0}'", page);
            string xml = string.Format(fetchXML, cookie);
            string crmRestQuery = apiUrl + entityPluralName + "?fetchXml=" + xml;
            List<RetrieveOpportunity> lstOpties = new List<RetrieveOpportunity>();
            bool isDone = false;
            try
            {
                while (isDone == false)
                {
                    isDone = true;
                    HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, crmRestQuery);
                    //add header parameters
                    request.Headers.Add("Prefer", "odata.include-annotations=\"*\"");//for formatted values
                    request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/XML"));
                    request.Headers.Add("Authorization", "Bearer " + oauthToken);

                    //send request
                    HttpResponseMessage response = httpClient.SendAsync(request).Result;
                    string responseString = response.Content.ReadAsStringAsync().Result;
                    responseString = FormatResponse(responseString);

                    using (var ms = new MemoryStream(Encoding.Unicode.GetBytes(responseString)))
                    {
                        // Deserialization from JSON  
                        DataContractJsonSerializer deserializer = new DataContractJsonSerializer(typeof(APIResult));
                        APIResult apiResult = (APIResult)deserializer.ReadObject(ms);

                        if (!string.IsNullOrEmpty(apiResult.Microsoft_Dynamics_CRM_fetchxmlpagingcookie))
                        {
                            isDone = false;
                            page++;

                            //retrieve pagingCookie value
                            string xmlVal = WebUtility.UrlDecode((WebUtility.UrlDecode((string)apiResult.Microsoft_Dynamics_CRM_fetchxmlpagingcookie)));
                            int Start = xmlVal.IndexOf("pagingcookie=\"", 0) + "pagingcookie=\"".Length;
                            int End = xmlVal.IndexOf("\" istracking=\"False\"", Start);

                            //proccess the pagingCookie value to support in API URL
                            string strVal = xmlVal.Substring(Start, End - Start).Replace("<", "%26lt;").Replace(">", "%26gt;").Replace("\"", "%26quot;").Replace("'", "%26apos;").Replace("&", "%26amp;");
                            cookie = string.Format("page='{0}' paging-cookie='{1}'", page, strVal);

                            //modify the query for next page with paging cookie
                            xml = string.Format(fetchXML, cookie);
                            crmRestQuery = apiUrl + entityPluralName +"?fetchXml=" + xml;

                        }
                        if (!string.IsNullOrEmpty(apiResult.odata_nextLink))
                        {
                            isDone = false;
                            crmRestQuery = apiResult.odata_nextLink;
                        }

                        if (lstOpties == null || lstOpties.Count == 0)
                        {
                            lstOpties = apiResult.value;
                        }
                        else
                        {
                            lstOpties.AddRange(apiResult.value);
                        }
                    }
                }
            }
            catch (Exception ex) {
                throw ex;
            }
            return lstOpties;
        }

        public List<RetrieveOpportunity> RetrieveMultiple(string entityPluralName, string selectColumns,string filterConditions=null, string orderby=null,bool returnCount=false)
        {
           string query= "?$select=" + selectColumns;
            if (filterConditions != null) {
                query += "&$filter=" + filterConditions;
            }
            if (orderby != null) {
                query += "&$orderby=" + orderby;
            }
            if (returnCount == true) {
                query += "&$count=true";
            }

            string crmRestQuery = apiUrl + entityPluralName +  query;
            List<RetrieveOpportunity> lstOpties = new List<RetrieveOpportunity>();
            bool isDone = false;
            try
            {
                while (isDone == false)
                {
                    isDone = true;
                    HttpRequestMessage request = new HttpRequestMessage(HttpMethod.Get, crmRestQuery);
                    //add header parameters
                    request.Headers.Add("Prefer", "odata.include-annotations=\"*\"");//for formatted values
                    request.Headers.Accept.Add(new MediaTypeWithQualityHeaderValue("application/XML"));
                    request.Headers.Add("Authorization", "Bearer " + oauthToken);

                    //send request
                    HttpResponseMessage response = httpClient.SendAsync(request).Result;
                    string responseString = response.Content.ReadAsStringAsync().Result;
                    responseString = FormatResponse(responseString);

                    using (var ms = new MemoryStream(Encoding.Unicode.GetBytes(responseString)))
                    {
                        // Deserialization from JSON  
                        DataContractJsonSerializer deserializer = new DataContractJsonSerializer(typeof(APIResult));
                        APIResult apiResult = (APIResult)deserializer.ReadObject(ms);
                        
                        if (!string.IsNullOrEmpty(apiResult.odata_nextLink))
                        {
                            isDone = false;
                            crmRestQuery = apiResult.odata_nextLink;
                        }

                        if (lstOpties == null || lstOpties.Count == 0)
                        {
                            lstOpties = apiResult.value;
                        }
                        else
                        {
                            lstOpties.AddRange(apiResult.value);
                        }

                    }
                }
            }
            catch (Exception ex)
            {
                throw ex;
            }
            return lstOpties;
        }

Some common Methods in above Code –

  #region Local variables
        /// <summary>
        /// Local Variables
        /// </summary>
        private string clientID, secretKey, resource, oauthToken, apiUrl, tokenURL;
        private HttpClient httpClient;

        /// <summary>
        /// Constructor to initialize the variables
        /// </summary>
        public Operations()
        {
            apiUrl = "https://mscrm16tech.crm8.dynamics.com/api/data/v8.2/";
            clientID = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx";
            secretKey = "asdasdxzxczdsdaasda";
            resource = "https://mscrm16tech.crm8.dynamics.com";
            tokenURL = "https://login.microsoftonline.com:443/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/oauth2/token/";
        }
        #endregion 
 #region Generate Bearer Token
        /// <summary>
        /// Function to generate Bearer token OAuth2.0 using client id and secret
        /// </summary>
        /// <returns>access token</returns>
        public string GetBearerToken()
        {
            oauthToken = null;
            HttpClientHandler clientHandler = new HttpClientHandler();
            clientHandler.Proxy = WebRequest.GetSystemWebProxy();
            clientHandler.Proxy.Credentials = CredentialCache.DefaultCredentials; // or new NetworkCredential("username","password","DOMAIN");
            clientHandler.UseProxy = true;
            httpClient = new HttpClient(clientHandler);
            ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
            HttpContent requestContent = new FormUrlEncodedContent(new Dictionary<string, string>
            {
                {"grant_type","client_credentials"},
                {"client_id",clientID},
                {"client_secret",secretKey},
                {"resource",resource}
            }
            );
            HttpResponseMessage response = httpClient.PostAsync(tokenURL, requestContent).Result;
            String responseString = response.Content.ReadAsStringAsync().Result;
            using (var ms = new MemoryStream(Encoding.Unicode.GetBytes(responseString)))
            {
                // Deserialization from JSON  
                DataContractJsonSerializer deserializer = new DataContractJsonSerializer(typeof(BearerToken));
                BearerToken token = (BearerToken)deserializer.ReadObject(ms);
                oauthToken = token.access_token;
            }

            return oauthToken;
        }
        #endregion
#region Common Methods
       public string FormatResponse(string responseString) {
            responseString = responseString.Replace("@odata.etag", "odata_etag");
            responseString = responseString.Replace("@OData.Community.Display.V1.FormattedValue", "_OData_Community_Display_V1_FormattedValue");
            responseString = responseString.Replace("@Microsoft.Dynamics.CRM.associatednavigationproperty", "_Microsoft_Dynamics_CRM_associatednavigationproperty");
            responseString = responseString.Replace("@Microsoft.Dynamics.CRM.lookuplogicalname", "_Microsoft_Dynamics_CRM_lookuplogicalname");
            responseString = responseString.Replace("@Microsoft.Dynamics.CRM.lookuplogicalname", "_Microsoft_Dynamics_CRM_lookuplogicalname");
            responseString = responseString.Replace("@odata.context", "odata_context");
            responseString = responseString.Replace("@Microsoft.Dynamics.CRM.totalrecordcount", "Microsoft_Dynamics_CRM_totalrecordcount");
            responseString = responseString.Replace("@Microsoft.Dynamics.CRM.totalrecordcountlimitexceeded", "Microsoft_Dynamics_CRM_totalrecordcountlimitexceeded");
            responseString = responseString.Replace("@Microsoft.Dynamics.CRM.fetchxmlpagingcookie", "Microsoft_Dynamics_CRM_fetchxmlpagingcookie");
            responseString = responseString.Replace("@Microsoft.Dynamics.CRM.morerecords", "Microsoft_Dynamics_CRM_morerecords");
            responseString = responseString.Replace("@odata.nextLink", "odata_nextLink");
            return responseString;
        }
        #endregion

Sample Class for Json Serialization in API Calls-

This class is not needed in you are using Newtonsoft.Json library.

using System.Collections.Generic;
using System.Runtime.Serialization;

namespace ODATA_API
{
    [DataContract]
    public class BearerToken
    {
        [DataMember]
        public string token_type;
        [DataMember]
        public string expires_in;
        [DataMember]
        public string ext_expires_in;
        [DataMember]
        public string expires_on;
        [DataMember]
        public string not_before;
        [DataMember]
        public string resource;
        [DataMember]
        public string access_token;
    }

    [DataContract]
    public class CreateUpdateOpportunity {
        [DataMember]
        public string name;
        [DataMember]
        public string estimatedclosedate;
        [DataMember]
        public string parentaccountid_odata_bind;
        [DataMember]
        public decimal estimatedvalue;
        [DataMember]
        public string transactioncurrencyid_odata_bind;
    }
    [DataContract]
    public class RetrieveOpportunity
    {
        [DataMember]
        public string _odata_context;
        [DataMember]
        public string _odata_etag;
        [DataMember]
        public string estimatedclosedate_OData_Community_Display_V1_FormattedValue;
        [DataMember]
        public string estimatedclosedate;
        [DataMember]
        public string estimatedvalue_OData_Community_Display_V1_FormattedValue;
        [DataMember]
        public string estimatedvalue;
        [DataMember]
        public string estimatedvalue_base_OData_Community_Display_V1_FormattedValue;
        [DataMember]
        public string estimatedvalue_base;
        [DataMember]
        public string name;
        [DataMember]
        public string _parentaccountid_value_OData_Community_Display_V1_FormattedValue;
        [DataMember]
        public string _parentaccountid_value;
        [DataMember]
        public string opportunityid;
        [DataMember]
        public string _transactioncurrencyid_value_OData_Community_Display_V1_FormattedValue;
        [DataMember]
        public string _transactioncurrencyid_value;
    }

    [DataContract]
    public class APIResult
    {
        [DataMember]
        public string odata_context;
        [DataMember]
        public int Microsoft_Dynamics_CRM_totalrecordcount;
        [DataMember]
        public bool Microsoft_Dynamics_CRM_totalrecordcountlimitexceeded;
        [DataMember]
        public string Microsoft_Dynamics_CRM_fetchxmlpagingcookie;
        [DataMember]
        public bool Microsoft_Dynamics_CRM_morerecords;
        [DataMember]
        public string odata_nextLink;
        [DataMember]
        public List<RetrieveOpportunity> value;
    }

}

Calling the Above methods Sample-

static void Main(string[] args)
        {
            Operations ops = new Operations();
            Console.WriteLine("Started!!");
            Console.WriteLine(ops.GetBearerToken());
            
            CreateUpdateOpportunity entity = new CreateUpdateOpportunity();

            entity.transactioncurrencyid_odata_bind = "/transactioncurrencies(c63ba581-6bc6-e811-a96f-000d3af04fb0)";
            entity.estimatedvalue = 1000;
            entity.estimatedclosedate = "2021-01-01";
            entity.name = "Generated From C# Code";
            entity.parentaccountid_odata_bind = "/accounts(3b3b7c71-61d2-ea11-a813-000d3af0205e)";
            //create record
            string recordGuid = ops.CreateAPI("opportunities", entity);
            Console.WriteLine(recordGuid);
           
            //update record
            entity.name = "Generated From CSharp Code";
            Console.WriteLine(ops.UpdateAPI("opportunities", recordGuid, entity));

            //retrieve record
            RetrieveOpportunity retrieveOpportunity = new RetrieveOpportunity();
            retrieveOpportunity =(RetrieveOpportunity)ops.RetrieveSingle("opportunities", recordGuid,retrieveOpportunity);
            Console.WriteLine(retrieveOpportunity.name);

            //delete Record
            Console.WriteLine(ops.DeleteAPI("opportunities", recordGuid));


            Console.Read();
        }

Hope this will help…
Enjoy Ms CRM!!!

Follow on Facebook- FB: MSCRM16Tech

Get SharePoint Document details for particular record in MS CRM using FetchXML

What is Issue?

There are many cases while implementing MS CRM where clients ask to perform some operation in MS CRM based on the document uploaded in SharePoint. But how to get SharePoint document details in MS CRM other than “Documents” associated view? If you try to fetch records using advanced find or querying sharepointdocument entity directly, it will show you error. So how we can query and get the document details using code either from client side or server side?

The Reason-

MS CRM Supports only the associated view for Document i.e. sharepointdocument entity. MS CRM do not support direct querying on all sharepointdocument.

Solution-

There is a way to fetch SharePoint document details for particular record in MS CRM.

If you try to query on Document entity in MS CRM using Advanced find you will get the error-” SharePoint document entity does not support any view other than associated view”.

Now this seems trouble to get sharepoint document details. Don’t worry, as error itself says, the sharepoint document does not support any view other than associated view, We can keep building query in advance find itself.

Suppose I want to get documents details for one of my Opportunity in MS CRM , So I am building the query in the following way-
1. Look for : Document
2.Use Saved View :All Sharepoint Documents
3.If you want, you can edit the columns
4. Select Regarding(Opportunity) contains data
5. Select sub query for opportunity record(for which you want to get details)

If you click on results, it will still show you same error. Don’t worry, download the fetchXML for the query we built.

<fetch version="1.0" output-format="xml-platform" mapping="logical" distinct="false">
  <entity name="sharepointdocument">
    <attribute name="documentid" />
    <attribute name="fullname" />
    <attribute name="relativelocation" />
    <attribute name="sharepointcreatedon" />
    <attribute name="filetype" />
    <attribute name="absoluteurl" />
    <attribute name="modified" />
    <attribute name="sharepointmodifiedby" />
    <attribute name="title" />
    <attribute name="readurl" />
    <attribute name="editurl" />
    <attribute name="author" />
    <attribute name="sharepointdocumentid" />
    <attribute name="ischeckedout" />
    <attribute name="locationid" />
    <attribute name="iconclassname" />
    <order attribute="relativelocation" descending="false" />
    <link-entity name="opportunity" from="opportunityid" to="regardingobjectid" link-type="inner" alias="ad">
      <filter type="and">
        <condition attribute="opportunityid" operator="eq" value="{83779C3E-xxxx-xxxx-xxxx-0CD3BEAFE160}" />
      </filter>
    </link-entity>
  </entity>
</fetch>

When I tried to use the fetchXML in Javascript query, I got the Sharepoint Document details in json as below-

As sharepoint document entity supports only associated view, it requires regarding object to query. So if you try to remove and link-entity tag from fetchXML, it will not return any record in response.

Now we have fetchXML which we can utilize in Javascript or C# based on requirement.

Hope this will help…
Enjoy Ms CRM!!!

Follow on Facebook- FB: MSCRM16Tech

Color Picker Custom Control for MS Dynamics CRM

What is Issue?

One of my previous projects had requirement of color picker in MS CRM to provide users flexibility to select any color to can display notifications(using HTML) on their records. But we had no other option than going with html and JavaScript web resources for this.

The Reason-

MS CRM don’t provide any color picker field out-of-box.

Solution-

As I already had a blog written for color picker using web resources and spectrum libraries-Color Picker in MS CRM ?

But it is web resource which needs much efforts to match to field styles in crm.

I have created the custom pcf control (PowerApps Custom Control). This control can be used for the single line text fields.

Depends on browser it appears in supported way-

On Browsers other than IE-

This slideshow requires JavaScript.

In IE it will appear as –

This slideshow requires JavaScript.

If you want to use it you form you can download ready custom control from here-ColorPickerSolution.zip

How to use it-
1. Import downloaded solution in CRM-
ColorPicker5

2. Create single line of Text field in any entity you want and add it on form.
3. when adding to form select field, click on change field property and in controls tab add custom control “ColorPicker”-

This slideshow requires JavaScript.

4.Save and publish the form.
Now the control is available and ready on form to use.

 

You can also download the source code from here-ColorPickerSource.zip

To work with source code you need some of the basic setup in your computer-
1. Nodejs installed
2. VS or Visual Studio Code installed
3.Understanding of below commands-


pac pcf init --namespace yourNamespace --name yourControlName --template field
npm install
npm run build
npm start
pac solution init --publisher-name yourPubliserName --publisher-prefix yourPrefix
pac solution add-reference --path "pcfproj folder path"
msbuild /t:restore
msbuild

Hope this will help…
Enjoy Ms CRM!!!

Follow on Facebook- FB: MSCRM16Tech

Generating Early Bound Classes and simple Entity Classes MS CRM

What is Issue?

While developing the CRM, when we have to go through coding part, we need to create Early-bound classes for some specific entities. But CrmSvcUtil.exe provides us the Early Bound classes for all the entities available in CRM.
Second scenario- we don’t want this much of complicated classes, Only want to add simple Entity classes. But it might become very lengthy and time consuming task to add the fields in class one by one.

The Reason-

Creating Early bound classes for particular entities is not possible using CrmSvcUtil.exe directly and creating simple entity classes is lengthy and time consuming task.

Solution-

To create early bound classe using CrmSvcUtil.exe, please refer blog – Generate Early Bound Classes for selected entities using CrmSvcUtil.exe in MS CRM

OR

you can use the tool created by mscrm16Tech as below-
It provides both the options like creating Simple CRM entity classes or to Use CrmSvcUtil.exe to generate early bound classes for selected entities only.

When you install and open the application in your system you will get below window which will help you in configuration of MS CRM connection and database connection if needed.

AppScreen1

After configuring the app and clicks on OK, Select the application “Create Early-Bound Classes” in next window  –

App2Screen0

Now you can load the available entities in connected CRM Organization. Please use below image for reference-

App2Screen In case you are using windows 10 and trying to generate Early Bound classes using CrmSvcUtil.exe, you need to make sure following feature is enabled on your windows-
>Control Panel Programs and Features – Turn Windows feature On or Off
->.NetFramework 4.8 Advanced Services
-> WCF Services
->HTTP Activation (Please enable if not)

App2Screen1

Please follow the images to work with the app.

You can download app Here- MSCRM16Tech Tool

Hope this will help…
Enjoy Ms CRM!!!

Follow on Facebook- FB: MSCRM16Tech