REST API Monitoring schema syntax
search cancel

REST API Monitoring schema syntax

book

Article ID: 270648

calendar_today

Updated On:

Products

DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

Is there detailed documentation about REST API syntax?

Can the "value" section of the "metrics" section contain multiple values, or does it have to be only one value/result?

Environment

  • Release: 20.4

Resolution

  • Each metric can only have one value to correspond to a specific field/key in the JSON response.
    For example, if the disk usage, and disk usage percent fields are returned by the same  JSON - then both of those fields will be separate metrics in the schema file.

  • '%d' indicates the value is a digit,  

  • '$' indicates a value, common parameters, like $value, $unit. 

  • @ return the attribute value: it's followed by the attribute name.

 DX RESTMon Schema Development Guide

Additional Information

UIM RESTMon starter guide.

These all are the JSON path expressions and nothing specific to RestMON.

Below are some links for the reference:

  1. https://github.com/json-path/JsonPath
  2. https://docs.oracle.com/cd/E60058_01/PDF/8.0.8.x/8.0.8.0.0/PMF_HTML/JsonPath_Expressions.htm
  3. https://support.smartbear.com/alertsite/docs/monitors/api/endpoint/jsonpath.html
  4. https://www.baeldung.com/guide-to-jayway-jsonpath