Accessing Your Data Via REST Endpoint (2.11)
InterSystems Data Fabric Studio™ supports accessing data via REST endpoints through the use of managed queries. Managed queries are predefined SQL queries that have been saved and made available through the UI, allowing you to explore and extract data without writing SQL or crafting manual API requests.
Note that the user roles govern both your ability to see queries and your ability to create them, as well as your ability to access the REST endpoints for managed queries. Each user can only see the results of queries they’ve run themselves; results from other users' tests are not shared.
Creating a Managed Query
To create a managed query via the UI:
-
Click the Data Catalog
icon in the application menu. -
Click Query Management.
-
Click Create Query.
-
Type a unique query name in the Query Name text box.
Tip:The query name must be HTTP compliant because it becomes part of the REST endpoint URL. Avoid spaces or special characters.
-
Type a SELECT query.
You can click Run Query to test the query. This option is also available after the query is saved, or when you're editing an existing query.
-
Click Submit.
Each managed query is associated with a REST endpoint, which you can call from an external application or script.
To update a query, click its name in the UI, then click Edit Query to modify the SQL statement.
Accessing a Managed Query via REST
To access tables within Data Fabric Studio via REST Endpoint:
-
Click the Data Catalog
icon in the application menu. -
Click Query Management.
-
Click the Menu
icon next to the query name. -
Click Copy REST URL.
-
Send a request to that URL from the API platform of your choice.
Note:Managed queries are executed over an ODBC connection. In most cases, this behaves just like any other SQL execution, but note that ODBC-specific behavior may apply in some edge cases.
You results are returned as JSON.
