REST API for Unified Assurance Core

Get the States of SLM Service Nodes Based On Child Nodes

get

/api/SLMNavigation/NavServices/readStates

Gets the summarized states for SLM service nodes based on the state of their child nodes.

Request

Query Parameters

MetricID(required): array[integer]

A PHP array parameter form. For each SLM service node in the ServiceId list that has the ServiceType of ServiceMetric, specify the MetricID in this form. For nodes of other types, leave the index entry in MetricID empty.
ServiceID(required): string
The comma-separated list of SLM service node IDs to get the state for.
Example:
```
2de8190b-4bd8-4a2a-91ec-03e9fdae83e0
```
ServiceType(required): array[string]

A PHP array parameter form. Specify the corresponding ServiceType for each SLM service node ID in the ServiceID list.
hasKeyFields: integer

A reserved parameter. Its value is always 1.
limit: integer(int32)
The number of records to limit results by. If you do not also set the start parameter, records start at 0.
Example:
```
100
```
start: integer(int32)
The page of results to start from. This parameter is ignored if you do not also set the limit parameter.

Default Value: 0
Example:
```
1
```

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":{
                "data":{
                    "description":"The list of summarized SLM service states.",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "ServiceID":{
                                "description":"The ID of the SLM service.",
                                "type":"string",
                                "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0"
                            },
                            "Severity":{
                                "description":"The severity associated with the SLM service. Possible values are <b>orange</b>, <b>red</b>, <b>green</b>, and <b>gray</b>.",
                                "type":"string",
                                "example":"gray"
                            }
                        }
                    }
                }
            }
        }
    ]
}

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 summarized SLM service states.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The list of summarized SLM service states.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "ServiceID":{
                        "description":"The ID of the SLM service.",
                        "type":"string",
                        "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0"
                    },
                    "Severity":{
                        "description":"The severity associated with the SLM service. Possible values are <b>orange</b>, <b>red</b>, <b>green</b>, and <b>gray</b>.",
                        "type":"string",
                        "example":"gray"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: array

The list of summarized SLM service states.

Show Source

Array of: object items

{
    "description":"The list of summarized SLM service states.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ServiceID":{
                "description":"The ID of the SLM service.",
                "type":"string",
                "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0"
            },
            "Severity":{
                "description":"The severity associated with the SLM service. Possible values are <b>orange</b>, <b>red</b>, <b>green</b>, and <b>gray</b>.",
                "type":"string",
                "example":"gray"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

ServiceID: string

The ID of the SLM service.

Example: 2de8190b-4bd8-4a2a-91ec-03e9fdae83e0
Severity: string

The severity associated with the SLM service. Possible values are orange, red, green, and gray.

Example: gray

{
    "type":"object",
    "properties":{
        "ServiceID":{
            "description":"The ID of the SLM service.",
            "type":"string",
            "example":"2de8190b-4bd8-4a2a-91ec-03e9fdae83e0"
        },
        "Severity":{
            "description":"The severity associated with the SLM service. Possible values are <b>orange</b>, <b>red</b>, <b>green</b>, and <b>gray</b>.",
            "type":"string",
            "example":"gray"
        }
    }
}

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.