What you'll do

Setup your environment: In order to deploy DataGraph, you will need to set up some assets in Exchange and deploy some APIs that we will leverage within DataGraph.

  1. Publish specifications in Design Center
  2. Create assets in API Manager
  3. Deploy APIs in Runtime Manager

DataGraph Setup

  1. Add Orders API to unified schema
  2. Add Shipment API to unified schema
  3. Add Sales API to unified schema

What you'll learn

How to create a unified schema

How to merge types

How to link types

What you'll need

In order to import APIs into DataGraph, you will need to publish their specifications (either RAML or OAS) to Exchange. For this lab, we will be publishing the Orders, Shipment, and Sales APIs in order to build our Unified Schema. Download the assets below.

Download the following ZIP files:

Orders API RAML Shipment API RAML Sales API RAML

After downloading the RAML spec zips, navigate to the Exchange for the Business Group you will be using for this lab.

Import Orders API

  1. Click Publish new asset in the top left.

  1. For asset name enter Orders API
  2. For asset type, select REST API in the drop down
  3. Check Upload a RAML
  4. Click Publish

Repeat these steps for Shipment API and Sales API

After publishing all three APIs, your Exchange assets should look like the following:

In order to manage the APIs, we will need to create API Manager entries for each. We will need to save the autodiscovery IDs for deployment later. I suggest opening some kind of text editor and pasting the following in to help keep track of these values:

Orders AID:
Shipment AID:
Sales AID:

Environment Client ID:
Environment Client Secret:

Create Orders API API Manager entry

  1. Navigate to API Manager
  2. Click Manage API in the top left
  3. Choose Manage API from Exchange
  4. In the API name field, start typing Orders API and select the API when it pops up as a dropdown.

  1. Click Save

  1. After creating the API, log the auto discovery ID in your text editor

Repeat this process for the Shipment API and Sales API

After completing the setup process, you should see the following entries in API Manager:

Now that we have created the API assets in Exchange and API Manager, we are ready to deploy the applications. Before deploying, we will need the Environment Client ID and Secret in order to allow the apps to register with API Manager.

  1. Navigate to Access Management
  2. Click on Environments
  3. Click on the text of the environment you will be deploying into
  4. Copy the Client ID and Secret into your text editor

Download the following JAR files:

Orders API JAR Shipment API JAR Sales API JAR

Deploy Orders API

  1. Navigate to Runtime Manager
  2. Click Deploy application in to the left
  3. Set the application name to datagraph-orders-api-{SOMETHING UNIQUE LIKE YOUR INITIALS}
  4. In the Application File box, click Choose file and select Upload file
  5. Select the Orders API JAR file
  6. Click on the Properties tab
  7. Add a property called api.autodiscovery.id and set the value to the ID we created earlier

  1. Add a property called anypoint.platform.client_id and set the value to the Environment Client ID we copied earlier
  2. Add a property called anypoint.platform.client_secret and set the value to the Environment Client Secret we copied earlier
  3. Add a property called app.client_secret and hardcode the value to 1111
  4. Add a property called app.client_id and hardcode the value to 1111

  1. Click Deploy Application
  2. After deployment finishes, navigate back to runtime manager and click on the application
  3. Copy the App url

  1. Navigate to API Manager
  2. Click on the text of the Orders API entry in order to edit the entry.
  3. Paste the URL you copied into the Consumer endpoint field, adding /api to the end.

Repeat this process for the Shipment API and Sales API

With our APIs deployed and managed, we are finally ready to get started with DataGraph! This is the easy part! This scenario will walk you through the entire process of using our now existing APIs published in Exchange (with their corresponding Managed Instances) to first build the DataGraph Unified Schema and then execute GraphQL queries. This includes:

  1. Navigate to DataGraph

  1. Click Add API
  2. Select datagraph-order-api from the list of APIs in Exchange and click on Next: Configure URL

  1. Confirm the version of the API you want to add to DataGraph and click on Confirm selection

  1. By default, you should see the API instance you set up earlier automatically selected. You should see your unique CloudHub URL.

  1. Click on Next: Provide authentication
  2. By default, No Auth is selected. Explore the options available; select No Auth when done

  1. Click Next: Preview Schema button in the popup. Here you can view the Schema pulled from the API specification

  1. Click Next: Edit Schema
  2. At this point, it is important to notice that Nested Types are hidden by default. Let's enable them so that developers can access this data if they need it!
  3. Click on each Nested Type and change the Desired State to Visible

  1. We have one additional step required. In order to allow other types in the local API schema or Unified Schema to Link or Merge with this type and extend the datasets, you must enable collaboration. Collaboration empowers developers to create a robust Unified Schema. Click on the Order type on the left hand side of the panel and click on Enable Collaboration
  1. When you click on Enable Collaboration you'll be prompted to define the default query and the primary key. Make sure you select orderId as the primary key.

  1. Once confirmed, you'll have the following information for the Order type regarding Collaboration Permissions

  1. Finally, click Next: Add to Unified Schema to proceed. The following message appears; just click Proceed to Unified Schema.

Following the same steps used previously, add the datagraph-shipment-api to the Unified Schema.

For this new API, you'll have a couple of Nested Types (Carrier, Status) as well. Make them visible just in case anyone wants to run queries which include this information. Be sure to enable collaboration for the Shipment type.

Click Next: Add to unified schema to finalize.

Add the datagraph-sales-api following the same steps you used for the previous APIs.

At this point, you should see that we have a conflict: there is already another type in the Unified Schema with the name Order. We will need to resolve this conflict before proceeding.

To resolve this issue, we can Rename this new Order type or Merge with the current type. We know that in this case, these are the same objects; we want to extend the existing Order type with the fields coming from this new object. In order to do this, let's merge the types!

  1. Click on the merge link in the error message; this should take you down to the merge section on the same screen. If it doesn't, simply scroll down.
  2. DataGraph automatically recommends merging this Order type from the Sales API with the Order type already in the Unified Schema. Select Order type from the dropdown list to merge with the new Order type being imported.

  1. At this point, you have to choose how you want to merge these structures. Click See an example for each merge type to see the potential structures. In this case, we want to have an Order type that contains data from the original type and the new type we're adding, so we will select the first type: Add the fields from the two...
  2. Before we can finalize these settings, we have to Enable Collaboration - a requirement whenever merging or linking types. By now this process should be a breeze for you! Make sure you choose orderId as your primary key.
  3. Before finalizing, click Preview merge result in order to get a preview of the final merge result

  1. In this preview, you can see how the merge has been configured. Let's pay attention to the list of fields, because it is important to notice that with a single query we'll get details of the Order coming from two different APIs. Notice that the field customerEmail is not coming from the new Order type because there already is a field with the same name in the existing Order type.
  2. Click Confirm merge
  3. Now that we've cleared up the conflicts, we can proceed!

We could finish this API up here, adding this merged Order type to the Unified Schema. Before we do that though, we will explore some additional capabilities of DataGraph by making some changes to the schema. DataGraph gives us the ability to both hide and unhide individual fields, as well as rename fields. Let's change the field named origination to location.

  1. Click the Rename field button to the right of the field origination
  2. Set the name to location
  3. Click Confirm

Next, go ahead and make the remaining nested types visible. This should be pretty easy for you at this point!

We still aren't done! We've seen how to merge types, but what about linking types? We now have a type, Delivery, which we can use to link to the Shipment API. Let's go ahead and create that link.

  1. Click on the Delivery type
  2. Scroll down to the Link section
  3. Select the type you want to link to: Shipment
  4. Select the ID we will use when linking; this ID comes from the delivery type and is shipmentId
  5. Click Save changes

  1. After linking shipment in Delivery type with the existing Shipment type in the Unified Schema, you'll see the following in the Delivery type configuration

Finalize by clicking Next: Add to unified schema

  1. Click the Run Query Button in the top right.
  2. The Unified Schema Endpoint is automatically secured using client_id enforcement policy, so you need to request access to get any data. When clicking Run Query, you will automatically be prompted to either select an existing application or create a new one. Let's choose to create a new application.

  1. Once the credentials for the newly created application are validated, you'll see the query builder. Run the following query:
  ordersById (id: "122344") {

Let's try a more complicated query that gets details from all three APIs!

  ordersById (id: "122344") {
    product {
    deliveryInfo {
      shipment {
      deliveryAddress {

Query builder includes capabilities beyond simply running queries! The tool empowers you to test that the Unified Schema is working properly, and that the downstream APIs are performing correctly and properly configured.

Let's click the track query button again and run the same query from the end of the previous section:

As you can see above, we are able to track the calls being made by this query, and the response times of the downstream sources. This is a powerful tool providing you the ability to track down issues with responsiveness and see a high level profile of your query.

Next, click the View Response Logs

By default, the logs open filtered to your most recent query:

This provides a quick and easy view into exactly what is going on within the DataGraph runtime.