Jump to

• Request
• Response

Update an SLM Metric

put

/api/SLM/ServiceMetrics/{id}

Updates the properties of the SLM metric that matches the specified ID.

Request

Path Parameters

• id(required): string
  The SLM metric ID.

  Example:

  41d09c41-61f0-4827-801e-a54785ed4498

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• CompareOperator: string
  Comparison Operator Allowed Values: - '==' => Equals - '>' => Greater Than - '>=' => Greater Than or Equal - '<' => Less Than - '<=' => Less Than or Equal - '!=' => Not Equals

  Example: <=
• CompareType: string
  Compare Threshold Type Allowed Values: - 'availability' => Availability - 'value' => Value - 'utilization' => Utilization (%)

  Example: utilization
• CompareValue: number
  Compare Threshold Value

  Example: 90
• MetricID: integer
  Metric ID

  Example: 551
• OwnerUserGroupID: integer
  Group that owns the metric

  Example: 0
• OwnerUserID: integer
  The ID of the user who owns the metric. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.

  Example: 0
• ParentServiceID: string
  ServiceID of Parent

  Example: 0253c68c-6e9c-4d86-be91-ac86c2756648
• ServiceName: string
  Service Name

  Example: metric met
• StatusID: integer
  The SLM metric status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1
• ThresholdID: integer
  Threshold ID (threshold that will be set against the metric)

  Example: 0
• TimeFilterAllHour: integer
  Time Filter every hour (required if $TimeToggle not empty)

  Example: 0
• TimeFilterStartDayID: integer
  Time Filter Start Day ID (required if $TimeToggle not empty) Allowed Values: - -1 => Everyday - 0 => Sunday - 1 => Monday - 2 => Tuesday - 3 => Wednesday - 4 => Thursday - 5 => Friday - 6 => Saturday
• TimeFilterStartHourID: integer
  Time Filter Start Hour (required if $TimeToggle not empty)
• TimeFilterStatusID: integer
  The time filter status ID. This parameter is required if the TimeToggle parameter is specified.
  Allowed values are:

  • -1: Inverted, indicates that the time filter is exception based.
  • 0: Disabled
  • 1: Enabled

  Example: 0
• TimeFilterStopDayID: integer
  Time Filter Stop Day ID (required if $TimeToggle not empty) Allowed Values: - 0 => Sunday - 1 => Monday - 2 => Tuesday - 3 => Wednesday - 4 => Thursday - 5 => Friday - 6 => Saturday
• TimeFilterStopHourID: integer
  Time Filter Start Hour (required if $TimeToggle not empty)
• TimeToggle: integer
  Time Toggle

  Example: 0
• Viewers: object Viewers
  User groups that have access to view the metric
• Weight: integer
  SLM Weight (how much weight to give the metric)

  Example: 1
• WindowStatusID: integer
  The window status ID. Either 0 (disabled) or 1 (enabled).

  Example: 0

{
    "type":"object",
    "properties":{
        "ServiceName":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/ServiceName"
        },
        "ParentServiceID":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/ParentServiceID"
        },
        "OwnerUserID":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/OwnerUserID"
        },
        "OwnerUserGroupID":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/OwnerUserGroupID"
        },
        "Viewers":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/Viewers"
        },
        "CompareType":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/CompareType"
        },
        "ThresholdID":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/ThresholdID"
        },
        "CompareOperator":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/CompareOperator"
        },
        "CompareValue":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/CompareValue"
        },
        "MetricID":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/MetricID"
        },
        "TimeToggle":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/TimeToggle"
        },
        "TimeFilterStatusID":{
            "description":"The time filter status ID. This parameter is required if the <b>TimeToggle</b> parameter is specified.<br>Allowed values are:\n<ul><li><b>-1</b>: Inverted, indicates that the time filter is exception based.</li>\n<li><b>0</b>: Disabled</li>\n<li><b>1</b>: Enabled</li></ul>",
            "type":"integer",
            "example":0
        },
        "TimeFilterAllHour":{
            "description":"Time Filter every hour (required if $TimeToggle not empty)",
            "type":"integer",
            "example":0
        },
        "TimeFilterStartDayID":{
            "description":"Time Filter Start Day ID (required if $TimeToggle not empty)\n\nAllowed Values:\n- -1 => Everyday\n- 0 => Sunday\n- 1 => Monday\n- 2 => Tuesday\n- 3 => Wednesday\n- 4 => Thursday\n- 5 => Friday\n- 6 => Saturday",
            "type":"integer"
        },
        "TimeFilterStopDayID":{
            "description":"Time Filter Stop Day ID (required if $TimeToggle not empty)\n\nAllowed Values:\n- 0 => Sunday\n- 1 => Monday\n- 2 => Tuesday\n- 3 => Wednesday\n- 4 => Thursday\n- 5 => Friday\n- 6 => Saturday",
            "type":"integer"
        },
        "TimeFilterStartHourID":{
            "description":"Time Filter Start Hour (required if $TimeToggle not empty)",
            "type":"integer"
        },
        "TimeFilterStopHourID":{
            "description":"Time Filter Start Hour (required if $TimeToggle not empty)",
            "type":"integer"
        },
        "WindowStatusID":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/WindowStatusID"
        },
        "Weight":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/Weight"
        },
        "StatusID":{
            "$ref":"#/components/schemas/SLMServiceMetricsRead/properties/StatusID"
        }
    }
}

Nested Schema : Viewers

Type: object

User groups that have access to view the metric

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
  The response body for a successful update operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The properties of the updated SLM metric.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SLMServiceMetricsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

The response body for a successful update operation.

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful update 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":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the updated SLM metric.
• 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":{
            "description":"The properties of the updated SLM metric.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SLMServiceMetricsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The properties of the updated SLM metric.

Show Source

• Array of: object SLMServiceMetricsRead

{
    "description":"The properties of the updated SLM metric.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SLMServiceMetricsRead"
    }
}

Nested Schema : SLMServiceMetricsRead

Type: object

Show Source

• _id: string
  Service Metric ID

  Example: 41d09c41-61f0-4827-801e-a54785ed4498
• _parent_id: string
  Parent ServiceID

  Example: 0253c68c-6e9c-4d86-be91-ac86c2756648
• _type: string
  Service Type

  Example: ServiceMetric
• CompareOperator: string
  Comparison Operator Allowed Values: - '==' => Equals - '>' => Greater Than - '>=' => Greater Than or Equal - '<' => Less Than - '<=' => Less Than or Equal - '!=' => Not Equals

  Example: <=
• CompareType: string
  Compare Threshold Type Allowed Values: - 'availability' => Availability - 'value' => Value - 'utilization' => Utilization (%)

  Example: utilization
• CompareValue: number
  Compare Threshold Value

  Example: 90
• DeviceID: integer
  Device ID where the metric is associated

  Example: 60
• DeviceName: string
  Device name where the metric is associated

  Example: something.example-device.com
• DeviceZoneID: integer
  Zone ID of the device

  Example: 1
• DeviceZoneName: string
  Zone name of the device

  Example: Default First Zone
• icon: string
  Service Icon

  Example: /resources/assure1/images/icons/silk/chart_curve.png
• InstanceName: string
  Name of all metric instances available for the selected metric type

  Example: Device
• leaf: boolean
  Leaf node or not

  Example: true
• MetricID: integer
  Metric ID

  Example: 551
• MetricTypeID: integer
  Metric Type ID used to lookup metrics associated to Device

  Example: 30
• MetricTypeName: string
  Metric Type Name

  Example: CPU Utilization
• Name: string
  Name of the SLM Metric

  Example: metric met
• OwnerUserGroupID: integer
  Group that owns the metric

  Example: 0
• OwnerUserID: integer
  The ID of the user who owns the metric. This can never be an externally-authenticated transient user. 0 means it is public to all users in the owning group.

  Example: 0
• ParentServiceID: string
  ServiceID of Parent

  Example: 0253c68c-6e9c-4d86-be91-ac86c2756648
• qtip: string
  Service Name

  Example: metric met
• ServiceID: string
  Service Metric ID specified for individual CRUD operations

  Example: 41d09c41-61f0-4827-801e-a54785ed4498
• ServiceName: string
  Service Name

  Example: metric met
• ServiceType: string
  Type of Service

  Example: Metric
• Status: string
  Status of the service metric i.e. Enabled or Disabled

  Example: Enabled
• StatusIcon: string
  Status Icon

  Example: OrbGreen.png
• StatusID: integer
  The SLM metric status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1
• ThresholdID: integer
  Threshold ID (threshold that will be set against the metric)

  Example: 0
• TimeFilterAllHour: integer
  Time Filter every hour

  Example: 0
• TimeFilterStatusID: integer
  The time filter status ID. Either 0 (disabled) or 1 (enabled).

  Example: 0
• TimestampModified: integer
  Timestamp when service is modified

  Example: 1698397724000
• TimeToggle: integer
  Time Toggle

  Example: 0
• VertexTypes: integer
  Vertex Type

  Example: 102
• Viewers: object Viewers
  User groups that have access to view the metric
• Weight: integer
  SLM Weight (how much weight to give the metric)

  Example: 1
• WindowStatusID: integer
  The window status ID. Either 0 (disabled) or 1 (enabled).

  Example: 0

{
    "type":"object",
    "properties":{
        "ParentServiceID":{
            "description":"ServiceID of Parent",
            "type":"string",
            "example":"0253c68c-6e9c-4d86-be91-ac86c2756648"
        },
        "TimeFilterStatusID":{
            "description":"The time filter status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":0
        },
        "ThresholdID":{
            "description":"Threshold ID (threshold that will be set against the metric)",
            "type":"integer",
            "example":0
        },
        "_type":{
            "description":"Service Type",
            "type":"string",
            "example":"ServiceMetric"
        },
        "TimeFilterAllHour":{
            "description":"Time Filter every hour",
            "type":"integer",
            "example":0
        },
        "Weight":{
            "description":"SLM Weight (how much weight to give the metric)",
            "type":"integer",
            "example":1
        },
        "Name":{
            "description":"Name of the SLM Metric",
            "type":"string",
            "example":"metric met"
        },
        "CompareType":{
            "description":"Compare Threshold Type\n\nAllowed Values:\n- 'availability' => Availability\n- 'value'        => Value\n- 'utilization'  => Utilization (%)",
            "type":"string",
            "example":"utilization"
        },
        "CompareOperator":{
            "description":"Comparison Operator\n\nAllowed Values:\n-  '==' => Equals\n-  '>'  => Greater Than\n-  '>=' => Greater Than or Equal\n-  '<'  => Less Than\n-  '<=' => Less Than or Equal\n-  '!=' => Not Equals",
            "type":"string",
            "example":"<="
        },
        "CompareValue":{
            "description":"Compare Threshold Value",
            "type":"number",
            "example":90
        },
        "MetricID":{
            "description":"Metric ID",
            "type":"integer",
            "example":551
        },
        "OwnerUserID":{
            "description":"The ID of the user who owns the metric. This can never be an externally-authenticated transient user. <b>0</b> means it is public to all users in the owning group.",
            "type":"integer",
            "example":"0"
        },
        "_parent_id":{
            "description":"Parent ServiceID",
            "type":"string",
            "example":"0253c68c-6e9c-4d86-be91-ac86c2756648"
        },
        "VertexTypes":{
            "description":"Vertex Type",
            "type":"integer",
            "example":102
        },
        "OwnerUserGroupID":{
            "description":"Group that owns the metric",
            "type":"integer",
            "example":"0"
        },
        "StatusID":{
            "description":"The SLM metric status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":1
        },
        "StatusIcon":{
            "description":"Status Icon",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "Status":{
            "description":"Status of the service metric i.e. Enabled or Disabled",
            "type":"string",
            "example":"Enabled"
        },
        "_id":{
            "description":"Service Metric ID",
            "type":"string",
            "example":"41d09c41-61f0-4827-801e-a54785ed4498"
        },
        "WindowStatusID":{
            "description":"The window status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":0
        },
        "TimestampModified":{
            "description":"Timestamp when service is modified",
            "type":"integer",
            "example":"1698397724000"
        },
        "ServiceID":{
            "description":"Service Metric ID specified for individual CRUD operations",
            "type":"string",
            "example":"41d09c41-61f0-4827-801e-a54785ed4498"
        },
        "ServiceName":{
            "description":"Service Name",
            "type":"string",
            "example":"metric met"
        },
        "ServiceType":{
            "description":"Type of Service",
            "type":"string",
            "example":"Metric"
        },
        "qtip":{
            "description":"Service Name",
            "type":"string",
            "example":"metric met"
        },
        "icon":{
            "description":"Service Icon",
            "type":"string",
            "example":"/resources/assure1/images/icons/silk/chart_curve.png"
        },
        "leaf":{
            "description":"Leaf node or not",
            "type":"boolean",
            "example":true
        },
        "DeviceID":{
            "description":"Device ID where the metric is associated",
            "type":"integer",
            "example":"60"
        },
        "DeviceName":{
            "description":"Device name where the metric is associated",
            "type":"string",
            "example":"something.example-device.com"
        },
        "DeviceZoneID":{
            "description":"Zone ID of the device",
            "type":"integer",
            "example":"1"
        },
        "DeviceZoneName":{
            "description":"Zone name of the device",
            "type":"string",
            "example":"Default First Zone"
        },
        "MetricTypeID":{
            "description":"Metric Type ID used to lookup metrics associated to Device",
            "type":"integer",
            "example":"30"
        },
        "MetricTypeName":{
            "description":"Metric Type Name",
            "type":"string",
            "example":"CPU Utilization"
        },
        "InstanceName":{
            "description":"Name of all metric instances available for the selected metric type",
            "type":"string",
            "example":"Device"
        },
        "TimeToggle":{
            "description":"Time Toggle",
            "type":"integer",
            "example":0
        },
        "Viewers":{
            "description":"User groups that have access to view the metric",
            "type":"object",
            "example":[
            ]
        }
    }
}

Nested Schema : Viewers

Type: object

User groups that have access to view the metric

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