In this blog post, we’ll explore Microsoft Dataverse and experiment with its features using the Web API Playground. Before we begin, ensure you subscribe to CRM Crate to remain informed about the latest developments in the Power Platform field.
Microsoft Dataverse is a cloud-based data platform that lets you securely store and manage data used by business applications. Think of it as a central repository where you can gather and organize information from various sources, making it easier to analyze and use. It’s designed to work seamlessly with other Microsoft services, like Power Apps and Power Automate, allowing you to build custom apps and automate workflows without needing extensive coding skills. Dataverse supports a wide range of data types and relationships, helping businesses streamline their operations and make data-driven decisions more effectively.
Use Web API Playground feature for testing Dataverse APIs
The Web API playground is a tool that lets you easily and quickly test out the Microsoft Dataverse Web API without needing to deal with authentication hassles. It’s designed to help developers interact with the API effortlessly, making the process of testing and experimenting more convenient.
This web application lets developers test and experiment with various API endpoints without needing complicated setup or authentication. It also provides a handy overview of available actions and links to documentation, making it easier to learn and get started quickly. You can use this tool to explore the capabilities of the RESTful API, test custom workflows, and much more.
In nutshell, the API playground is a web-based tool that simplifies interacting with the Dataverse Web API, eliminating the need for software downloads or non-Microsoft account setups. Accessible through the Dataverse accelerator—an app included with new Dataverse environments and installable in any environment—it allows developers to get started quickly. With preauthentication, you can dive into testing and experimenting with API endpoints right away. Additionally, the playground conveniently displays the available actions and capabilities of the Dataverse Web API, making it easy to understand what you can do and how to implement it.
Steps to test Microsoft Dataverse APIs with the API Playground
Before you begin, ensure you have access to Dataverse and the Dataverse accelerator app. Users with the system customizer security role are granted access to the app. If the Dataverse Accelerator App isn’t installed in your Dataverse environment, click this link to install it: Dataverse Accelerator Prerequisites.
After installing the Dataverse Accelerator App in your environment, go to your Power Platform environment, select the Dataverse Accelerator App, and open it as demonstrated below.
Within the API Playground, you can use three services: Custom API, OData Request, and Low-Code Instant Plugin. Here’s what each service offers:
- Custom API: This service encompasses all Dataverse Web API actions, Microsoft functions, and any public user-defined custom APIs registered in your environment.
- OData Request: Provides detailed control over request inputs, enabling you to send precise OData requests.
- Instant Plugin: Includes user-defined workflows registered as custom APIs in the environment, complete with associated FxExpression.
Request a custom API in playground
These request types are designed to streamline the process of calling plug-ins available in your working environment. For example, we’ll request the built-in ‘AISentiment’ custom API and test the response from Dataverse.
The Custom API returned an error because there is no AI credit capacity for our Power Platform environment & user.
Perform an OData request in the Playground
OData requests offer more flexibility with request parameters.
- Choose the HTTP request method from the first dropdown menu.
- Enter the endpoint URL, including only the part after [OrgUrl]/api/data/v9.2/.
- For this example, we’ll perform an OData request to query data from the Dataverse table named “Feedback.” Use the “GET” method on the “feedback” table.
- After executing the OData request, Dataverse will return a JSON response containing data from the Feedback table as illustrated below.
Discovering and experimenting with Dataverse using the Web API Playground offers a hands-on approach to understanding its capabilities. The Playground simplifies interactions with various API endpoints, allowing you to test, learn, and explore functionalities without extensive setup. By leveraging these tools, you can gain valuable insights into how Dataverse can be used to streamline and enhance your data management processes.
