BETA Consuming Resource Data with GraphQL

What is GraphQL?

GraphQL is a data standard first created by Facebook in 2012. Much like how SQL is a language for querying databases, GraphQL is a language for querying APIs. With GraphQL you are able to ask an API about what sort of data it provides. Once you are aware of the API's schema you can proceed to ask for data by specifying exactly what you want. Queries are written with and returned in common JSON.

For more information on how to write queries in GraphQL, see https://graphql.org.

The URL for the Resource Browser GraphQL endpoint is https://graphql.hirnetwork.org/graphql

Getting Started

The GraphQL endpoint is hosted at https://graphql.hirnetwork.org. To assist in making GraphQL queries, we make use of a handy user interface called Banana Cake Pop. When you follow the link for the first time, you will encounter a couple of prompts.

Step 1 click on "create document" to create a GraphQL query document.

Step 2 enter your GraphQL query in the Operations Window. See Step 4 to generate samples to try.

Step 3 alternatively, you can click on the "Schema" tab to view the Root Types, SDL and Insights.

Click on "Query" to get the Root Types.

Click on links in query results to drill down the schema hierarchy.

Step 4 try a few sample queries. Click "Try It" to generate a sample query to copy/paste into the Operations window.
Try it! Get List of Model Organisms
Try it! Get a specific Resource by Canonical Identifier
Try it! Get a specific Resource with more detail
.