How to: Query Data Model Records Data

Estimated Reading Time:  7 minutes

Overview

There are various methods for querying A query lets you retrieve, access, manipulate, and delete data in a database. Data Model records data in Unqork. For example, authenticating and using Postman to retrieve your records data. These querying tools help test 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. calls and confirm records data are complete and accurate. To make it easier to query data on the Unqork Designer Platform, each environment includes a GraphQL Sandbox to query and perform SQL SQL (Structured Query Language) is language used in programming and designed for managing data contained in a relational database system.-like filtering commands on your Data Model's records. How you filter your data depends on the commands you configure in a remote execute API module.

Before querying data, there are three steps to follow to set up and authenticate your GraphQL Sandbox:

What You'll Learn

In this article, you'll learn how to use your environment's GraphQL sandbox to query Data Model records.

Locate Your Model ID

Remember, Unqork workspaces, applications, and modules are assigned a unique identifier at creation. The same applies to Data Models. A Data Model's unique identifier is referred to as the model ID. To locate the model ID:

2.

To the left of the page, click  Data Models.

Your browser window displays the following URL format: https://{your-env}.unqork.io/workspaces/{workspaceId}/data-model/{modelId}.

Highlight the model ID and copy it for use in configuring your API module. The following image is an example of a model ID in the browser:

Create an API Module to Query Records Data

To save you time, we've created an API module that lets you query records data, as well as perform SQL-like count and filtering commands. You can find this remote execute API module in the Training environment here: https://training.unqork.io/#/form/63c94f7d9b81f136267efaf0/edit.

To take advantage of this preconfigured API module, copy and paste its module definition to a new module in your environment.

IMPORTANT  Confirm your new module exists in the same workspace as your Data Model.

Add Your Model ID

Now that you have your new API module, open it and add your model ID.

To add and connect your model ID to your new API module:

2.

In the Module Builder, hover over the modelId Hidden component.

3.

Using the toolbar, click the (Settings) button.

Explore the Preconfigured API Module

The various components in this module let you query Data Model records and count, filter, or skip records using logic components. Here are a few highlights on how the configuration works:

calcClean Vars Calculator Component:

plugGetModelRecords Plug-In Component:

Because this preconfigured API module is just a blueprint, you can adjust and reconfigure as you see fit.

Authenticate Your GraphQL Sandbox

Now that your API module is set up, it's time to access and authenticate your GraphQL Sandbox.

Locate the Authentication Token

To use your environment's GraphQL Sandbox, you first need to find your environment's unqorkio authentication token.

To locate the authentication token:

Access Your Environment's API GraphQL Sandbox

To access your environment's API GraphQL Sandbox:

Authenticate Access to Your Environment

An authentication token is required to perform queries or mutations. On initial page load, the Unable to Reach Server modal A modal is a window that appears on top of the content you are currently viewing. displays. To gain access to the environment any perform functions, you must insert your unqorkio token into HTTP HTTP (Hypertext Transfer Protocol) is an application-layer protocol used to transmit hypermedia documents like HTML. Headers.

To authentic access to your environment:

Successful authentication is denoted by the error message modals clearing from the Response panel.

Query Data Model Records Data

Now that your GraphQL Sandbox is authenticated, you can begin querying Data Model records.

To query your Data Model records data:

query GetDataModels($modelId: String!) {
ads {
modelRecord {
getModelRecords(modelId: "modelId") {
records {
data
}
}
}
}
}

3.

Click GetDataModels.

In the Response panel, all your Data Model's records display. During this course, you made a Data Model for an insurance application. The response you see is specific to the fields in the schema you created, and the values are those entered by the end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product..

Using the Preconfigured Filtering and Counting Options

You can also use the GraphQL to take advantage of the arguments preconfigured in your API module. In the top-left corner of the GraphQL Sandbox, click >> (expand). A new panel displays to the left of the Operation panel. In this Documentation panel, you can select options to count the total records, limit records that display, and skip a specified number of records in the response.

Arguments

Select and clear these options to add and remove arguments from the request.

Fields

Select and clear these options to add and remove fields from the request.

Resources

• Introduction to Data Modeling

• Schemas Viewer

• Data Models Viewer

• Apply Data Modeling to a Module

• JSON Schema Component Mapping

• How to: Create Data Models for a Case Management Application

• How to: Apply Data Models to a Case Management Application