Schema Docs Dashboard

The Schema Docs Dashboard displays all schema modules in the environment. Schema modules serve as database blueprints for storing . Use this dashboard to locate schema modules, view their component structure, and access submission data as a URL-based API call.

Access Requirements

Access to the Schema Docs Dashboard depends on role configuration.

Environment Roles (without WSRBAC): Creator roles can view all data in this tool.

WSRBAC: Creators can view data for modules and workflows inside workspaces where they have access. If data is missing, the Creator might not have access to the workspace containing that module.

Dashboard Filters

The Schema Docs Dashboard showing the module list with ID and Title filter fields.

The dashboard displays all schema modules in the environment. Results update automatically as text is entered. Click the funnel icon on the right to clear all filters.

Filter	Description
ID	The module's unique identifier.
Title	The module title.

The table displays 10 entries by default. Use the pagination buttons below the table to navigate to additional entries.

Schema Module Details

Click View on the right side of a table entry to open the module's component list.

The schema module detail view showing Label, Property Name, Type, Required, and Comments columns for each component.

Column	Description
Label	The component's label or label text.
Property Name	The component's property ID.
Type	The component type.
Required	Whether the component is required.
Comments	Any comments added to the component.

If the schema module has many components, use the component-level filters to narrow results.

Viewing Submissions

Below the schema module title, click View submissions. The page displays all submissions as unformatted JSON. The page URL is an API call in the GET Module format:

{your-environment}.unqork.io/fbu/uapi/modules/{moduleId}/submissions

Use this URL in a Plug-In component's Source Data URL field to populate dashboards, drop-downs, or other components that read schema data.

The View Submissions page displaying raw JSON submission data for a schema module.

The View Submissions page displays a maximum of 50 submissions. Only these 50 submissions are available through the API call URL.

Schema Module Requirements

For a module to appear in the Schema Docs Dashboard, it must have the schema tag applied. Configure schema modules following Unqork best practices:

Include only field components. Do not add Decisions, Calculators, Initializers, or other Data & Event Processing components.
Set Module Type to Other (data storage, rerouting, etc.).
Add schema to the module's Tags field.

Changelog

Date	Change
2026-07-16	Editorial pass: fixed banned words, em dashes, See Also descriptions, and link paths.
2026-04-28	Updated to Reference Guide format. Fixed metadata and headings. Reorganized sections. Updated alt text. Removed CDN signed URL wrappers.