Custom API & Action Tester — User Guide

Overview

The Custom API & Action Tester lets you browse, configure, and execute Dataverse Custom APIs and Custom Process Actions directly from MSDC Toolbox — no external tools required.

Prerequisites

• An active connection to a Dataverse environment
• Your account must have permission to read the Custom API / Custom Process Action definitions and execute them

Getting Started

1. Select Custom API & Action Tester from the sidebar
2. Wait for the plugin to connect to your environment (spinner disappears when ready)
3. The plugin loads all available Custom APIs and Custom Process Actions

Workflow

1. Browse and Select an API

• The left panel lists all Custom APIs and Custom Process Actions in the connected environment
• Use the search box to filter by name
• Click an API to select it — its input parameters appear in the right panel

2. Fill In Input Parameters

• Each input parameter is displayed with its type and whether it is required
• Fill in values for each parameter using the generated form fields
• Supported types: string, integer, decimal, boolean, EntityReference, Entity

3. Execute

• Click Execute to send the request to Dataverse
• A spinner indicates the request is in progress

4. Inspect the Response

• The response panel shows the full output payload
• Switch between Formatted (pretty-printed JSON) and Raw views
• Error responses include the HTTP status and Dataverse error message

Tips

Troubleshooting