Install the managed solution file and then navigate to the Solutions area and open the CRM REST Builder Solution. You should be defaulted to the Configuration screen where you can begin building your requests.

Select the endpoint you want to create code for (Web API is only available for CRM 2016+).

Select the appropriate action or request type you would like to build.

Select the output format or library you'd like the code generated in.

Choose if the request is performed Asynchronously or Synchronously.

Complete the remaining parameters based on the specific type of request. 

Use the Create Request button to generate the code. 

Code in the Code (Read-Only) tab cannot be edited but will return results to the Results tab when available after executing. Code in the Code (Editor) tab can be edited prior to executing but results will not be displayed in the Results tab. The code being executed will be determined by the selected tab.

Known Issues

  • Web API – Using RetrieveMultiple, any operation that requires expand (select or filter) isn’t supported by the endpoint yet and hasn’t been exposed in the tool. If you need this you’ll need to use the 2011 endpoint. I’m assured it’s coming at a later date by my friends at Microsoft. When using Retrieve, expand works as expected.
  • Web API – Attempting to use RetrieveMultiple and filter on a Date field that is designated as Date Only will fail with a 400 Bad Request error. I’ve been informed this is actually a bug with endpoint. The code being generated should be correct so I left this in hoping Microsoft would sneak a fix in before the next major update.
  • Web API – Using Retrieve, the endpoint doesn’t support using the expand operation using self-referncing N:N relationship so they aren’t displayed. Web API Limitationson MSDN
  • Web API – Using Associate/Disassociated, again self-referncing N:N relationships are supported yet so they aren’t displayed.

 

BE ADVISED, THIS WILL ATTEMPT TO EXECUTE THE CODE DISPLAYED WHICH MAY RESULT IN THE DELETION OF RECORDS, USE AT YOUR OWN RISK!

 

This project uses code from the following sources:

Last edited Jan 16, 2016 at 4:29 AM by JLattimer, version 4