Using SPRemoteAPI Extension (Step 1)
In VSCode just hit F1 and start typing SPRemoteAPI and you will see it appear in the drop down list.
Using SPRemoteAPI Extension (Step 2)
Using SPRemoteAPI Extension (Step 3)
Once you selected the type you are presented a information dialog showing you the type along with options for displaying properties and methods. The options also shows you the number of each contained in the type.
Using SPRemoteAPI Extension (Step 4)
Select the methods options and you are presented a list of available methods to choose from.
Using SPRemoteAPI Extension (Step 5)
Choose a method and a new code window (virtual document) opened containing a JSON representation of all the method’s information needed to call it remotely using REST. It shows you the parameter types, required post body and response body. The post body can be copied into whatever REST calling framework you are using such as FETCH or JQuery. The response can be used to guide you in what to expect in the payload response from the call. This gives you ability to write remote REST calls without having to do all the extra experimentation to see what the call returns. Having both the body and response JSON templates will save you a lot of time searching on the internet.
What about properties?
Below is example of the code window you are given when you select properties. It shows you all the available properties for the type and the information you need to determine what is available remotely from SharePoint Office 365.
SPRemoteAPI in Action
SPRemoteAPI VSCode Extension – SharePoint Office 365 REST Discovery at your fingertips
This Visual Studio Code extension was created to open up the SharePoint Office 365 remote API to the many developers who do not use Visual Studio to develop. This extension will run on non-windows environments and of course does not require SharePoint to be installed locally. You can now easily figure out what is available and how to call any SharePoint REST API without having to search and page through mounds of documentation. Enjoy being productive!