Jump to

• Request
• Response

Get the Metric Tabs for a Device

get

/api/metric/Categories/readMetricTabs

Gets the metric tabs that are available for the specified device, to be used by the dynamic tab portlet.

Request

Query Parameters

• DeviceID(required): integer(int32)
  The ID of the device to get metric tabs for. Specify either DeviceName or DeviceID. DeviceName will be given preference if you specify both.

  Example:

  1

• DeviceName(required): string
  The name of the device to get metric tabs for. Specify either DeviceName or DeviceID. DeviceName will be given preference if you specify both.

  Example:

  router.example.com

• DeviceZoneName(required): string
  The device zone name.

  Example:

  Default First Zone

• filter: object
  The fields to filter the results by. You cannot filter by fields that contain a state.
  This parameter's value uses the following JSON format:
  {
  "property": "property",
  "value": "propertyValue",
  "operator": "operator",
  "conjunction": "conjunction"
  }
  
  If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

  • conjunction: string
    Default Value: OR

    Allowed Values: [ "AND", "OR" ]

    The conjunction between filters.

    Example: AND
  • operator: string
    Default Value: LIKE

    Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

    The filter operation to use.

    Example: eq
  • property(required): string
    The name of the field to filter on.

    Example: name
  • value(required): string
    The value of the field to filter on.

    Example: test

  {
      "required":[
          "property",
          "value"
      ],
      "properties":{
          "property":{
              "description":"The name of the field to filter on.",
              "type":"string",
              "example":"name"
          },
          "value":{
              "description":"The value of the field to filter on.",
              "type":"string",
              "example":"test"
          },
          "operator":{
              "description":"The filter operation to use.",
              "type":"string",
              "default":"LIKE",
              "enum":[
                  "eq",
                  "ne",
                  "gte",
                  "gt",
                  "lte",
                  "lt",
                  "LIKE",
                  "NOT LIKE",
                  "re",
                  "not re",
                  "NOT IN"
              ],
              "example":"eq"
          },
          "conjunction":{
              "description":"The conjunction between filters.",
              "type":"string",
              "default":"OR",
              "enum":[
                  "AND",
                  "OR"
              ],
              "example":"AND"
          }
      },
      "type":"object"
  }

• limit: integer(int32)
  The number of records to limit results by.

  Example:

  100

• query: string
  A string to search for. This is a primitive filter, generally applied as a filter on a name parameter, but each endpoint implements it differently.

  Example:

  text

• sort: object
  The field and direction to sort results by. You cannot sort by fields that contain a state.
  This parameters value uses the following JSON format:
  {
  "property": "property",
  "direction": "direction"
  }

  • direction(required): string
    Allowed Values: [ "ASC", "DESC" ]

    The direction of the sort.

    Example: ASC
  • property(required): string
    The field to sort on.

    Example: name

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object"
  }

• start: integer(int32)
  The page of results to start from.

  Default Value: 0

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricCategoriesReadMetricTabs"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricCategoriesReadMetricTabs"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object metricCategoriesReadMetricTabs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/metricCategoriesReadMetricTabs"
    }
}

Nested Schema : metricCategoriesReadMetricTabs

Type: object

Show Source

• DashboardID: string
  Dashboard ID

  Example: Tab1
• DashboardName: string
  Dashboard Name

  Example: Health
• DashboardValue: string
  The view to load for the tab.

  Example: Metric.allMetricsOverview.crud.view.AllMetricsOverviewView
• Filters: object Filters
  Filter to apply to the grid view once it is loaded.
• Params: object Params
  Parameters to pass to the dashboard once it is loaded.
• RenderType: string
  Render Type

  Example: { "id":"1", "name":"String" }
• TabName: string
  Tab Name

  Example: Health

{
    "properties":{
        "DashboardID":{
            "description":"Dashboard ID",
            "type":"string",
            "example":"Tab1"
        },
        "DashboardName":{
            "description":"Dashboard Name",
            "type":"string",
            "example":"Health"
        },
        "TabName":{
            "description":"Tab Name",
            "type":"string",
            "example":"Health"
        },
        "DashboardValue":{
            "description":"The view to load for the tab.",
            "type":"string",
            "example":"Metric.allMetricsOverview.crud.view.AllMetricsOverviewView"
        },
        "RenderType":{
            "description":"Render Type",
            "type":"string",
            "example":{
                "id":"1",
                "name":"String"
            }
        },
        "Filters":{
            "description":"Filter to apply to the grid view once it is loaded.",
            "type":"object",
            "properties":{
                "property":{
                    "description":"property",
                    "type":"string",
                    "example":"MetricTypeName"
                },
                "value":{
                    "description":"Property Value",
                    "type":"string",
                    "example":"^(Memory Used|CPU Utilization|CPU Load Average|Disk Used|Latency)"
                },
                "operator":{
                    "description":"operator",
                    "type":"string",
                    "example":"re"
                }
            }
        },
        "Params":{
            "description":"Parameters to pass to the dashboard once it is loaded.",
            "type":"object",
            "properties":{
                "DeviceID":{
                    "description":"DeviceID",
                    "type":"integer",
                    "example":"11"
                },
                "TimeRange":{
                    "description":"TimeRange",
                    "type":"string",
                    "example":"now-24h..now"
                },
                "MetricSource":{
                    "description":"MetricSource",
                    "type":"string",
                    "example":"All"
                },
                "DeviceSource":{
                    "description":"DeviceSource",
                    "type":"string",
                    "example":"Device"
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : Filters

Type: object

Filter to apply to the grid view once it is loaded.

Show Source

• operator: string
  operator

  Example: re
• property: string
  property

  Example: MetricTypeName
• value: string
  Property Value

  Example: ^(Memory Used|CPU Utilization|CPU Load Average|Disk Used|Latency)

{
    "description":"Filter to apply to the grid view once it is loaded.",
    "type":"object",
    "properties":{
        "property":{
            "description":"property",
            "type":"string",
            "example":"MetricTypeName"
        },
        "value":{
            "description":"Property Value",
            "type":"string",
            "example":"^(Memory Used|CPU Utilization|CPU Load Average|Disk Used|Latency)"
        },
        "operator":{
            "description":"operator",
            "type":"string",
            "example":"re"
        }
    }
}

Nested Schema : Params

Type: object

Parameters to pass to the dashboard once it is loaded.

Show Source

• DeviceID: integer
  DeviceID

  Example: 11
• DeviceSource: string
  DeviceSource

  Example: Device
• MetricSource: string
  MetricSource

  Example: All
• TimeRange: string
  TimeRange

  Example: now-24h..now

{
    "description":"Parameters to pass to the dashboard once it is loaded.",
    "type":"object",
    "properties":{
        "DeviceID":{
            "description":"DeviceID",
            "type":"integer",
            "example":"11"
        },
        "TimeRange":{
            "description":"TimeRange",
            "type":"string",
            "example":"now-24h..now"
        },
        "MetricSource":{
            "description":"MetricSource",
            "type":"string",
            "example":"All"
        },
        "DeviceSource":{
            "description":"DeviceSource",
            "type":"string",
            "example":"Device"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top