Jump to

• Request
• Response

Get Broker Servers

get

/api/broker/Servers

Gets the broker servers that match the specified parameters. If no parameters are specified, all broker servers 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.

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/brokerServersRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

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

Nested Schema : data

Type: array

Show Source

• Array of: object brokerServersRead

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

Nested Schema : brokerServersRead

Type: object

Show Source

• BootTime: string
  The boot time represented as a Unix timestamp.

  Example: 1689091296
• BrokerLogLevel: integer
  The log level of the broker on the server. Allowed Values:

  • 0: OFF
  • 1: FATAL
  • 2: ERROR
  • 3: WARN
  • 4: INFO
  • 5: DEBUG

  Example: 0
• BrokerThreads: integer
  The broker worker threads on the server.

  Example: 20
• CustomName: string
  The custom name of the server.

  Example: CustomServer
• IsDatabase: string
  Whether the server is a database server or not.

  Example: No
• IsPresentation: string
  Whether the server is a presentation server or not.

  Example: No
• LogRotateCount: integer
  The number of rotated logs to keep on the server.

  Example: 5
• LogRotateSize: number
  The minimum size in megabytes of the logs before rotation on the server.

  Example: 50
• PrimaryServerID: integer
  The primary server ID if this server is redundant.

  Example: 2
• RedundantServerCount: string
  The number of redundant servers.

  Example: 2
• roles: array roles
  The array of server roles.
• ServerCategoryID: integer
  The server category ID. Allowed Values:

  • 1: Collection
  • 2: Database
  • 3: Presentation

  Example: 1
• ServerCategoryName: string
  The primary role of the server. Possible Values:

  • Collection
  • Database
  • Presentation

  Example: Presentation
• ServerHostFQDN: string
  The server host FQDN making request.

  Example: server.com
• ServerID: integer
  The server ID.

  Example: 1
• ServerPlatformName: string
  The server platform name.

  Example: EXL8
• State: string
  The server state.

  Example: Unknown
• StatusID: integer
  The server status ID. Either 0 (disabled) or 1 (enabled).

  Example: 1
• subroles: object subroles
  The object denoting different main server roles and their respective sub roles.
• Timezone: string
  The server timezone.

  Example: GMT+5:30
• Version: string
  The version of the application under use.

  Example: 6.0.4.0.0
• ZoneID: integer
  The zone ID.

  Example: 1

{
    "type":"object",
    "properties":{
        "ServerID":{
            "description":"The server ID.",
            "type":"integer",
            "example":"1"
        },
        "PrimaryServerID":{
            "description":"The primary server ID if this server is redundant.",
            "type":"integer",
            "example":"2"
        },
        "ServerPlatformName":{
            "description":"The server platform name.",
            "type":"string",
            "example":"EXL8"
        },
        "CustomName":{
            "description":"The custom name of the server.",
            "type":"string",
            "example":"CustomServer"
        },
        "ServerHostFQDN":{
            "description":"The server host FQDN making request.",
            "type":"string",
            "example":"server.com"
        },
        "IsPresentation":{
            "description":"Whether the server is a presentation server or not.",
            "type":"string",
            "example":"No"
        },
        "IsDatabase":{
            "description":"Whether the server is a database server or not.",
            "type":"string",
            "example":"No"
        },
        "BootTime":{
            "description":"The boot time represented as a Unix timestamp.",
            "type":"string",
            "example":"1689091296"
        },
        "ServerCategoryID":{
            "description":"The server category ID.\nAllowed Values:\n<ul><li><b>1</b>: Collection</li>\n<li><b>2</b>: Database</li>\n<li><b>3</b>: Presentation</li></ul>",
            "type":"integer",
            "example":"1"
        },
        "ServerCategoryName":{
            "description":"The primary role of the server. \n\nPossible Values: \n<ul><li>Collection</li>\n<li>Database</li>\n<li>Presentation</li></ul>",
            "type":"string",
            "example":"Presentation"
        },
        "Timezone":{
            "description":"The server timezone.",
            "type":"string",
            "example":"GMT+5:30"
        },
        "ZoneID":{
            "description":"The zone ID.",
            "type":"integer",
            "example":"1"
        },
        "LogRotateCount":{
            "description":"The number of rotated logs to keep on the server.",
            "type":"integer",
            "example":"5"
        },
        "LogRotateSize":{
            "description":"The minimum size in megabytes of the logs before rotation on the server.",
            "type":"number",
            "example":"50"
        },
        "BrokerLogLevel":{
            "description":"The log level of the broker on the server.\nAllowed Values:\n<ul><li><b>0</b>: OFF</li>\n<li><b>1</b>: FATAL</li>\n<li><b>2</b>: ERROR</li>\n<li><b>3</b>: WARN</li>\n<li><b>4</b>: INFO</li>\n<li><b>5</b>: DEBUG</li></ul>",
            "type":"integer",
            "example":"0"
        },
        "BrokerThreads":{
            "description":"The broker worker threads on the server.",
            "type":"integer",
            "example":"20"
        },
        "StatusID":{
            "description":"The server status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"1"
        },
        "Version":{
            "description":"The version of the application under use.",
            "type":"string",
            "example":"6.0.4.0.0"
        },
        "State":{
            "description":"The server state.",
            "type":"string",
            "example":"Unknown"
        },
        "RedundantServerCount":{
            "description":"The number of redundant servers.",
            "type":"string",
            "example":"2"
        },
        "roles":{
            "$ref":"#/components/schemas/roles"
        },
        "subroles":{
            "$ref":"#/components/schemas/subroles"
        }
    }
}

Nested Schema : roles

Type: array

The array of server roles.

Show Source

• Array of: object items

{
    "description":"The array of server roles.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The server role ID.",
                "type":"integer",
                "example":2
            },
            "role":{
                "description":"The role name.",
                "type":"string",
                "example":"Cluster"
            },
            "subrole":{
                "description":"The sub role name.",
                "type":"string",
                "example":"Internal"
            },
            "version":{
                "description":"The version of the application under use.",
                "type":"string",
                "example":"6.0.4.0.0"
            },
            "serverID":{
                "description":"The server ID.",
                "type":"integer",
                "example":4
            },
            "selected":{
                "description":"Whether the server role is selected or not.",
                "type":"boolean",
                "example":1
            }
        }
    }
}

Nested Schema : subroles

Type: object

The object denoting different main server roles and their respective sub roles.

Show Source

• Cluster: array Cluster
  The array of available sub roles for the main cluster server role.
• Collection: array Collection
  The array of available sub roles for the main collection server role.
• Database: array Database
  The array of available sub roles for the main server role database.
• Presentation: array Presentation
  The array of available sub roles for the main presentation server role.
• Processing: array Processing
  The array of available sub roles for the main processing server role.
• Vision: array Vision
  The array of available sub roles for the main Vision server role.

{
    "description":"The object denoting different main server roles and their respective sub roles.",
    "type":"object",
    "properties":{
        "Cluster":{
            "description":"The array of available sub roles for the main cluster server role.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "Collection":{
            "description":"The array of available sub roles for the main collection server role.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "Database":{
            "description":"The array of available sub roles for the main server role database.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "Presentation":{
            "description":"The array of available sub roles for the main presentation server role.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "Processing":{
            "description":"The array of available sub roles for the main processing server role.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "Vision":{
            "description":"The array of available sub roles for the main Vision server role.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id: integer
  The server role ID.

  Example: 2
• role: string
  The role name.

  Example: Cluster
• selected: boolean
  Whether the server role is selected or not.

  Example: 1
• serverID: integer
  The server ID.

  Example: 4
• subrole: string
  The sub role name.

  Example: Internal
• version: string
  The version of the application under use.

  Example: 6.0.4.0.0

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The server role ID.",
            "type":"integer",
            "example":2
        },
        "role":{
            "description":"The role name.",
            "type":"string",
            "example":"Cluster"
        },
        "subrole":{
            "description":"The sub role name.",
            "type":"string",
            "example":"Internal"
        },
        "version":{
            "description":"The version of the application under use.",
            "type":"string",
            "example":"6.0.4.0.0"
        },
        "serverID":{
            "description":"The server ID.",
            "type":"integer",
            "example":4
        },
        "selected":{
            "description":"Whether the server role is selected or not.",
            "type":"boolean",
            "example":1
        }
    }
}

Nested Schema : Cluster

Type: array

The array of available sub roles for the main cluster server role.

Show Source

• Array of: string

{
    "description":"The array of available sub roles for the main cluster server role.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Collection

Type: array

The array of available sub roles for the main collection server role.

Show Source

• Array of: string

{
    "description":"The array of available sub roles for the main collection server role.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Database

Type: array

The array of available sub roles for the main server role database.

Show Source

• Array of: string

{
    "description":"The array of available sub roles for the main server role database.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Presentation

Type: array

The array of available sub roles for the main presentation server role.

Show Source

• Array of: string

{
    "description":"The array of available sub roles for the main presentation server role.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Processing

Type: array

The array of available sub roles for the main processing server role.

Show Source

• Array of: string

{
    "description":"The array of available sub roles for the main processing server role.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Vision

Type: array

The array of available sub roles for the main Vision server role.

Show Source

• Array of: string

{
    "description":"The array of available sub roles for the main Vision server role.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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