Jump to

• Request
• Response

Get States of Broker Servers

get

/api/broker/Servers/readStates

Gets the states of broker servers that match the specified parameters. If no parameters are specified, all broker server states are returned.

Request

Query Parameters

• ServerID: string
  The list of server IDs.

  Example:

  3,5,6

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

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

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/brokerServersReadStates"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object brokerServersReadStates

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

Nested Schema : brokerServersReadStates

Type: object

Show Source

• ServerID: integer
  The broker server ID.

  Example: 1
• State: string
  The indicator of the server state. Possible Values:

  • Running
  • Down

  Example: Running
• StateIcon: string
  The icon for representing the server state.

  Example: OrbGreenUp.png

{
    "type":"object",
    "properties":{
        "ServerID":{
            "description":"The broker server ID.",
            "type":"integer",
            "example":"1"
        },
        "State":{
            "description":"The indicator of the server state.          \nPossible Values: \n<ul><li>Running</li> \n<li>Down</li></ul>",
            "type":"string",
            "example":"Running"
        },
        "StateIcon":{
            "description":"The icon for representing the server state.",
            "type":"string",
            "example":"OrbGreenUp.png"
        }
    }
}

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