Web monitoring application metadata

Table of Contents

Location path
Overview

Location path

Path in the assembly catalog

Path in the assembly catalog
`/era_env/priv/metadata/<SOLUTION>/monitor.json`

/era_env/priv/metadata/<SOLUTION>/monitor.json

Overview

Metadata file for the web application "Monitoring". Sets the structure of objects, methods, parameters, filters and their descriptions.

Provides the web application with a description of the structure of the methods API /api/monitor/v1/<OBJECT>/<METHOD>.

The "Incoplax" is not used directly by the system, it is only used for output via API. On this basis, the content of the files is arbitrary, including the internal structure.

It is deprecated for use in REST.

Format:

{
  "objects": {
    "<OBJECT>": {
      "title": "<TITLE>",
      "methods": [
        {
          "method": "<METHOD_NAME>",
          "modes": ["<MODE_1>", ...],
          "filters": [
            {
              "name": str,
              "type": str,
              "min": int,
              "inputtype": str,
              "title": str,
              "help": ["String1", "String2", ...]
            },
            ...
		  ],
          "params": [
            {
              "name": str,
              "type": str ("integer", "text"),
              "inputtype": str ("select", "text"),
              "min": int,
              "options": {
                "Key1": "Title1",
                "Key2": "Title2",
                ...
              },
              "title": string,
              "help": ["String1", "String2", ...]
            },
            ...
          ]
        },
        ...
      ]
    },
    ...
  }
}

Table 1. Structure fields
Field	Description
`<OBJECT>`	The name of the object type to be substituted in the placeholder URL.
`title и <TITLE>`	The name of the object type displayed in the selection list/table in the web application.
`method и <METHOD_NAME>`	the name of the object method to be substituted in the placeholder URL.
modes и <MODE_X>`	(optional) list of possible modes as one of the parameters of the executed API method (parameter `mode`).
`filters`	(optional) list of filters that can be used as parameters of the API method being executed. Parameter descriptor fields
`params`	(optional) list of parameters that can be assigned. Parameter descriptor fields

Table 2. Parameter descriptor fields
Field	Description
`name`	parameter name.
`type`	parameter header displayed in the application.
`inputtype`	parameter header displayed in the application (`text`, `select`).
`min`	(optional, for `type = integer`) the minimum allowed value.
`max`	(optional, for `type = integer`) the maximum allowed value.
`options`	(for `inputtype = select`) list of value options in the format `key-title`.
`title`	parameter header displayed in the application.
`help`	multiline tooltip displayed in the application, as a list of strings.