REST API for Unified Assurance Core

Get Gateway Objects

get

/api/gateway/Gateways

Gets the attributes of gateway objects that match the specified parameters. If no parameters are specified, all gateway objects along with their attributes are returned.

Request

Query Parameters

filter: object

The fields to filter the results by. You cannot filter by fields that contain a state.
This parameter's value uses the following JSON format:
{ "property": "property", "value": "propertyValue", "operator": "operator", "conjunction": "conjunction" }
If you use multiple JSON objects to combine filters, for example, to filter by several different device names, you cannot combine OR and AND conjunctions. The conjunction used for the last object applies to the entire list.

conjunction: string

Default Value: OR

Allowed Values: [ "AND", "OR" ]

The conjunction between filters.

Example: AND
operator: string

Default Value: LIKE

Allowed Values: [ "eq", "ne", "gte", "gt", "lte", "lt", "LIKE", "NOT LIKE", "re", "not re", "NOT IN" ]

The filter operation to use.

Example: eq
property(required): string

The name of the field to filter on.

Example: name
value(required): string

The value of the field to filter on.

Example: test

{
    "required":[
        "property",
        "value"
    ],
    "properties":{
        "property":{
            "description":"The name of the field to filter on.",
            "type":"string",
            "example":"name"
        },
        "value":{
            "description":"The value of the field to filter on.",
            "type":"string",
            "example":"test"
        },
        "operator":{
            "description":"The filter operation to use.",
            "type":"string",
            "default":"LIKE",
            "enum":[
                "eq",
                "ne",
                "gte",
                "gt",
                "lte",
                "lt",
                "LIKE",
                "NOT LIKE",
                "re",
                "not re",
                "NOT IN"
            ],
            "example":"eq"
        },
        "conjunction":{
            "description":"The conjunction between filters.",
            "type":"string",
            "default":"OR",
            "enum":[
                "AND",
                "OR"
            ],
            "example":"AND"
        }
    },
    "type":"object"
}

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
```

sort: object

The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format: { "property": "property", "direction": "direction" }

direction(required): string

Allowed Values: [ "ASC", "DESC" ]

The direction of the sort.

Example: ASC
property(required): string

The field to sort on.

Example: name

{
    "required":[
        "property",
        "direction"
    ],
    "properties":{
        "property":{
            "description":"The field to sort on.",
            "type":"string",
            "example":"name"
        },
        "direction":{
            "description":"The direction of the sort.",
            "type":"string",
            "enum":[
                "ASC",
                "DESC"
            ],
            "example":"ASC"
        }
    },
    "type":"object",
    "example":[
        {
            "property":"Name",
            "direction":"ASC"
        },
        {
            "property":"Value",
            "direction":"DESC"
        }
    ]
}

Example:

[
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]

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":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/gatewayGatewaysRead"
                    }
                }
            }
        }
    ]
}

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

Nested Schema : data

Type: array

Show Source

Array of: object gatewayGatewaysRead

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/gatewayGatewaysRead"
    }
}

Nested Schema : gatewayGatewaysRead

Type: object

Show Source

ConnectionType: string

Gateway Connection Type. Plain TCP Socket, SSH login or Telnet login.

Example: TCP socket
ConnectionTypeID: integer

Connection Type 0 => TCP Socket 1 => Telnet login 2 => SSH login

Example: 0
Delimiter: string

The message delimiter used by the gateway.

Example: ;
Description: string

Description of the Gateway.

Example:
DeviceID: integer

Unique identifier associated with the device name.

Example: 54
DeviceName: string

The Device Catalog entry associated to the Gateway, which is used for connection information.

Example: router.example.com
ElementCount: integer

Count of the Gateway Element.

Example: 1
Elements: array Elements

Selection of associated Network Elements for this gateway.
GatewayID: string

Unique identifier for the gateway.

Example: a433d205-4cae-45c3-a637-50b08840ea63
GatewayName: string

The name of the gateway, which must be unique within the database.

Example: Gateway1
NoPromptCheck: boolean

If Connection Type is set to "SSH Login" or "Telnet Login" and the TL1 device does not return a prompt on successful login, check this box.

Example: false
Password: string

If Connection Type is set to "SSH Login" or "Telnet Login", the password to use when connecting to Gateway.

Example: admin
Port: integer

Connection port.

Example: 9001
StatusID: integer

The gateway status ID. Either 0 (disabled) or 1 (enabled).

Example: 1
StatusName: string

The status of the gateway.

Example: Enabled
Username: string

If Connection Type is set to "SSH Login" or "Telnet Login", the username to use when connecting to Gateway.

Example: admin

{
    "properties":{
        "GatewayID":{
            "description":"Unique identifier for the gateway.",
            "type":"string",
            "example":"a433d205-4cae-45c3-a637-50b08840ea63"
        },
        "GatewayName":{
            "description":"The name of the gateway, which must be unique within the database.",
            "type":"string",
            "example":"Gateway1"
        },
        "Description":{
            "description":"Description of the Gateway.",
            "type":"string",
            "example":""
        },
        "Port":{
            "description":"Connection port.",
            "type":"integer",
            "example":9001
        },
        "Delimiter":{
            "description":"The message delimiter used by the gateway.",
            "type":"string",
            "example":";"
        },
        "DeviceID":{
            "description":"Unique identifier associated with the device name.",
            "type":"integer",
            "example":54
        },
        "DeviceName":{
            "description":"The Device Catalog entry associated to the Gateway, which is used for connection information.",
            "type":"string",
            "example":"router.example.com"
        },
        "ConnectionTypeID":{
            "description":"Connection Type\n0 => TCP Socket\n1 => Telnet login\n2 => SSH login",
            "type":"integer",
            "example":0
        },
        "ConnectionType":{
            "description":"Gateway Connection Type. Plain TCP Socket, SSH login or Telnet login.",
            "type":"string",
            "example":"TCP socket"
        },
        "NoPromptCheck":{
            "description":"If Connection Type is set to \"SSH Login\" or \"Telnet Login\" and the TL1 device does not return a prompt on successful login, check this box.",
            "type":"boolean",
            "example":false
        },
        "StatusID":{
            "description":"The gateway status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":1
        },
        "StatusName":{
            "description":"The status of the gateway.",
            "type":"string",
            "example":"Enabled"
        },
        "Username":{
            "description":"If Connection Type is set to \"SSH Login\" or \"Telnet Login\", the username to use when connecting to Gateway.",
            "type":"string",
            "example":"admin"
        },
        "Password":{
            "description":"If Connection Type is set to \"SSH Login\" or \"Telnet Login\", the password to use when connecting to Gateway.",
            "type":"string",
            "example":"admin"
        },
        "ElementCount":{
            "description":"Count of the Gateway Element.",
            "type":"integer",
            "example":1
        },
        "Elements":{
            "description":"Selection of associated Network Elements for this gateway.",
            "type":"array",
            "items":{
                "properties":{
                    "ElementID":{
                        "description":"Element ID",
                        "type":"string",
                        "example":"b1e9b165-5f05-4e41-8031-e9f7586a88f9"
                    },
                    "ElementName":{
                        "description":"Element Name",
                        "type":"string",
                        "example":"Element1"
                    }
                }
            },
            "example":[
                {
                    "ElementID":"b1e9b165-5f05-4e41-8031-e9f7586a88f9",
                    "ElementName":"Element1"
                }
            ]
        }
    },
    "type":"object"
}

Nested Schema : Elements

Type: array

Selection of associated Network Elements for this gateway.

Show Source

Array of: object items

{
    "description":"Selection of associated Network Elements for this gateway.",
    "type":"array",
    "items":{
        "properties":{
            "ElementID":{
                "description":"Element ID",
                "type":"string",
                "example":"b1e9b165-5f05-4e41-8031-e9f7586a88f9"
            },
            "ElementName":{
                "description":"Element Name",
                "type":"string",
                "example":"Element1"
            }
        }
    },
    "example":[
        {
            "ElementID":"b1e9b165-5f05-4e41-8031-e9f7586a88f9",
            "ElementName":"Element1"
        }
    ]
}

Example:

[
    {
        "ElementID":"b1e9b165-5f05-4e41-8031-e9f7586a88f9",
        "ElementName":"Element1"
    }
]

Nested Schema : items

Type: object

Show Source

ElementID: string

Element ID

Example: b1e9b165-5f05-4e41-8031-e9f7586a88f9
ElementName: string

Element Name

Example: Element1

{
    "properties":{
        "ElementID":{
            "description":"Element ID",
            "type":"string",
            "example":"b1e9b165-5f05-4e41-8031-e9f7586a88f9"
        },
        "ElementName":{
            "description":"Element Name",
            "type":"string",
            "example":"Element1"
        }
    }
}

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.