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
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ Use this tool to explore what's possible in the RESTful API, test user-defined w
32
32
## Key features
33
33
34
34
- Pre-authenticated: The API playground comes pre-authenticated, so developers can start testing and experimenting with API endpoints right away.
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 third party account setup. You can access the tool from the Dataverse Accelerator, a first party app available in all new Microsoft Dataverse environments and can be installed in any environment.
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
@@ -43,48 +43,48 @@ You must have [access to Dataverse](/power-apps/maker/data-platform/data-platfor
43
43
44
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.
45
45
46
-

46
+

47
47
48
48
### Make requests to the Dataverse Web API
49
49
50
-
On the landing screen, choose the request type to open the request editor by clicking the 'Create' button on any of the top cards.
50
+
On the landing screen, choose the request type to open the request editor by selecting **Create** on any of the top cards.
51
51
52
52
Three request types are presented:
53
53
54
54
| Type | Description |
55
55
|-|-|
56
-
| Custom API | This includes any Microsoft Dataverse Web API first party [actions](/power-apps/developer/data-platform/webapi/use-web-api-actions), [functions](/power-apps/developer/data-platform/webapi/use-web-api-functions), or any public [user-defined Custom APIs](/power-apps/developer/data-platform/custom-api) registered in the working environment. |
57
-
| Instant low code plugin |[Instant low code plugins](/power-apps/maker/data-platform/low-code-plug-ins?tabs=instant) are classified as any user-defined workflows registered as a Custom API in the environment with a related FxExpression. |
56
+
| Custom API | This includes any Dataverse Web API [actions](/power-apps/developer/data-platform/webapi/use-web-api-actions), [functions](/power-apps/developer/data-platform/webapi/use-web-api-functions) from Microsoft, or any public [user-defined custom APIs](/power-apps/developer/data-platform/custom-api) registered in the working environment. |
57
+
| Instant plug-in |[Instant plug-ins](/power-apps/maker/data-platform/low-code-plug-ins?tabs=instant) are classified as any user-defined workflows registered as a custom API in the environment with a related FxExpression. |
58
58
| OData request | Allows more granular control over the request inputs to send [OData requests](/power-apps/developer/data-platform/webapi/perform-operations-web-api). |
59
59
60
-
### Request a Custom API or instant low code plugin
60
+
### Request a custom API or instant plug-in
61
61
62
-
These request types are designed to simplify calling plugins available in the working environment.
62
+
These request types are designed to simplify calling plug-ins available in the working environment.
63
63
64
64
1. Select an option from the main dropdown, which presents the available plugins in the current environment.
65
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 are displayed in the **Query params** table that appears. Provide values for required parameters.
68
68
69
-

69
+

70
70
71
71
> [!NOTE]
72
-
> Checkboxes to the left of each parameter indicate whether they are included in the request. Required parameters have disabled checkboxes, while optional parameters have editable ones.
72
+
> Checkboxes to the left of each parameter indicate whether they are included in the request. Required parameters have disabled checkboxes while optional parameters have editable ones.
73
73
74
-
1.Click**Send**
74
+
1.Select**Send**.
75
75
76
-
1.Observe the [response](#view-the-response) in the lower section of the screen.
76
+
Observe the [response](#view-the-response) in the lower section of the screen.
77
77
78
-

78
+

79
79
80
80
> [!NOTE]
81
-
> The interface provides a convenient listing of all available plugins 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.
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.
82
82
83
83
### Make an OData request
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.
87
+
1. Select the **HTTP request method** in the first dropdown list. <!-- start here-->
88
88
89
89
1. Type in the *endpoint Url*. Only include the request Url after `[OrgUrl]/api/data/v9.2/`
0 commit comments