Jump to

• Request
• Response

Get a Metric Category by ID

get

/api/metric/Categories/{id}

Gets the metric category that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The ID of the metric DDO category to get.

  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
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/metricCategoriesRead"
                    }
                }
            }
        }
    ]
}

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

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/metricCategoriesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object metricCategoriesRead

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

Nested Schema : metricCategoriesRead

Type: object

Show Source

• MetricDDOCategoryID: integer
  Category ID.

  Example: 1
• MetricDDOCategoryName: string
  Category name

  Example: Health
• MetricDDOCategoryPath: string
  Path to the DDO or custom view

  Example: #metric/allMetrics/index?DeviceID=<DeviceID>&TimeRange=now-24h..now&MetricSource=All
• MetricTypes: array MetricTypes
  Metric types included in this category
• TabOrder: integer
  The tab order index for the specific category

  Example: 1

{
    "properties":{
        "MetricDDOCategoryID":{
            "description":"Category ID.",
            "type":"integer",
            "example":"1"
        },
        "MetricDDOCategoryName":{
            "description":"Category name",
            "type":"string",
            "example":"Health"
        },
        "MetricDDOCategoryPath":{
            "description":"Path to the DDO or custom view",
            "type":"string",
            "example":"#metric/allMetrics/index?DeviceID=<DeviceID>&TimeRange=now-24h..now&MetricSource=All"
        },
        "TabOrder":{
            "description":"The tab order index for the specific category",
            "type":"integer",
            "example":"1"
        },
        "MetricTypes":{
            "description":"Metric types included in this category",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "MetricTypeID":{
                        "description":"Metric Type ID",
                        "type":"integer",
                        "example":22
                    },
                    "MetricTypeName":{
                        "description":"MetricTypeName",
                        "type":"string",
                        "example":"Memory Used"
                    }
                }
            }
        }
    },
    "type":"object"
}

Nested Schema : MetricTypes

Type: array

Metric types included in this category

Show Source

• Array of: object items

{
    "description":"Metric types included in this category",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "MetricTypeID":{
                "description":"Metric Type ID",
                "type":"integer",
                "example":22
            },
            "MetricTypeName":{
                "description":"MetricTypeName",
                "type":"string",
                "example":"Memory Used"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• MetricTypeID: integer
  Metric Type ID

  Example: 22
• MetricTypeName: string
  MetricTypeName

  Example: Memory Used

{
    "type":"object",
    "properties":{
        "MetricTypeID":{
            "description":"Metric Type ID",
            "type":"integer",
            "example":22
        },
        "MetricTypeName":{
            "description":"MetricTypeName",
            "type":"string",
            "example":"Memory Used"
        }
    }
}

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":{
                "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.

Back to Top