REST API for Unified Assurance Core

Get the TopN Overview Title

get

/api/metric/TopNData/readTitle

Gets the TopN overview title the objects specified in the query parameters.

Request

Query Parameters

BaseName(required): string
A custom portion of the title displayed between the "Top-N" and the details of what is being displayed.
Example:
DeviceGroupID(required): integer
The ID of the device group to get the TopN overview title for.
Example:
```
7
```
MetricGroupID(required): integer
The ID of the metric group to get the TopN overview title for.
Example:
```
1
```
MetricTypeID(required): integer
The ID of the metric type to get the TopN overview title for.
Example:
```
1
```
PageSize(required): integer
The number of records to include per page.
Example:
```
10
```

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : schema

Match All

Show Source

object SuccessfulGetOperation

The response body for a successful get operation.
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",
                    "description":"The TopN overview title.",
                    "items":{
                        "$ref":"#/components/schemas/metricTopNDataReadTitle"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

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

{
    "description":"The response body for a successful get operation.",
    "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

The TopN overview title.
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",
            "description":"The TopN overview title.",
            "items":{
                "$ref":"#/components/schemas/metricTopNDataReadTitle"
            }
        }
    }
}

Nested Schema : data

Type: array

The TopN overview title.

Show Source

Array of: object metricTopNDataReadTitle

{
    "type":"array",
    "description":"The TopN overview title.",
    "items":{
        "$ref":"#/components/schemas/metricTopNDataReadTitle"
    }
}

Nested Schema : metricTopNDataReadTitle

Type: object

Show Source

title: string

title

Example: Top-10 : (Device Group: Oracle Lab - test)

{
    "properties":{
        "title":{
            "description":"title",
            "type":"string",
            "example":"Top-10 : (Device Group: Oracle Lab - test)"
        }
    },
    "type":"object"
}

Default Response

Failed operation

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":{
                "description":"An error.",
                "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

An error.

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

Nested Schema : items

Type: object

An error.