1. REST API for Unified Assurance Core
  2. Tasks
  3. Metrics
  4. Metric Categories

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.
An example path with query parameters is:
/api/metric/Categories/readMetricTabs?DeviceName=router.example.com;z1

Request

Query Parameters
  • 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
  • The serialized 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;z1 OR router.example.com
  • The device zone ID.
    Example:
    1
  • 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.
    • Default Value: OR
      Allowed Values: [ "AND", "OR" ]
      The conjunction between filters.
      Example: AND
    • 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
    • The name of the field to filter on.
      Example: name
    • The value of the field to filter on.
      Example: test
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • 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
  • 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" }
    Example:
    [
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]
  • The page of results to start from. This parameter is ignored if you do not also set the limit parameter.
    Default Value: 0
    Example:
    1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : metricCategoriesReadMetricTabs
Type: object
Show Source
Nested Schema : Filters
Type: object
Filter to apply to the grid view once it is loaded.
Show Source
Nested Schema : Params
Type: object
Parameters to pass to the dashboard once it is loaded.
Show Source

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : errors
Type: array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type: object
An error.
Back to Top

Examples

The following example shows how to use query parameters in Get Device Details requests. The parameters specify the device's serialized name (the device name appended with zone number) and specifies the detail level.

http://hostFQDN/api/device/DeviceViews?DeviceName=router.example.com;z3&DetailLevel=Minimal

You can submit a request using cURL, an API client, or your browser.

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
  "success": "true",
  "message": "Loaded 1 entries",
  "total": "1",
  "data": [
    {
      "PropertyName": "Device Name",
      "PropertyValue": "router.example.com"
    },
    {
      "PropertyName": "Timestamp Added",
      "PropertyValue": "2022-10-27 07:23:09"
    },
    {
      "PropertyName": "Timestamp Modified",
      "PropertyValue": "2023-05-16 22:30:26"
    },
    {
      "PropertyName": "IP Address",
      "PropertyValue": "192.0.2.1"
    },
    {
      "PropertyName": "IPv6 Address",
      "PropertyValue": null
    },
    {
      "PropertyName": "Device ID",
      "PropertyValue": "43"
    },
    {
      "PropertyName": "Custom Name",
      "PropertyValue": ""
    },
    {
      "PropertyName": "DNS Name",
      "PropertyValue": "dev1.example.com"
    },
    {
      "PropertyName": "Sys Name",
      "PropertyValue": "dev1"
    },
    {
      "PropertyName": "Sys OID",
      "PropertyValue": "1.2.3.4"
    },
    {
      "PropertyName": "Description",
      "PropertyValue": "Linux router 1.2.3.4.x86_64 #2 SMP Tue Jan 18 13:44:44 PST 2022 x86_64"
    },
    {
      "PropertyName": "Location",
      "PropertyValue": "Unknown"
    },
    {
      "PropertyName": "Contact",
      "PropertyValue": "root@localhost"
    },
    {
      "PropertyName": "Services",
      "PropertyValue": "0"
    },
    {
      "PropertyName": "IP Forwarding",
      "PropertyValue": "1"
    },
    {
      "PropertyName": "Serial Number",
      "PropertyValue": ""
    },
    {
      "PropertyName": "Device Type Name",
      "PropertyValue": "Linux"
    },
    {
      "PropertyName": "Device Type Category",
      "PropertyValue": "Appliance"
    },
    {
      "PropertyName": "GeoLocation",
      "PropertyValue": "{\"type\": \"Point\", \"coordinates\": [0.0, 0.0]}"
    }
  ]
}
Back to Top