Manage a Metric

Get metric details and deletes the metric and it's dependent metric data from the system

Get the metric details.

Path Parameters

  • tenantIdstringrequired

    Describes clientId or mspId of the tenant

  • metricNamestringrequired

    Describes unique metric name

Responses

This endpoint accepts anyOf the following:

object

  • metricNamestring

  • metricSourcestring

  • displayNamestring

  • descriptionstring

  • unitstring

  • unitLabelstring

  • groupNamestring

  • factorinteger

  • consolFuncstring

  • displayByComponentboolean

  • displayOrderinteger

  • topMetricboolean

  • timeSeriesboolean

  • warnRepeatCountinteger

  • criticalRepeatCountinteger

  • recommendedinteger

  • useExpressionboolean

  • unitConversionFactorinteger

  • statusstring

    Enum:
    activedelete-pending
  • typestring

  • resourceTypestring

object

  • messagestring

Loading Examples...

Update a basic metric details by metric name

Path Parameters

  • tenantIdstringrequired

    Describes clientId or mspId of the tenant

  • metricNamestringrequired

    Describes unique metric name

Request Body

application/json

  • metricNamestring

  • metricSourcestring

  • displayNamestring

  • descriptionstring

  • unitstring

  • unitLabelstring

  • groupNamestring

  • factorinteger

  • consolFuncstring

  • displayByComponentboolean

  • displayOrderinteger

  • topMetricboolean

  • timeSeriesboolean

  • warnRepeatCountinteger

  • criticalRepeatCountinteger

  • recommendedinteger

  • useExpressionboolean

  • unitConversionFactorinteger

  • statusstring

    Enum:
    activedelete-pending
  • typestring

  • resourceTypestring

Loading Examples...

Responses

  • metricNamestring

  • metricSourcestring

  • displayNamestring

  • descriptionstring

  • unitstring

  • unitLabelstring

  • groupNamestring

  • factorinteger

  • consolFuncstring

  • displayByComponentboolean

  • displayOrderinteger

  • topMetricboolean

  • timeSeriesboolean

  • warnRepeatCountinteger

  • criticalRepeatCountinteger

  • recommendedinteger

  • useExpressionboolean

  • unitConversionFactorinteger

  • statusstring

    Enum:
    activedelete-pending
  • typestring

  • resourceTypestring

Loading Examples...