REST API for Unified Assurance Core

Get SLM Services

get

/api/SLM/Services

Gets the list of SLM services that match the specified parameters. If no parameters are specified, all SLM services are returned.

Request

Query Parameters

RootID: integer

The ID of the root node to start the service tree.
node(required): string
The node of the tree to get.
Example:
```
root
```

sort: object

The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }

direction(required): string

Allowed Values: [ "ASC", "DESC" ]

The direction of the sort.

Example: ASC
property(required): string

The field to sort on.

Example: name

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

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":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of SLM services that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SLMServicesRead"
                    }
                }
            }
        }
    ]
}

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

The list of SLM services that match the specified parameters.
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 list of SLM services that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SLMServicesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of SLM services that match the specified parameters.

Show Source

Array of: object SLMServicesRead

{
    "description":"The list of SLM services that match the specified parameters.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SLMServicesRead"
    }
}

Nested Schema : SLMServicesRead

Type: object

Show Source

_id: string

Service ID

Example: 0253c68c-6e9c-4d86-be91-ac86c2756648
_parent_id: string

ServiceID of Parent

Example: root
_type: string

Service type. Allowed Values: - Service - ServiceMetric - ServiceEvent

Example: Service
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 Rec

Example: true
iconClass: string

CSS class describing the service

Example: 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 service

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 => Logarithmic

Example: 1
MetricID: integer

Metric ID

Example: 1361
MetricPollTime: integer

PollTime for a metric

Example: 300
MetricThresholdID: integer

Critical Threshold ID for Metric

Example: 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 violation

Example: 15
Name: string

Name of the SLM Service

Example: test
OwnerUserGroupID: integer

Group that owns the service

Example: 0
OwnerUserID: integer

The ID of the user that owns the service. 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: root
ServiceID: string

Service ID specified for individual CRUD operations

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

Service Name

Example: Service1
ServiceType: string

Service Type

Example: Service
Status: string

Status of the Service (Enabled or Disabled)

Example: Enabled
StatusIcon: string

Status Icon

Example: OrbGreen.png
StatusID: integer

The service status ID. Either 0 (disabled) or 1 (enabled).

Example: 1
TimestampModified: integer

Timestamp Modified

Example: 1698395096000
Weight: integer

SLM Weight

Example: 1

{
    "type":"object",
    "properties":{
        "FullFormRec":{
            "description":"Full Form Rec",
            "type":"boolean",
            "example":true
        },
        "ServiceID":{
            "description":"Service ID specified for individual CRUD operations",
            "type":"string",
            "example":"0253c68c-6e9c-4d86-be91-ac86c2756648"
        },
        "ServiceName":{
            "description":"Service Name",
            "type":"string",
            "example":"Service1"
        },
        "ParentServiceID":{
            "description":"ServiceID of Parent",
            "type":"string",
            "example":"root"
        },
        "EventCriticalThresholdValue":{
            "description":"Threshold Value (Events Only)",
            "type":"integer",
            "example":90
        },
        "InstanceID":{
            "description":"Used internally on update to determine if a metric needs to be re-created or looked up for a service",
            "type":"integer",
            "example":1
        },
        "MetricWarningThresholdValue":{
            "description":"Warning Threshold Value (Metrics Only) is the value used to check for metric violation",
            "type":"integer",
            "example":15
        },
        "_type":{
            "description":"Service type. \n\nAllowed Values: \n- Service\n- ServiceMetric\n- ServiceEvent",
            "type":"string",
            "example":"Service"
        },
        "MetricCriticalThresholdOperator":{
            "description":"Critical Threshold Operator (Metrics Only)\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":""
        },
        "EventCriticalThresholdOperator":{
            "description":"Threshold Operator (Events only)\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":"<="
        },
        "Weight":{
            "description":"SLM Weight",
            "type":"integer",
            "example":1
        },
        "Name":{
            "description":"Name of the SLM Service",
            "type":"string",
            "example":"test"
        },
        "MetricID":{
            "description":"Metric ID",
            "type":"integer",
            "example":1361
        },
        "EventMetaEventID":{
            "description":"Meta Event ID to send when threshold triggers (Events Only)",
            "type":"integer",
            "example":1
        },
        "OwnerUserID":{
            "description":"The ID of the user that owns the service. 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":"ServiceID of Parent",
            "type":"string",
            "example":"root"
        },
        "MetricPollTime":{
            "description":"PollTime for a metric",
            "type":"integer",
            "example":300
        },
        "OwnerUserGroupID":{
            "description":"Group that owns the service",
            "type":"integer",
            "example":0
        },
        "StatusID":{
            "description":"The service status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":1
        },
        "MetricGaugeViewID":{
            "description":"Gauge View Type ID (Metrics Only)\n\nAllowed Values:\n- 1 => Linear\n- 2 => Logarithmic",
            "type":"integer",
            "example":1
        },
        "MetricWarningThresholdOperator":{
            "description":"Warning Threshold Operator (Metrics Only)\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":""
        },
        "_id":{
            "description":"Service ID",
            "type":"string",
            "example":"0253c68c-6e9c-4d86-be91-ac86c2756648"
        },
        "MetricCriticalThresholdValue":{
            "description":"Critical Threshold Value (Metrics Only)",
            "type":"integer",
            "example":75
        },
        "MetricThresholdID":{
            "description":"Critical Threshold ID for Metric",
            "type":"integer",
            "example":0
        },
        "TimestampModified":{
            "description":"Timestamp Modified",
            "type":"integer",
            "example":"1698395096000"
        },
        "iconClass":{
            "description":"CSS class describing the service",
            "type":"string",
            "example":"fa fa-tachometer x-tree-icon-glyph"
        },
        "ServiceType":{
            "description":"Service Type",
            "type":"string",
            "example":"Service"
        },
        "StatusIcon":{
            "description":"Status Icon",
            "type":"string",
            "example":"OrbGreen.png"
        },
        "Status":{
            "description":"Status of the Service (Enabled or Disabled)",
            "type":"string",
            "example":"Enabled"
        }
    }
}

Default Response

Failed operation

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.