Jump to

• Request
• Response

Update a Broker Server

put

/api/broker/Servers/{id}

Updates the broker server that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The broker server ID.

  Example:

  1

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

  Example: 1689091296
• BrokerLogLevel: integer
  The log level of 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 server custom name.

  Example: CustomServer
• 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
• ServerHostFQDN: string
  Server HostFQDN making request

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

  Example: EXL8
• StatusID: integer
  The status ID. |Allowed Values: | 0 => Disabled | 1 => Enabled

  Example: 1
• Timezone: string
  The server timezone.

  Example: GMT+5:30

{
    "type":"object",
    "properties":{
        "ServerHostFQDN":{
            "description":"Server HostFQDN making request",
            "type":"string",
            "example":"server.com"
        },
        "ServerPlatformName":{
            "description":"The server platform name.",
            "type":"string",
            "example":"EXL8"
        },
        "BootTime":{
            "description":"The boot time represented as Unix timestamp.",
            "type":"string",
            "example":"1689091296"
        },
        "CustomName":{
            "description":"The server custom name.",
            "type":"string",
            "example":"CustomServer"
        },
        "PrimaryServerID":{
            "description":"The primary server ID if this server is redundant.",
            "type":"integer",
            "example":"2"
        },
        "Timezone":{
            "description":"The server timezone.",
            "type":"string",
            "example":"GMT+5:30"
        },
        "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 broker on the server.\nAllowed Values:\n-  0 => OFF\n-  1 => FATAL\n-  2 => ERROR\n-  3 => WARN\n-  4 => INFO\n-  5 => DEBUG",
            "type":"integer",
            "example":"0"
        },
        "BrokerThreads":{
            "description":"The broker worker threads on the server.",
            "type":"integer",
            "example":"20"
        },
        "StatusID":{
            "description":"The status ID.\n|Allowed Values:\n|  0 => Disabled\n|  1 => Enabled",
            "type":"integer",
            "example":"1"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "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 : SuccessfulUpdateOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Updated record
• 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":"Updated record"
        }
    },
    "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
  Denotes whether it is a Database Server or not

  Example: No
• IsPresentation: string
  Denotes whether it 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
  Server Category Name denotes the server's primary role. Possible Values: - Collection - Database - Presentation

  Example: Primary
• ServerHostFQDN: string
  Server HostFQDN making request

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

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

  Example: EXL8
• State: string
  Indicator of the Server state

  Example: Unknown
• StatusID: integer
  The status ID. Allowed Values: - 0 => Disabled - 1 => Enabled

  Example: 1
• subroles: object subroles
  The object denoting different main server roles and their respective subroles.
• 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":"Server HostFQDN making request",
            "type":"string",
            "example":"server.com"
        },
        "IsPresentation":{
            "description":"Denotes whether it is a Presentation Server or not",
            "type":"string",
            "example":"No"
        },
        "IsDatabase":{
            "description":"Denotes whether it 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- 1 => Collection\n- 2 => Database\n- 3 => Presentation",
            "type":"integer",
            "example":"1"
        },
        "ServerCategoryName":{
            "description":"Server Category Name denotes the server's primary role. \n\nPossible Values: \n- Collection \n- Database \n- Presentation",
            "type":"string",
            "example":"Primary"
        },
        "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-  0 => OFF\n-  1 => FATAL\n-  2 => ERROR\n-  3 => WARN\n-  4 => INFO\n-  5 => DEBUG",
            "type":"integer",
            "example":"0"
        },
        "BrokerThreads":{
            "description":"The broker worker threads on the server.",
            "type":"integer",
            "example":"20"
        },
        "StatusID":{
            "description":"The status ID.\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"1"
        },
        "Version":{
            "description":"The version of the application under use.",
            "type":"string",
            "example":"6.0.4.0.0"
        },
        "State":{
            "description":"Indicator of 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":"Denotes whether a particular server role is selected",
                "type":"boolean",
                "example":1
            }
        }
    }
}

Nested Schema : subroles

Type: object

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

Show Source

• Cluster: array Cluster
  The array of available subroles for the server main role Cluster.
• Collection: array Collection
  Array of available subroles for the server main role Collection
• Database: array Database
  Array of available subroles for the server main role Database
• Presentation: array Presentation
  Array of available subroles for the server main role Presentation
• Processing: array Processing
  Array of available subroles for the server main role Processing
• Vision: array Vision
  Array of available subroles for the server main role Vision

{
    "description":"The object denoting different main server roles and their respective subroles.",
    "type":"object",
    "properties":{
        "Cluster":{
            "description":"The array of available subroles for the server main role Cluster.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "Collection":{
            "description":"Array of available subroles for the server main role Collection",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "Database":{
            "description":"Array of available subroles for the server main role Database",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "Presentation":{
            "description":"Array of available subroles for the server main role Presentation",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "Processing":{
            "description":"Array of available subroles for the server main role Processing",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "Vision":{
            "description":"Array of available subroles for the server main role Vision",
            "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
  Denotes whether a particular server role is selected

  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":"Denotes whether a particular server role is selected",
            "type":"boolean",
            "example":1
        }
    }
}

Nested Schema : Cluster

Type: array

The array of available subroles for the server main role Cluster.

Show Source

• Array of: string

{
    "description":"The array of available subroles for the server main role Cluster.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Collection

Type: array

Array of available subroles for the server main role Collection

Show Source

• Array of: string

{
    "description":"Array of available subroles for the server main role Collection",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Database

Type: array

Array of available subroles for the server main role Database

Show Source

• Array of: string

{
    "description":"Array of available subroles for the server main role Database",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Presentation

Type: array

Array of available subroles for the server main role Presentation

Show Source

• Array of: string

{
    "description":"Array of available subroles for the server main role Presentation",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Processing

Type: array

Array of available subroles for the server main role Processing

Show Source

• Array of: string

{
    "description":"Array of available subroles for the server main role Processing",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : Vision

Type: array

Array of available subroles for the server main role Vision

Show Source

• Array of: string

{
    "description":"Array of available subroles for the server main role Vision",
    "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":{
                "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