Using the BMC Helix API data source

As a tenant administrator, use the out-of-the-box BMC Helix API data source that is preconfigured to visualize data from BMC Helix applications by using the API endpoints. For more information, see JSON API.

Important

For the following query types, use the BMC Helix data source plug-in. Do not use the BMC Helix API data source for collecting data from these query types.

  • Audit query
  • Events query 
  • Metric query
  • Log query
  • Service Management

Example: Display service names by using the BMC Helix API data source

Let's say you are a tenant administrator who uses the out-of-the-box Service Dashboard for tracking KPIs and metrics for selected services. When you have multiple services selected in the Service Dashboard, use the BMC Helix API data source to configure panels to display the name of the respective services. This option will help you identify the metrics and KPIs for a selected service in the dashboard.

To configure the BMC Helix API data source

  1. While creating a new dashboard or panel, select BMC Helix API data source from the list of data sources.

  2. In the query editor of the BMC Helix API data source, configure the following options:

    Option

    Action

    Fields

    Extract the data from the JSON response returned from the URL that is configured in the data source. On the Fields tab, configure the following options: 

    • Field—Enter the query to collect the data.
      BMC Helix API data source supports two query languages: JSONPath and JSONata. Specify the following JSONata query in this field to collect the name of the services for the above example:

      $.results[*].name
    • Type—Select the type of data that is returned by the URL. 
      The following types are supported:
      • Auto
      • String
      • Number
      • Time
      • Boolean
    • Alias—Select this option to override the default name of the field.

    Path

    Configure the HTTP method of the request sent to the URL. You can set this option to GET or POST. Specify the text that you want to append to the URL in the data source.
    Select GET and specify the following path to display the name of the services for the above example:

    /smart-graph-api/api/v1.2/data/search

    Params

    In the Key and the Value fields, add any parameters that you want to send as a part of GET/POST request.
    Specify the following parameters for the above example:

    • format—object
    • query—SEARCH BusinessService WHERE name ='${servicename}' SHOW name,#id
    • limit—1000

    Headers

    In the Key and the Value fields, add any parameters that you want to send as HTTP headers.

    Body

    Enter the text that is sent as a request. You can enter the value in text, JSON and XML formats.

    Cache  time

    Set the cache time of your query. By default, this option is set to 0s.

  3. To create multiple queries, click Query json_add_query_22_4_02.png.


 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*