GraphQL console
- Last UpdatedJan 26, 2026
- 4 minute read
The GraphQL console provides a graphical interface for creating queries for entities data in CONNECT.
You can run a query within the console, or use it to create a query that can be used by an external application.
To use the GraphQL console:
-
In the navigation rail, select Developer tools. Then select GraphQL console.
The Explorer pane populates with the schema of the selected Knowledge Graph instance. Select Change instance to select a different Knowledge Graph instance.
-
Select
next to an object in the GraphQL Explorer to drill down and show the available filtering
options and properties.
-
Use the Explorer tree to create a request.
-
Use the selections under where: to filter by properties that equal, contain, start with, or end with a specified value, or are included in an array of values.
-
For properties that can be arrays, when an item is selected or entered, a new blank item appears below it to allow for additional values.
-
Use the selections under orderBy: to set properties to sort by and to limit the count of objects returned. If you select multiple sort properties, the order in which you select them determines the sort order.
-
Under items: select the properties to include in the response.
-
Select
in the Request pane to clear all selections.
Note: The Explorer and Request panes work in both directions. The request updates as you make selections in the Explorer tree, and editing the text directly in the request or pasting a complete request updates the Explorer tree. When editing the request directly, select
to automatically format the request.
-
-
Select
to return to the top level and repeat the process with other objects, as needed.
-
When your query is complete, select Send Request to run the query.
The results of your query appear in the Response pane.
-
When you request a certain amount of objects, such as count: 1, and there are more objects available to display, a continuation token appears in the response. Select Resend with Continuation to view the next item.
-
Select
in the Response pane to copy the response to the clipboard.
-
Select
> Download response body to download the JSON file.
-
Select
to show the session request history, then select any of the displayed requests to
reload it into the Request pane.
-
Variables
Rather than entering specific values for your query, you can use variables.
-
Select the
icon that appears next to an argument when you hover over it.
-
Enter a variable name in the box that appears.
A variable declaration is added to the Request pane and the new variable is added to the Variables pane in JSON format. The variable is assigned a value of null by default.
-
Edit the value in the Variables pane to assign a value to the variable.
-
You can make an array a variable and include multiple values, such as [98, 99, ...].
-
Select
in the Variables pane to reset variables to a null value.
-
Fragments
GraphQL supports reusable units called fragments. With fragments you construct parts of queries once, and then reuse them in multiple locations in a query.
-
In the Request pane, add the fragment text above or below the query. The location does not matter.
For example:
fragment AlarmFields on Alarm {
id
eventStartTime
eventState
severity
}
-
Within the query, place instances of the fragment in the format ...[fragment name].
Fragments appear only in the Request pane and are not reflected in the Explorer pane. They persist when you make changes in the Explorer pane.