Jump to

• Request
• Response

Get SLM Service Details for Tree Grids

get

/api/SLMNavigation/NavServices/readForTree

Gets the details for 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

• node: string
  The node for the tree selection. Specify root to get all SLM services from the root node or specify ServiceID to get all the child nodes under the service.

  Example:

  root

• query: string
  The service name to get the details for. This simple query matches similar ServiceName values.

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
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The details of SLM services that match the specified parameters.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SLMNavigationReadForTree"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "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 details of SLM services that match the specified parameters.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The details of SLM services that match the specified parameters.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SLMNavigationReadForTree"
            }
        }
    }
}

Nested Schema : data

Type: array

The details of SLM services that match the specified parameters.

Show Source

• Array of: object SLMNavigationReadForTree

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

Nested Schema : SLMNavigationReadForTree

Type: object

Show Source

• iconCls: string
  Icon CSS class for the initial status.

  Example: barspinner
• leaf: boolean
  Indicates if it's a leaf node.

  Example: false
• ServiceID: string
  The unique identifier for the service.

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

  Example: Test Service
• ServiceType: string
  The type of Service node. Possible values: - ServiceFilter - ServiceMetric - Service

  Example: Service
• text: string
  The text associated with the node.

  Example: Test Service
• view: string
  URL for viewing the service node details.

  Example: #dashboard/Services%20Dashboard?ServiceName=%2F%2FRoot%2F%2FTest%20Service&ResolveParam=ServiceWhereClause

{
    "type":"object",
    "properties":{
        "leaf":{
            "description":"Indicates if it's a leaf node.",
            "type":"boolean",
            "example":false
        },
        "iconCls":{
            "description":"Icon CSS class for the initial status.",
            "type":"string",
            "example":"barspinner"
        },
        "view":{
            "description":"URL for viewing the service node details.",
            "type":"string",
            "example":"#dashboard/Services%20Dashboard?ServiceName=%2F%2FRoot%2F%2FTest%20Service&ResolveParam=ServiceWhereClause"
        },
        "ServiceID":{
            "description":"The unique identifier for the service.",
            "type":"string",
            "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0"
        },
        "ServiceName":{
            "description":"The name of the service.",
            "type":"string",
            "example":"Test Service"
        },
        "text":{
            "description":"The text associated with the node.",
            "type":"string",
            "example":"Test Service"
        },
        "ServiceType":{
            "description":"The type of Service node. \n\nPossible values: \n- ServiceFilter\n- ServiceMetric\n- Service",
            "type":"string",
            "example":"Service"
        }
    }
}

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":{
                "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

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top