Create an SLM Metric
post
/api/SLM/ServiceMetrics
Creates a new SLM metric.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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 ValueExample:
90
-
MetricID: integer
Metric IDExample:
551
-
OwnerUserGroupID: integer
Group that owns the metricExample:
0
-
OwnerUserID: integer
UserID of user that owns the metricExample:
0
-
ParentServiceID: string
ServiceID of ParentExample:
0253c68c-6e9c-4d86-be91-ac86c2756648
-
ServiceName: string
Service NameExample:
metric met
-
StatusID: integer
Status ID used to determine if the SLM metric is enabled or disabled Allowed Values: - 0 => Disabled - 1 => EnabledExample:
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
Time Filter Status ID (required if $TimeToggle not empty) Allowed Values: - -1 => Inverted (time filter is exception based) - 0 => Disabled - 1 => EnabledExample:
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 ToggleExample:
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
Window Status ID Allowed Values: - 0 => Disabled - 1 => EnabledExample:
0
Nested Schema : Viewers
Type:
object
User groups that have access to view the metric
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The properties of the new SLM metric.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : SLMServiceMetricsRead
Type:
Show Source
object
-
_id: string
Service Metric IDExample:
41d09c41-61f0-4827-801e-a54785ed4498
-
_parent_id: string
Parent ServiceIDExample:
0253c68c-6e9c-4d86-be91-ac86c2756648
-
_type: string
Service TypeExample:
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 ValueExample:
90
-
DeviceID: integer
Device ID where the metric is associatedExample:
60
-
DeviceName: string
Device name where the metric is associatedExample:
something.example-device.com
-
DeviceZoneID: integer
Zone ID of the deviceExample:
1
-
DeviceZoneName: string
Zone name of the deviceExample:
Default First Zone
-
icon: string
Service IconExample:
/resources/assure1/images/icons/silk/chart_curve.png
-
InstanceName: string
Name of all metric instances available for the selected metric typeExample:
Device
-
leaf: boolean
Leaf node or notExample:
true
-
MetricID: integer
Metric IDExample:
551
-
MetricTypeID: integer
Metric Type ID used to lookup metrics associated to DeviceExample:
30
-
MetricTypeName: string
Metric Type NameExample:
CPU Utilization
-
Name: string
Name of the SLM MetricExample:
metric met
-
OwnerUserGroupID: integer
Group that owns the metricExample:
0
-
OwnerUserID: integer
UserID of user that owns the metricExample:
0
-
ParentServiceID: string
ServiceID of ParentExample:
0253c68c-6e9c-4d86-be91-ac86c2756648
-
qtip: string
Service NameExample:
metric met
-
ServiceID: string
Service Metric ID specified for individual CRUD operationsExample:
41d09c41-61f0-4827-801e-a54785ed4498
-
ServiceName: string
Service NameExample:
metric met
-
ServiceType: string
Type of ServiceExample:
Metric
-
Status: string
Status of the service metric i.e. Enabled or DisabledExample:
Enabled
-
StatusIcon: string
Status IconExample:
OrbGreen.png
-
StatusID: integer
Status ID used to determine if the SLM metric is enabled or disabled Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
ThresholdID: integer
Threshold ID (threshold that will be set against the metric)Example:
0
-
TimeFilterAllHour: integer
Time Filter every hourExample:
0
-
TimeFilterStatusID: integer
Time Filter Status ID Allowed Values: - -1 => Inverted (time filter is exception based) - 0 => Disabled - 1 => EnabledExample:
0
-
TimestampModified: integer
Timestamp when service is modifiedExample:
1.698397724E12
-
TimeToggle: integer
Time ToggleExample:
0
-
VertexTypes: integer
Vertex TypeExample:
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
Window Status ID Allowed Values: - 0 => Disabled - 1 => EnabledExample:
0
Nested Schema : Viewers
Type:
object
User groups that have access to view the metric
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object