welcome to XRM blog

Keep in touch with latest CRM/ERP articles

To remain competitive your organisation must be efficient across the business process spectrum. To do so you need to take sound decisions based on a balance between the cost and risk. To do so you will be heavily dependent on your content management in itself needs...

image
Blog

How to get Record Change History Through Web API

By Ishaan Sheikh on 1/28/2021

Microsoft Dynamics provides you a feature to see if any record is altered in any way. It also allows you to see what change has happened related to that account such as any field value is changed or status of record has changed, etc.  


This feature is termed as Audit History. You can get Audit History of any record from any entity by using the following Web API very easily: 


<your-organization-url>/api/data/v9.0/RetrieveRecordChangeHistory(Target=@p1,PagingInfo=@p2)?@p1={'@odata.id':'<plural-entity-logical-name>(<recordid>)'}&@p2={'Count':10,'PageNumber':1,'ReturnTotalRecordCount':true}

For Example:

https://xrmlabs1.crm8.dynamics.com/api/data/v9.0/RetrieveRecordChangeHistory(Target=@p1,PagingInfo=@p2)?@p1={'@odata.id':'contacts(7a97b528-d3ca-e811-a96d-000d3af254d2)'}&@p2={'Count':10,'PageNumber':1,'ReturnTotalRecordCount':true} 


You can just paste the above Web API to your web browser and it will return the Old value and changed New value for the record. It also provides you some more information such as who altered the records as well as what operation has performed, etc. 

It should look something like this: 

Formatted JSON: 

{  "@odata.context":"https://xrmlabs1.crm8.dynamics.com/api/data/v9.0/$metadata#Microsoft.Dynamics.CRM.RetrieveRecordChangeHistoryResponse", 

   "AuditDetailCollection":{ 

      "MoreRecords":false, 

      "PagingCookie":null, 

      "TotalRecordCount":2, 

      "AuditDetails":[ 

         {           "@odata.type":"#Microsoft.Dynamics.CRM.AttributeAuditDetail", 

            "InvalidNewValueAttributes":[         

            ], 

            "LocLabelLanguageCode":0, 

            "DeletedAttributes":{ 

               "Count":0, 

               "Keys":[                 

               ], 

               "Values":[                 

               ] 

            }, 

            "OldValue":{ 

               "@odata.type":"#Microsoft.Dynamics.CRM.contact", 

               "address1_city":"Paris", 

               "jobtitle":"Owner", 

               "preferredcontactmethodcode":1, 

               "address1_country":"France", 

               "address1_composite":"39, quai du Roosevelt\r\n92130 Paris\r\nFrance" 

            }, 

            "NewValue":{ 

               "@odata.type":"#Microsoft.Dynamics.CRM.contact", 

               "address1_city":"London", 

               "mobilephone":"777-4444-442", 

               "jobtitle":"Owner of the Firm", 

               "preferredcontactmethodcode":3, 

               "address1_country":"United Kingdom", 

               "address1_composite":"39, quai du Roosevelt\r\nLondon\r\n92130\r\nUnited Kingdom" 

            } 

         }, 

         { 

            "AuditRecord":{ 

               "@odata.type":"#Microsoft.Dynamics.CRM.audit", 

               "_objectid_value":"00000000-0000-0000-0000-000000000000", 

               "_userid_value":"54933acf-9442-eb11-bb23-000d3a0a82ca", 

               "operation":2, 

               "auditid":"a6f94183-ee5a-eb11-a607-501ac515b450", 

               "attributemask":"", 

               "action":107, 

               "objecttypecode":"organization", 

               "createdon":"2021-01-20T07:10:02Z" 

            } 

         } 

      ] 

   } 

} 


 

In the above example, the Old Value and New Value keys store the old values and new values for the fields respectively. Also, there is a _userid_value which gives you the id of the user who altered the record. 

NOTE: To make this functionality work, you must enable auditing for your organization as well as for your Entity. 


Enable Auditing for Organization

To enable auditing for your organization, follow the given steps: 

  1. - Navigate to Advanced Settings > Auditing. 

  1. - Click Global Audit Settings. 

  1. - Check Start Auditing. 

  1. - Click OK. 


 


Enable Auditing for Entity 

To enable auditing for your entity, follow the given steps: 

  1. - Navigate to Advanced Settings > Customizations > Customize the System. 

  1. - Select the entity for which you want to enable auditing. 

  1. - Check Auditing. 

  1. - Click Save. 



Javascript
Dynamics CRM
audit-history
Auditing
Dynamics 365
Javascript
Blog Calendar
Blog Calendar List
2021 May  8  2
2021 Apr  15  3
2021 Mar  23  5
2021 Feb  46  7
2021 Jan  46  9
2020 Dec  33  7
2020 Sep  32  3
2020 Aug  60  3
2020 Jul  56  1
2020 Jun  25  3
2020 Apr  14  3
2020 Mar  11  2
2020 Feb  23  5
2020 Jan  23  7
2019 Dec  15  4
2019 Nov  11  1
2019 Jan  33  3
2018 Dec  35  4
2018 Nov  66  3
2018 Oct  12  3
2018 Sep  332  11
2018 Aug  6  2
2018 Jun  11  1
2018 Jan  56  2
2017 Sep  561  5
2017 Aug  17  1
2017 Jul  17  2
2017 Jun  53  2
2017 May  21  1
2017 Apr  33  2
2017 Mar  119  4
2017 Feb  467  4
2016 Dec  183  3
2016 Nov  426  8
2016 Oct  254  10
2016 Sep  365  6
2016 Aug  39  1
2016 Jun  1787  6
2016 May  104  3
2016 Jan  71  2
2015 Dec  392  6
2015 Nov  4  1
2015 Oct  13  1
2015 Sep  1379  6
2015 Aug  13  1
2015 Jul  127  2
2015 Jun  10  1
2015 May  20  1
2015 Apr  28  3
2015 Mar  78  3
2015 Jan  5265  4
2014 Dec  17  1
2014 Nov  2229  4
2014 Oct  64  1
2014 Sep  106  2
2014 Aug  4693  1
2014 Jul  46  2
2014 Apr  2481  12
2014 Mar  291  19
2014 Feb  238  8
2014 Jan  1510  16
2013 Dec  21  2
2013 Nov  651  2
2013 Oct  252  3
2013 Sep  11  1
2013 Aug  38  3
2013 Jul  209  1
2013 Apr  50  6
2013 Mar  1923  10
2013 Feb  311  4
2013 Jan  266  2
2012 Nov  38  2
2012 Oct  460  10
Tag Cloud
Interested in our services? Still not sure about project details? get a quote