Get Metrics Model Metadata

Retrieves high level detail of all existing catalog metrics model with device type and entity type.

Request

URI

GET

https://{api_host}/tcsa.host.com/v1/catalog/metric-types

COPY

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns Array of MetricMetadataModel of type(s) application/json

[
    {
        "deviceType": "Switch",
        "entityType": "Port",
        "is_base_model": true
    },
    {
        "deviceType": "BladeEnclosureManager",
        "entityType": "Interface",
        "is_base_model": true
    }
]

400

Invalid Request sent by the user

Returns ErrorDetails of type(s) application/json

{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}

string

errorCode

Required

Error code for the failed request

string

message

Required

Short summary of the error occurred

string

detailedMessage

Optional

Detailed message with probable solution

401

User authentication failed

Returns ErrorDetails of type(s) application/json

{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}

string

errorCode

Required

Error code for the failed request

string

message

Required

Short summary of the error occurred

string

detailedMessage

Optional

Detailed message with probable solution

403

Access to the requested resource/operation is forbidden

Returns ErrorDetails of type(s) application/json

{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}

string

errorCode

Required

Error code for the failed request

string

message

Required

Short summary of the error occurred

string

detailedMessage

Optional

Detailed message with probable solution

404

Cannot find requested resource

Returns ErrorDetails of type(s) application/json

{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}

string

errorCode

Required

Error code for the failed request

string

message

Required

Short summary of the error occurred

string

detailedMessage

Optional

Detailed message with probable solution

500

Internal server error

Returns ErrorDetails of type(s) application/json

{
    "errorCode": "string",
    "message": "string",
    "detailedMessage": "string"
}

string

errorCode

Required

Error code for the failed request

string

message

Required

Short summary of the error occurred

string

detailedMessage

Optional

Detailed message with probable solution

On This Page

Description

Request

Authentication

Response

200 Response Body

Errors

Catalog Operations

GET

Get Metric Entities

GET

Get Metrics Model Metadata