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 TopResponse
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
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
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The list of SLM services.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : SLMServiceViewsReadForTree
Type:
Show Source
object
-
DeviceID: integer
Device IDExample:
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 IDExample:
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.
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
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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.