You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: powerapps-docs/maker/data-platform/dataverse-accelerator/api-playground.md
+31-30Lines changed: 31 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
---
2
2
title: Test and explore the Dataverse Web API
3
-
description: Quickly and conveniently interact with Power Platform web APIs, including the Dataverse Web API in a pre-authenticated software testing tool.
3
+
description: Quickly and conveniently interact with Power Platform web APIs, including the Dataverse Web API in a preauthenticated software testing tool.
The API playground is a pre-authenticated software testing tool that helps makers quickly and conveniently interact with the [Microsoft Dataverse Web API](/power-apps/developer/data-platform/webapi/overview).
19
+
The API playground is a preauthenticated software testing tool that helps makers quickly and conveniently interact with the [Microsoft Dataverse Web API](/power-apps/developer/data-platform/webapi/overview).
20
20
21
21

22
22
@@ -31,17 +31,17 @@ Use this tool to explore what's possible in the RESTful API, test user-defined w
31
31
32
32
## Key features
33
33
34
-
-Pre-authenticated: The API playground comes pre-authenticated, so developers can start testing and experimenting with API endpoints right away.
34
+
-Preauthenticated: The API playground comes preauthenticated, so developers can start testing and experimenting with API endpoints right away.
35
35
- Web-based: With the API playground, developers can quickly interact with the Dataverse Web API without the need for extensive setup like software downloads or non-Microsoft account setup. You can access the tool from the Dataverse accelerator, a Microsoft app available in all new Dataverse environments and can be installed in any environment.
36
36
- Convenient: Presents the various actions and capabilities available in the Dataverse Web API, making it easy to quickly learn what's possible and how to implement it.
37
37
38
38
## Prerequisites
39
39
40
-
You must have [access to Dataverse](/power-apps/maker/data-platform/data-platform-entity-licenses), and [access to run the Dataverse accelerator app](./dataverse-accelerator.md#prerequisites-to-run-the-dataverse-accelerator).
40
+
You must have [access to Dataverse](/power-apps/maker/data-platform/data-platform-entity-licenses), and [access to play the Dataverse accelerator app](./dataverse-accelerator.md#prerequisites-to-run-the-dataverse-accelerator). Members of the system customizer security role have access to play the app.
41
41
42
42
## Get started
43
43
44
-
To get started with the API playground, [run](dataverse-accelerator.md#play-the-dataverse-accelerator) the Dataverse accelerator and navigate to the API playground page.
44
+
To get started with the API playground, [play](dataverse-accelerator.md#play-the-dataverse-accelerator) the Dataverse accelerator and go to the API playground page.
45
45
46
46

47
47
@@ -61,10 +61,10 @@ Three request types are presented:
61
61
62
62
These request types are designed to simplify calling plug-ins available in the working environment.
63
63
64
-
1. Select an option from the main dropdown, which presents the available plugins in the current environment.
65
-

64
+
1. Select an option from the main dropdown list, which presents the available plug-ins in the current environment.
65
+

66
66
67
-
1. If parameters are available, they are displayed in the **Query params** table that appears. Provide values for required parameters.
67
+
1. If parameters are available, they're displayed in the **Query params** table that appears. Provide values for required parameters.
68
68
69
69

70
70
@@ -73,9 +73,9 @@ These request types are designed to simplify calling plug-ins available in the w
73
73
74
74
1. Select **Send**.
75
75
76
-
Observe the [response](#view-the-response) in the lower section of the screen.
76
+
1.Observe the [response](#view-the-response) in the lower section of the screen.
77
77
78
-

78
+

79
79
80
80
> [!NOTE]
81
81
> The interface provides a convenient listing of all available plug-ins in the environment. When selected, the associated parameters with data types are presented. Behind the scenes an OData call is still being made, but the interface simplifies the construction of the call.
@@ -84,25 +84,25 @@ Observe the [response](#view-the-response) in the lower section of the screen.
84
84
85
85
OData requests allow more options for request parameters.
86
86
87
-
1. Select the **HTTP request method** in the first dropdown list.<!-- start here-->
87
+
1. Select the **HTTP request method** in the first dropdown list.
88
88
89
-
1. Type in the *endpoint Url*. Only include the request Url after `[OrgUrl]/api/data/v9.2/`
89
+
1. Type in the *endpoint Url*. Only include the request URL after `[OrgUrl]/api/data/v9.2/`
90
90
91
91
1. Add *query parameters* using one of the two methods:
92
92
93
-
1. In the Url
94
-
1. After the question mark (`?`) character in the Url, type in the query parameter key.
93
+
1. In the URL.
94
+
1. After the question mark (`?`) character in the URL, type in the query parameter key.
95
95

96
-
1. Type an equals (`=`) character after the key
97
-
1. Type in the value
96
+
1. Type an equals (`=`) character after the key.
97
+
1. Type in the value.
98
98

99
99
100
100
The keys and values will automatically populate the parameter table in the interface.
101
101
102
-
1. Manually add query parameters by clicking the **+ Add param** button. This will add an empty parameter row to the table that you can type values into. The Url will be updated dynamically as values are entered.
102
+
1. Manually add query parameters by selecting **+ Add param**. This adds an empty parameter row to the table that you can type values into. The URL is updated dynamically as values are entered.
103
103
104
-
1. Optionally provide a Body (if using all request methods except GET) by selecting the Body tab, then entering the body value in the editor control.
105
-
1.Click**Send**
104
+
1. Optionally provide a body (if using all request methods except GET) by selecting the **Body** tab, and then enter the body value in the editor control.
105
+
1.Select**Send**.
106
106
1. Observe the [response](#view-the-response) in the lower section.
107
107
108
108
### View the response
@@ -117,26 +117,27 @@ The response status provides quick metrics on the request:
117
117
- Duration (in milliseconds)
118
118
- Size (in kilobytes)
119
119
120
-
The response body is displayed below the response status. You can click the copy icon to copy the response body to your clipboard.
120
+
The response body is displayed below the response status. Select the copy icon to copy the response body to your clipboard.
121
121
122
122
### Save an API request
123
123
124
-
You can save requests for quick access later on. Saved requests will store the request details (such as the request method and endpoint for OData request, or the selected plugin for Custom API and instant low code plugin), and the input parameters with associated values.
124
+
You can save requests for quick access later. Saved requests store the request details, such as the request method and endpoint for OData request, or the selected plug-in for custom API and instant plug-in, and the input parameters with associated values.
125
+
126
+
1. In the request screen, select **Save** in the top right corner of the page.
125
127
126
-
1. In the request screen, click the save button in the top right corner of the page.
127
-
1. A dialog appears with form fields.
128
+
A dialog appears with form fields.
128
129
1. Provide a name for the request. A default value is provided based on the request details, but you can update the value.
129
130

130
-
1.Click**Save**
131
-
1. The saved request appears in the left rail of the screen.
132
-

131
+
1.Select**Save**.
132
+
1. The saved request appears in the left pane of the screen.
133
+

133
134
134
135
### Load a saved request
135
136
136
-
To load a saved request, select a request name. This will load the request screen with the request details filled in, including input parameters and values.
137
+
To load a saved request, select a request name. This loads the request screen with the request details filled in, including input parameters and values.
137
138
138
139
> [!NOTE]
139
-
> You can only view saved requests that you have created.
140
+
> You can only view saved requests that you've created.
140
141
141
142
## FAQs
142
143
@@ -150,9 +151,9 @@ Yes, the API playground tool only connects to the Dataverse Web API. No other se
150
151
151
152
### How does the API playground tool authenticate to the Dataverse Web API?
152
153
153
-
The tool uses the authentication token of the logged in user that was required to play the Dataverse accelerator application.
154
+
The tool uses the authentication token of the logged in user that is required to play the Dataverse accelerator application.
154
155
155
-
### Is the API playround feature available in all environments?
156
+
### Is the API playground feature available in all environments?
156
157
157
158
The feature is delivered through the Dataverse accelerator and is available in all environments that have the app installed. The app is automatically installed in all new environments, but can also be installed in older environments by following the [install instructions](dataverse-accelerator.md#install-the-dataverse-accelerator).
0 commit comments