CRM 2011 Javascript Retrieve Record using jQuery REST Endpoints.

Using jQuery and REST Endpoints is one of the easiest way to get record details in CRM 2011.

To do this you just need to include:
1. jquery-1.6.2.min.js (or just get the latest version)
2. json2.js

The SDK provides some functions for retrieving records:



Use retrieveRecord if you know the ID of the record. Otherwise, use retrieveMultiple if you want to get the record(s) based on some filters as it will return an array of result objects.

Example:
In a custom entity form, I have an Account lookup field and an Account Number field. I want to auto-populate one of the field based on the other field and vice versa. Therefore:



Hope this helps,
Andreas

Comments

  1. WeiNovember 2, 2011 at 4:21 AM

    This is really helpful, I do have one question in the function retrieveAccountNumberCompleted how to I get the Lookup Field data? like getting the GUID of account.ParentAccountId.

    Thanks

    ReplyDelete
  2. AnonymousNovember 9, 2011 at 6:11 PM

    I couldn't get retrieveMultiple to work with your filter before removing the $. When I did it worked fine.

    ReplyDelete
  3. AnonymousJune 1, 2012 at 4:11 PM

    Hi i am having seanario , i have a look up in wich i want to fetch a field value. can any one help with suitable example.

    ReplyDelete
    Replies
    1. AndreasJune 9, 2012 at 7:36 AM

      Hi, sorry what is your exact requirement?
      Do you want to get a lookup value from JavaScript or from c# code?

      Delete
  4. AnonymousSeptember 7, 2012 at 10:23 AM

    Hi Andreas, this is a great article! I'm hoping that you might be able to help me out. At my job I am the local computer guy and they are looking to me for configuring the new CRM 2011 online system. I have a very limited knowledge of programming and have spent the last couple months researching blogs, videos, and books to see if I can configure the system for our needs. Unfortunately, it seems that everything I look at assumes that the reader already has a programming background and I get lost. I was hoping that you might be able to help out with a script to get me started which I can then use as a reference in any future customizations.

    As I said before, it is an online CRM system with only the basic entities. In this situation we are using the Account and Case entities. Both entities have a custom Option Set field called Key Customer. Each Account record will have this filled out. When a case is created we use the Customer field (which is a lookup field) that references the accounts that we have. When an account is selected we want it to auto-populate the Key Customer field with the same value that is selected for that customer in the account entity. I was looking at your post on this page and it seems to be very close to what I am looking for. I'm just not well enough versed with the language to modify it appropriately. Any help that you can provide would be greatly appreciated.

    Thanks in advance!

    ReplyDelete
    Replies
    1. AndreasSeptember 17, 2012 at 3:27 PM

      Hi,

      Yes you came to the right section.
      Basically you just need the retrieveRecord function (put that on the Entity OnLoad event)

      Then in the OnChange event of your Customer field, put this code:

      var accountLookup = new Array();
      accountLookup = Xrm.Page.getAttribute("new_accountid").getValue();

      if (accountLookup == null) {
      Xrm.Page.getAttribute("keycustomer").setValue(null);
      }
      else {
      var accountId = accountLookup[0].id;
      retrieveRecord(accountId, "AccountSet", retrieveAccountCompleted, null);
      }

      function retrieveAccountCompleted(data, textStatus, XmlHttpRequest) {

      //Get back the Account JSON object
      var account = data;

      //Get the KeyCustomer optionset value (can't remember the syntax on top of my head) then assign it to the KeyCustomer field for the Case entity.

      }
      else {
      Xrm.Page.getAttribute("keycustomer").setValue(null);
      }
      }

      Hope this helps.

      Regards,
      Andreas

      Delete
    2. AnonymousSeptember 19, 2012 at 10:15 PM

      Hi,

      Yes, that was very helpful thank you!

      I'm still working on trying to get the optionset value so I can assign it to the KeyCustomer field. From what I have read it I need to pull the value from metadata. It's a work in progress. Thanks again for your help, it helped quite a bit with my understanding of retrieving information.

      Delete
  5. AnonymousSeptember 26, 2012 at 5:02 AM

    Andreas,

    I have found this article very useful, but I have encountered a problem. When a user clicks save and exit, the callback does not get called in enough time before the windows closes. Is there a way we can modify the call so that it will wait for the response?

    Thanks

    ReplyDelete
    Replies
    1. AndreasOctober 2, 2012 at 9:15 AM

      Hi,

      you can make the call synchronously. Try adding async: false option on the ajax call.

      Regards,
      Andreas

      Delete
    2. AnonymousOctober 5, 2012 at 4:20 AM

      That worked great Andreas thanks. But as it goes in programming everyone wants more so now I have been given the duty to use the retrieve multiple. The only problem is I am trying to filter on a custom field and I think it is causing some trouble. The field is a lookup, and here is an example of the filter I am passing:

      var filterOptions = "?$select=new_category,new_name,new_custom_id&$filter=new_custom_id/Id eq guid'"+ customGuid + "'";

      retrieveMultiple("new_customSet", filterOptions, customCallback, errorCallback)

      Where here I know the new_custom_id is a lookup to another custom entity.


      Delete
    3. AndreasOctober 23, 2012 at 9:54 PM

      Hi it is probably a syntax problem. Have you tried using this tool? http://crm2011odatatool.codeplex.com/
      It is really useful to get your odata query right :)

      Regards,
      Andreas

      Delete
  6. ezraJune 2, 2013 at 6:35 PM

    hi,

    i hope you can help me, after i retrieve a coustome entity and when i try to get a value of an attribute i get that its undifiend (the field has value).

    thanx
    ezra

    ReplyDelete
    Replies
    1. AndreasJune 7, 2013 at 11:25 AM

      Hi,

      You can debug your success callback function and see if your property is there.

      var customentity = data;
      alert(data);

      Regards,
      Andreas

      Delete

Post a Comment

Popular posts from this blog

SharePoint 2013 anonymous access add attachments to list item

Image
Hi, Sometimes you want to enable anonymous access to be able to add a list item but at the same time attaching some documents. After good few hours playing around trying to make this work, turns out that we can achieve this functionality. The trick is to use RunWithElevatedPrivileges method for the file upload. We also want the file upload functionality to be available on the NewForm.aspx as it wouldn't make sense to put it in other forms as any user would be able to upload files to other records. The result will be something like this: When it is saved, the user is redirected to the display form: The close button then will take the user back to the homepage (or any page you desire) The steps: 1. Create an ascx control to host your file upload control in your project.  Put the below script in the ascx as well (credit to this post ): The code behind: 2. Create custom form template. You have to put the ascx in the CONTROLTEMPLATES folder of the
Read more

Sitecore custom publish agent from specific node and at a specific time

Hi all, As you all know, scheduled publishing will not run automatically unless you enable PublishAgent task in Sitecore config. By default, all items that are in publish queue will get published when this task triggers. This includes all items in the final workflow state and all items that don't have workflows. Sometimes this is not what you want. Maybe you don't enable workflow on media items and you don't want the items to go live when they are not ready. The workaround is to create your own PublishAgent task. Looking at the one provided, we can easily extend the code to insert the RootItem to the PublishOptions (this only works with Full or Smart publish mode however): You will notice that on the Run method I check whether the server time is around the time I set in the parameter (thanks to this post for the code). This will enable us to run the task near the specific time we set (e.g. midnight). In the config patch, just add this to enable the custom agent
Read more

CRM Plugin - Parent and Child Pipeline

This concept tends to confuse people often - and I was no exception. I came across this problem when trying to create custom auto-numbering for one of my projects. Creating auto-number for Opportunity is easy. This is because the user creates opportunity straight from the home screen - thus the plugin runs on parent pipeline. However, it's a different story if you are dealing with Quote entity. Quote can be created in 2 ways, through the home screen OR the opportunity screen. If you create it from the latter, it will run on the child pipeline and you will find that your plugin will not work. Registering it as a child pipeline is easy, but CRM makes it harder since you can't use ICRMService. Instead, you have to create CRMService manually by using this piece of code: Not only that, with the child plugin you can't use Query expression to fetch other entities in your code unless you register it as ASYNCHRONOUS plugin. Mark Kovalcson in his blog found out that: A C
Read more