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
-
conjunction:
string
-
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
-
direction(required):
string
-
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 TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : metricCategoriesReadMetricTabs
Type:
Show Source
object
-
DashboardID: string
Dashboard IDExample:
Tab1
-
DashboardName: string
Dashboard NameExample:
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 TypeExample:
{ "id":"1", "name":"String" }
-
TabName: string
Tab NameExample:
Health
Nested Schema : Filters
Type:
object
Filter to apply to the grid view once it is loaded.
Show Source
-
operator: string
operatorExample:
re
-
property: string
propertyExample:
MetricTypeName
-
value: string
Property ValueExample:
^(Memory Used|CPU Utilization|CPU Load Average|Disk Used|Latency)
Nested Schema : Params
Type:
object
Parameters to pass to the dashboard once it is loaded.
Show Source
-
DeviceID: integer
DeviceIDExample:
11
-
DeviceSource: string
DeviceSourceExample:
Device
-
MetricSource: string
MetricSourceExample:
All
-
TimeRange: string
TimeRangeExample:
now-24h..now
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
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