API Docs Dashboard Tool

Overview

The API Docs Dashboard tool displays a dashboard view of the modules connected to every API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. and remote execute. The tool builds API documentation for the module, that includes API call descriptions as well as their request and response parameters. The data type Data types are a classification of data that determines how it is stored and interpreted. and description of each field also displays when selecting a module on the dashboard.

Remote executes interface with a module using an API call instead of loading it in the browser. You build an API endpoint other modules in your application when building a remote execute module. So, the term API module can refer to a remote execute module or a module with a basic API call.

Because the dashboard displays all API modules in your environment, it offers a variety of filters to help you find a specific API module. Available filters include:

Namespace
Title
ID
Path

Once you’ve located an API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. module, you can view its details:

Function description.
Method (GET The HTTP GET method is used to request data from a server, typically retrieving information without modifying any resources./PUT The PUT method is an HTTP request method used in REST APIs to update an existing resource or create a new resource if it does not already exist./POST The HTTP POST method is used to send data to a server to create or update a resource, typically including the data in the body of the request./DELETE The Delete operation removes existing data records from a database, allowing users to eliminate outdated or unnecessary information within a system.).
Request and response parameters.
Request and response data types.

Discover more about using the API Docs Dashboard tool by clicking on the tabs below:

Accessing and Navigating the API Docs Dashboard

API Docs Dashboard Tool Access

This tool requires Creators Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform. 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 user cannot access specific data, it likely means they do not have access to the Workspace containing the module.

To the right of each table entry, use the View button to view the API call’s request and response parameters, data types, and notes.

Navigating the API Docs Dashboard

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 APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. 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 is how the API Docs Dashboard identifies API modules. You'll enter a Namespace in the Module Tags when you create your module. For the dashboard to find your module, you must enter api in the Module Tags. If you want to further organize your API modules, be more descriptive by entering api-namespace: someNamespace. For example, if you had a couple of modules specific to dogs, you can enter the following Namespaces: api,api-namespace:dogs. After you add this Namespace, dogs displays in the Namespace column of the API Docs Dashboard. The Namespace field uses autocomplete to suggest Namespaces used elsewhere in the environment.
Title	The title of the module.
ID	The unique identifier of the module.
Path	The module path.

Navigating Your API Documentation

Once you’ve located your API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. module, click on the View button to the far right to view the following API module details:

The API module’s title.
A brief description of the API module.
The API call’s method.
A link that directs you to Server-Side Module Execution.
The API request table.
The API response table.

Here's an example of how the API details looks:

Viewing the Request and Response of Your API Module

You’ll find most of the API module’s information in the Request and Response tables.

In the Request table, you’ll find 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 data to expect: type:string: If the data is alphanumeric. type:number: If the data is an integer or a float point number. type:boolean: If the data is Boolean (true or false). type:array: If the data type is an array. type:object: If the data type is an object. type:objectId: If the data type is a MongoDB unique identifier.
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:

In the Response table, you’ll find the following information:

Filter	Description
Parameter	The Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. 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 data to expect: type:string: If the data is alphanumeric. type:number: If the data is an integer or a float point number. type:boolean: If the data is Boolean (true or false). type:array: If the data structure is an array An array is a type of object that stores one or more data types. Data types supported in arrays include numbers, strings, and objects.. type:object: If the data structure is an object An object is a type of data structure that represents a single, self-contained entity that acts as a container for the characteristics of that entity.. type:objectId: If the data is a unique identifier.
Comments	A brief description of the API response.

Filter

Description

Parameter

The Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. 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 data to expect:

type:string: If the data is alphanumeric.
type:number: If the data is an integer or a float point number.
type:boolean: If the data is Boolean (true or false).
type:array: If the data structure is an array An array is a type of object that stores one or more data types. Data types supported in arrays include numbers, strings, and objects..
type:object: If the data structure is an object An object is a type of data structure that represents a single, self-contained entity that acts as a container for the characteristics of that entity..
type:objectId: If the data is a unique identifier.

Comments

A brief description of the API response.

Here's an example of a Response table:

Best Practices

Creators using older versions of Unqork do not contain the API Module template, the following best practices are important to consider:

Add the api tag to your module, making it easier to locate your module on the API Docs Dashboard.
Follow the API Specification snippet to help you build API modules. APIs work as intended when you use these guidelines, and their documentation displays in the dashboard.

For more information on the API Specification Snippet, view ourAPI Specification Snippet article.

Set the Server Side Execution Only toggle to (ON).