Create an SLM Service
post
/api/SLM/Services
Creates a new SLM service.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CloneServiceID: integer
ServiceID of top level node to be (deep) cloned
-
CriticalThresholdID: integer
Threshold settings used to check if the service is in violation
-
EventCriticalThresholdOperator: string
Threshold Operator (Events only) Allowed Values: - '==' => Equals - '>' => Greater Than - '>=' => Greater Than or Equal - '<' => Less Than - '<=' => Less Than or Equal - '!=' => Not Equals='>'>Example:
<=
-
EventCriticalThresholdValue: integer
Threshold Value (Events Only)Example:
90
-
EventMetaEventID: integer
Meta Event ID to send when threshold triggers (Events Only)Example:
1
-
MetricCriticalThresholdOperator: string
Critical Threshold Operator (Metrics Only) Allowed Values: - '==' => Equals - '>' => Greater Than - '>=' => Greater Than or Equal - '<' => Less Than - '<=' => Less Than or Equal - '!=' => Not Equals='>'>Example:
-
MetricCriticalThresholdValue: integer
Critical Threshold Value (Metrics Only)Example:
75
-
MetricGaugeViewID: integer
Gauge View Type ID (Metrics Only) Allowed Values: - 1 => Linear - 2 => LogarithmicExample:
1
-
MetricPollTime: integer
PollTime for a metricExample:
300
-
MetricsToggle: boolean
Metrics Toggle indicating if a service has Metric properties defined
-
MetricWarningThresholdOperator: string
Warning Threshold Operator (Metrics Only) Allowed Values: - '==' => Equals - '>' => Greater Than - '>=' => Greater Than or Equal - '<' => Less Than - '<=' => Less Than or Equal - '!=' => Not Equals='>'>Example:
-
MetricWarningThresholdValue: integer
Warning Threshold Value (Metrics Only) is the value used to check for metric violationExample:
15
-
OwnerUserGroupID: integer
Group that owns the serviceExample:
0
-
OwnerUserID: integer
User that owns the serviceExample:
0
-
ParentServiceID: string
ServiceID of ParentExample:
root
-
ServiceName: string
Service NameExample:
test
-
StatusID: integer
ID of Service Status Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
Viewers: array
Viewers
List of user groups that can view
-
WarningThresholdID: integer
Threshold settings used to check if the service is in violation
-
Weight: integer
SLM WeightExample:
1
Nested Schema : items
Type:
object
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 service.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : SLMServicesReadByID
Type:
Show Source
object
-
_id: string
Service IDExample:
0253c68c-6e9c-4d86-be91-ac86c2756648
-
_parent_id: string
ServiceID of ParentExample:
root
-
_type: string
Service type. Allowed Values: - Service - ServiceMetric - ServiceEventExample:
Service
-
DeviceID: integer
Device IDExample:
1
-
EventCriticalThresholdOperator: string
Threshold Operator (Events only) Allowed Values: - '==' => Equals - '>' => Greater Than - '>=' => Greater Than or Equal - '<' => Less Than - '<=' => Less Than or Equal - '!=' => Not Equals='>'>Example:
<=
-
EventCriticalThresholdValue: integer
Threshold Value (Events Only)Example:
90
-
EventMetaEventID: integer
Meta Event ID to send when threshold triggers (Events Only)Example:
1
-
FullFormRec: boolean
Full Form RecExample:
true
-
HasEventProps: integer
Has event propsExample:
1
-
HasMetricProps: integer
Has metric propsExample:
1
-
iconClass: string
CSS class describing the serviceExample:
fa fa-tachometer x-tree-icon-glyph
-
InstanceID: integer
Used internally on update to determine if a metric needs to be re-created or looked up for a serviceExample:
1
-
Measurement: string
MeasurementExample:
metrictype_Service_Availability
-
MetricCriticalThresholdOperator: string
Critical Threshold Operator (Metrics Only) Allowed Values: - '==' => Equals - '>' => Greater Than - '>=' => Greater Than or Equal - '<' => Less Than - '<=' => Less Than or Equal - '!=' => Not Equals='>'>Example:
-
MetricCriticalThresholdValue: integer
Critical Threshold Value (Metrics Only)Example:
75
-
MetricGaugeViewID: integer
Gauge View Type ID (Metrics Only) Allowed Values: - 1 => Linear - 2 => LogarithmicExample:
1
-
MetricID: integer
Metric IDExample:
1361
-
MetricPollTime: integer
PollTime for a metricExample:
300
-
MetricThresholdID: integer
Critical Threshold ID for MetricExample:
0
-
MetricWarningThresholdOperator: string
Warning Threshold Operator (Metrics Only) Allowed Values: - '==' => Equals - '>' => Greater Than - '>=' => Greater Than or Equal - '<' => Less Than - '<=' => Less Than or Equal - '!=' => Not Equals='>'>Example:
-
MetricWarningThresholdValue: integer
Warning Threshold Value (Metrics Only) is the value used to check for metric violationExample:
15
-
Name: string
Name of the SLM ServiceExample:
test
-
OwnerUserGroupID: integer
Group that owns the serviceExample:
0
-
OwnerUserID: integer
User that owns the serviceExample:
0
-
ParentServiceID: string
ServiceID of ParentExample:
root
-
path: string
Tree path from the root down to this service.Example:
/Root/test
-
ServiceID: string
Service ID specified for individual CRUD operationsExample:
0253c68c-6e9c-4d86-be91-ac86c2756648
-
ServiceName: string
Service NameExample:
test
-
ServiceType: string
Service TypeExample:
Service
-
Status: string
Status of the Service (Enabled or Disabled)Example:
Enabled
-
StatusIcon: string
Status IconExample:
OrbGreen.png
-
StatusID: integer
ID of Service Status Allowed Values: - 0 => Disabled - 1 => EnabledExample:
1
-
TimestampModified: integer
Timestamp ModifiedExample:
1.698395096E12
-
treedata: array
treedata
Tree path from the root down to this service broken out into array elements.
-
Weight: integer
SLM WeightExample:
1
Nested Schema : treedata
Type:
array
Tree path from the root down to this service broken out into array elements.
Show Source
Example:
[
"0253c68c-6e9c-4d86-be91-ac86c2756648"
]
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