Get Broker Service States
get
/api/broker/Services/readStates
Gets the states of broker services that match the specified parameters. If no parameters are specified, all broker service states are returned.
Request
Query Parameters
-
Servers(required): array[integer]
The array of server IDs.Example:
[ 3, 5 ]
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : brokerServicesReadStates
Type:
Show Source
object
-
BrokerServiceID: integer
Id of the Broker ServiceExample:
1
-
State: string
Indicator of the service stateExample:
Running
-
StateIcon: string
Icon for representing the service StatesExample:
OrbGreenUp.png
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object