Jump to

• Request
• Response

Get an SLM Service by ID

get

/api/SLM/Services/{id}

Gets the SLM service that matches the specified ID.

Request

Path Parameters

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

  Example:

  2dc9dcc2-635b-4b63-9a0e-35dcb05458c0

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

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 properties of the specified SLM service.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SLMServicesReadByID"
                    }
                }
            }
        }
    ]
}

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 properties of the specified SLM service.
• 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 specified SLM service.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SLMServicesReadByID"
            }
        }
    }
}

Nested Schema : data

Type: array

The properties of the specified SLM service.

Show Source

• Array of: object SLMServicesReadByID

{
    "description":"The properties of the specified SLM service.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SLMServicesReadByID"
    }
}

Nested Schema : SLMServicesReadByID

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
• DeviceID: integer
  Device ID

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

  Example: true
• HasEventProps: integer
  Has event props

  Example: 1
• HasMetricProps: integer
  Has metric props

  Example: 1
• 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
• Measurement: string
  Measurement

  Example: 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 => 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
• path: string
  Tree path from the root down to this service.

  Example: /Root/test
• 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
• treedata: array treedata
  Tree path from the root down to this service broken out into array elements.
• Weight: integer
  SLM Weight

  Example: 1

{
    "type":"object",
    "properties":{
        "FullFormRec":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/FullFormRec"
        },
        "ServiceID":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/ServiceID"
        },
        "ServiceName":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/ServiceName"
        },
        "ServiceType":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/ServiceType"
        },
        "ParentServiceID":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/ParentServiceID"
        },
        "OwnerUserID":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/OwnerUserID"
        },
        "OwnerUserGroupID":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/OwnerUserGroupID"
        },
        "MetricThresholdID":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/MetricThresholdID"
        },
        "iconClass":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/iconClass"
        },
        "path":{
            "description":"Tree path from the root down to this service.",
            "type":"string",
            "example":"/Root/test"
        },
        "treedata":{
            "description":"Tree path from the root down to this service broken out into array elements.",
            "type":"array",
            "items":{
                "type":"string"
            },
            "example":"0253c68c-6e9c-4d86-be91-ac86c2756648"
        },
        "_type":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/_type"
        },
        "EventCriticalThresholdOperator":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/EventCriticalThresholdOperator"
        },
        "EventCriticalThresholdValue":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/EventCriticalThresholdValue"
        },
        "InstanceID":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/InstanceID"
        },
        "MetricCriticalThresholdOperator":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/MetricCriticalThresholdOperator"
        },
        "MetricCriticalThresholdValue":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/MetricCriticalThresholdValue"
        },
        "MetricWarningThresholdOperator":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/MetricWarningThresholdOperator"
        },
        "MetricWarningThresholdValue":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/MetricWarningThresholdValue"
        },
        "Weight":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/Weight"
        },
        "Name":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/Name"
        },
        "MetricID":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/MetricID"
        },
        "EventMetaEventID":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/EventMetaEventID"
        },
        "_parent_id":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/_parent_id"
        },
        "MetricPollTime":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/MetricPollTime"
        },
        "MetricGaugeViewID":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/MetricGaugeViewID"
        },
        "_id":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/_id"
        },
        "TimestampModified":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/TimestampModified"
        },
        "StatusID":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/StatusID"
        },
        "Status":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/Status"
        },
        "StatusIcon":{
            "$ref":"#/components/schemas/SLMServicesRead/properties/StatusIcon"
        },
        "DeviceID":{
            "description":"Device ID",
            "type":"integer",
            "example":"1"
        },
        "Measurement":{
            "description":"Measurement",
            "type":"string",
            "example":"metrictype_Service_Availability"
        },
        "HasEventProps":{
            "description":"Has event props",
            "type":"integer",
            "example":1
        },
        "HasMetricProps":{
            "description":"Has metric props",
            "type":"integer",
            "example":1
        }
    }
}

Nested Schema : treedata

Type: array

Tree path from the root down to this service broken out into array elements.

Show Source

• Array of: string

{
    "description":"Tree path from the root down to this service broken out into array elements.",
    "type":"array",
    "items":{
        "type":"string"
    },
    "example":"0253c68c-6e9c-4d86-be91-ac86c2756648"
}

Example:

0253c68c-6e9c-4d86-be91-ac86c2756648

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