Jump to

• Request
• Response

Get SLM Services for Tree Grids

get

/api/SLM/ServiceViews/readForTree

Gets the SLM services that match the specified parameters in a format suitable for tree grids. If no parameters are specified, all SLM services are returned.

Request

Query Parameters

• RootID: string
  The service ID specified for individual CRUD operations.
• TimeRange: string
  The time range to get the data.
• id: string
  The SLM service path ID.

  Example:

  //Root//Test

• node: string
  The node of the SLM service tree.

  Example:

  root

• readChildren: boolean
  Whether to get the children of the specified service (true) or not (false).

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 list of SLM services.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SLMServiceViewsReadForTree"
                    }
                }
            }
        }
    ]
}

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.
• 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.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SLMServiceViewsReadForTree"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of SLM services.

Show Source

• Array of: object SLMServiceViewsReadForTree

{
    "description":"The list of SLM services.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SLMServiceViewsReadForTree"
    }
}

Nested Schema : SLMServiceViewsReadForTree

Type: object

Show Source

• DeviceID: integer
  Device ID

  Example: 1
• EventCount: integer
  The count of events.

  Example: 0
• EventFilter: string
  The filter condition for events.

  Example: EventKey='Service_test' AND EventType != 1
• EventSumCount: integer
  The sum count of events.

  Example: 0
• iconCls: string
  CSS class for icons.

  Example: fa fa-tachometer x-tree-icon-glyph gray
• leaf: boolean
  Indicates if it's a leaf node.

  Example: false
• MaxSeverity: integer
  The maximum severity level.

  Example: 0
• MetricID: integer
  The identifier for a specific metric.

  Example: 1
• qtip: string
  Tooltip information.

  Example: <b>Service</b>:<br>
• ServiceID: string
  Service ID

  Example: 2de8190b-4bd8-4a2a-91ec-03e9fdae83e0
• ServiceName: string
  The name of the service.

  Example: test
• ServiceStateColor: string
  The color associated with the service's state.

  Example: gray
• ServiceTEL: string
  The service's TEL (Telecommunications Equipment List) information.

  Example:
• ServiceType: string
  The type of the service.

  Example: Service
• StateIcons: object StateIcons
  Icons for different states.
• StateTooltips: object StateTooltips
  Tooltips for different states.
• StateValues: object StateValues
  Values for different states.

{
    "type":"object",
    "properties":{
        "DeviceID":{
            "description":"Device ID",
            "type":"integer",
            "example":"1"
        },
        "MetricID":{
            "description":"The identifier for a specific metric.",
            "type":"integer",
            "example":1
        },
        "EventCount":{
            "description":"The count of events.",
            "type":"integer",
            "example":0
        },
        "EventFilter":{
            "description":"The filter condition for events.",
            "type":"string",
            "example":"EventKey='Service_test' AND EventType != 1"
        },
        "EventSumCount":{
            "description":"The sum count of events.",
            "type":"integer",
            "example":0
        },
        "MaxSeverity":{
            "description":"The maximum severity level.",
            "type":"integer",
            "example":0
        },
        "ServiceID":{
            "description":"Service ID",
            "type":"string",
            "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0"
        },
        "ServiceName":{
            "description":"The name of the service.",
            "type":"string",
            "example":"test"
        },
        "ServiceType":{
            "description":"The type of the service.",
            "type":"string",
            "example":"Service"
        },
        "StateIcons":{
            "description":"Icons for different states.",
            "type":"object",
            "example":{
                "event":"gray"
            }
        },
        "StateTooltips":{
            "description":"Tooltips for different states.",
            "type":"object",
            "example":{
                "event":"Unknown"
            }
        },
        "StateValues":{
            "description":"Values for different states.",
            "type":"object",
            "example":{
                "event":0
            }
        },
        "ServiceTEL":{
            "description":"The service's TEL (Telecommunications Equipment List) information.",
            "type":"string",
            "example":""
        },
        "ServiceStateColor":{
            "description":"The color associated with the service's state.",
            "type":"string",
            "example":"gray"
        },
        "qtip":{
            "description":"Tooltip information.",
            "type":"string",
            "example":"<b>Service</b>:<br>"
        },
        "iconCls":{
            "description":"CSS class for icons.",
            "type":"string",
            "example":"fa fa-tachometer x-tree-icon-glyph gray"
        },
        "leaf":{
            "description":"Indicates if it's a leaf node.",
            "type":"boolean",
            "example":false
        }
    }
}

Nested Schema : StateIcons

Type: object

Icons for different states.

Example:

{
    "event":"gray"
}

Nested Schema : StateTooltips

Type: object

Tooltips for different states.

Example:

{
    "event":"Unknown"
}

Nested Schema : StateValues

Type: object

Values for different states.

Example:

{
    "event":0
}

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