The API Docs Dashboard tool displays all modules connected to every API and remote execute. The tool builds API documentation for each module, including API call descriptions and their request and response parameters. Select a module on the dashboard to view the data type and description of each field.
Remote executes interface with a module through an API call instead of loading it in the browser. When you build a remote execute module, you create an API endpoint for other modules in your Application. The term API module can refer to a remote execute module or a module with a basic API call.
The dashboard displays all API modules in your environment and provides filters to help you find a specific module. Available filters include:
Namespace
Title
ID
Path
After you locate an API module, view its details:
Function description.
Method (GET/PUT/POST/DELETE).
Request and response parameters.
Request and response data types.
Learn more about using the API Docs Dashboard tool in the tabs below:
Accessing and Navigating the API Docs Dashboard
API Docs Dashboard Tool Access
This tool requires Creators to have specific role access in Environment Role RBAC (role-based access control) or WSRBAC (Workspaces Role-Based Access Control).
If using Environment Roles (not using WSRBAC):
Creator roles can view all data in this tool.
If using WSRBAC:
Creators can view data related to modules and workflows inside Workspaces where they have access.
If a Creator cannot access specific data, they likely do not have access to the Workspace containing the module.
On the right side of each table entry, click the View button to see the API call's request and response parameters, data types, and notes.
By default, the API Docs Dashboard displays 10 entries. Click the numbered buttons below the table to display more entries.
Below is an example of how the dashboard looks:
Filtering the API Docs Dashboard
All API modules created in the environment display in the API Docs Dashboard. The dashboard has four filters to help you locate your API modules. Use any or all these filters, depending on how specific you want to be. As you enter text into the fields, the results display automatically. To clear all fields, click the funnel icon to the far right.
Below are descriptions of the supported filters:
Filter | Description |
|---|---|
Namespace | The Namespace identifies API modules in the API Docs Dashboard. Enter a Namespace in the Module Tags when you create your module. For the dashboard to find your module, enter For example, if you have a few modules specific to
|
Title | The title of the module. |
ID | The unique identifier of the module. |
Path | The module path. |
Navigating Your API Documentation
After you locate your API module, click the View button on the far right to see the following API module details:
The API module’s title.
A brief description of the API module.
The API call’s method.
Links to Server-Side Module Execution.
The API request table.
The API response table.
The following example shows the API details:
Viewing the Request and Response of Your API Module
The Request and Response tables contain most of the API module's information.
The Request table contains the following information:
Filter | Description |
|---|---|
Parameter | This is the Property ID of your API module. |
Type | The API module's request type. When creating an API module, add the following data types to the Module Tags to specify the expected data types:
|
Required | Determines if the module's API parameters are required. |
Comments | A brief description of the API request. |
Below is an example of the Request table:
The Response table contains the following information:
Filter | Description |
|---|---|
Parameter | The Property ID of your API module. |
Type | The API module's response type. When creating an API module, add the following data types to the Module Tags to specify the expected data types:
|
Comments | A brief description of the API response. |
Here's an example of a Response table:
Best Practices
Creators using older versions of Unqork may not have the API Module template available. Keep the following best practices in mind:
Add the api tag to your module to make it easier to find on the API Docs Dashboard.
Use the API Specification snippet to build API modules. These guidelines ensure your APIs work correctly, and their documentation displays in the dashboard.
For more information on the API Specification Snippet, view our API Specification Snippet article.
Set the Server Side Execution Only toggle to
(ON).