Writing a GraphQL query

You often need to retrieve already persisted event data from Supply Chain Intelligence Suite, for use in your application. For example, you might have registered a KPI Rule and then later want to query for the KPI metric events so that you can show them on your dashboard. In this tutorial, you learn how issue a variety of basic queries to fetch business rule events from Supply Chain Intelligence Suite's GraphQL APIs.

1. Navigate to the GraphiQL visual editor.
2. Input the following sample query into the left side of the editor. If you have a sample rule ID from another tutorial, replace the ID below with your other rule's ID:

   query{ 
     businessRuleEvents(
       simpleFilter: {
         rule: {
           id: "4cb28d31-4ebc-476c-8460-c79ecd8bbc12"
         }
       },
       cursorParams: {
         first: 1 #Maximum number of items to return
       }
     ){
       totalCount
       pageInfo {
         endCursor
         hasNextPage
       }
       edges {
         cursor
         object {
           eventCode
           timestampEventOccurred
           timestampEventReceived
           
         }
       }
     }
   }
     

3. Click the run button on the left-top side of the editor. This runs the query and retrieve the business events that are already stored for this rule.
   

   The response shows the following result on the right side of the editor:

   {
     "data": {
       "businessRuleEvents": {
         "totalCount": 39,
         "pageInfo": {
           "endCursor": "NGNiMjhkMzEtNGViYy00NzZjLTg0NjAtYzc5ZWNkOGJiYzEyX2V2ZW50ZGV0YWlscy5ldmVudHNvdXJjZS50cmFuc2FjdGlvbnR5cGVfODIwLHRlbmFudGlkXzNlMzc0NDJkLTIyNjUtNDg3ZC1hNTJmLTVlYWQxMTg5M2IxYSxtaW51dGVfMjAwOS0wOC0zMHQxODo0MF8=",
           "hasNextPage": true
         },
         "edges": [
           {
             "cursor": "NGNiMjhkMzEtNGViYy00NzZjLTg0NjAtYzc5ZWNkOGJiYzEyX2V2ZW50ZGV0YWlscy5ldmVudHNvdXJjZS50cmFuc2FjdGlvbnR5cGVfODIwLHRlbmFudGlkXzNlMzc0NDJkLTIyNjUtNDg3ZC1hNTJmLTVlYWQxMTg5M2IxYSxtaW51dGVfMjAwOS0wOC0zMHQxODo0MF8=",
             "object": {
               "eventCode": "businessEvent",
               "timestampEventOccurred": "2009-08-30T18:40:16+0000",
               "timestampEventReceived": "2019-12-05T12:07:00"
             }
           }
         ]
       }
     }
   }

   Note: This is a live system. The exact response that you see might vary from the above screen capture as new events are constantly being fired.