Using GraphQL Explorer and Voyager

The Manufacturing Data Model Explorer is an interactive browser-based user interface that facilitates the exploration and execution of GraphQL queries on the Manufacturing Data Model. It incorporates an autocomplete functionality that suggests relevant fields while you type a query. Connecting to your active Fusion Hubs enables you to work with real Fusion designs and manipulate data seamlessly.

Note: - Manufacturing Data Model Explorer only accesses your production data.

This section describes the GUI elements of the explorer, that is panes, tabs, and buttons.

Explorer Panes

The following image illustrates the elements of Explorer pane. Refer to the following table for explanation about the Panes.

No.	Interaction Elements	Description
1	Query Pane	The pane where you can author GraphQL queries and mutations.
2	Query Variables & Request Headers Pane	The pane where you can add and edit Query Variables or additional Request Headers.
3	Results Pane	Displays responses of the queries executed.

Interactive Elements

The following screenshot identifies important User Interaction (UI) elements of the explorer. Refer to the following table for description of each UI element.

Tip: You can also view the user documentation of a particular term by holding Control (on Windows) or Command (on macOS) key on your keyboard and clicking the term. After clicking, the Documentation Explorer appears on the right side of the screen.

After Documentation Explorer opens, you should see an image similar to the one following with the description of the fields in the table below it.

No.	Interaction Elements	Description
1	Documentation Explorer Button	Displays the user documentation pane.
2	Documentation Explorer	Displays user documentation quickly when working with queries within the Manufacturing Data Model Explorer.
3	Query Term	A valid schema term which can be described using the Query Pane Term Viewer.
4	Query Pane Term Viewer	Using the keyboard short key and selecting a term, displays the definition of the respective term within the Query Pane.

1. In the Query Pane, enter your query. As you enter the query, autocomplete assists you in completing the query.
2. In the Query Variables Pane, specify the variable and its value in JSON format.

   Note: If the Query Variable Pane is collapsed by default, click QUERY VARIABLES to expand the Query Variable Pane.

3. Click Play to run the GraphQL query. The response is displayed in the pane on the right.

The Manufacturing Data Model Explorer effortlessly handles access tokens. If you encounter an expired access token, simply refresh or close the browser and sign in again. If the problem persists, clearing your browser’s cache before signing in again might help resolve it.

The following video demonstrates the Manufacturing Data Model API (formerly known as Fusion Data API) via Data Explorer in action.

GraphQL Voyager is a web-based tool designed to visually represent GraphQL schemas. It enables users to interactively explore the schema, providing insights into its structure, relationships, and documentation. By simply clicking on types and fields, you can access descriptions and relationship details, which helps you to comprehend the available data and construct queries effectively.

You can access the GraphQL Voyager by using the following options:

Using the menu option

In Manufacturing Data Model Explorer, click the Profile icon and choose Voyager from the profile menu.

Or

Using the Voyager URL

1. Browse through https://mfgdatamodel-explorer.autodesk.io/voyager.
2. Sign in using your Autodesk credentials.

After signing in, you should see the Voyager interface similar to the following image.

• When you click a type in the schema, it will show you its connections and information about its fields. The same thing happens when you click the type’s name on the left-side panel.
• You can use the search input on the left-side panel to filter the elements in the schema.
• When you click a connection, it will be highlighted both in the schema and on the left-side panel.
• You can traverse the graph using the mouse and, to some extent, the buttons at the bottom-right of the screen. This allows you to zoom in and out, move in any direction, and focus on specific elements.

In the bottom floating panel, you’ll discover various filtering options for enhancing your data visualization. You can use individual filters or combine multiple filters to refine your data visualization.

The available filtering options are explained below:

• Sort by alphabet: This filter allows you to arrange fields within each type alphabetically.
• Skip Relay: This filter helps you to exclude Relay’s wrapper classes from the view.
• Skip Deprecated: This option hides all deprecated fields.
• Show leaf fields: Enabling ‘Show leaf fields’ will present all fields that are not connections, effectively excluding Relay-related elements.