Update Server Roles
post
/api/broker/Servers/updateServerRoles
Updates the subroles for different roles of a server.
The minimum required properties in each brokerServersUpdateServerRoles item in the request body are:
The minimum required properties in each brokerServersUpdateServerRoles item in the request body are:
- ServerHostFQDN
- role
- subrole
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Nested Schema : items
Type:
Show Source
object-
id: string
The database ID.Example:
model-2 -
role: string
The name of the role to update a sub role for.Example:
Presentation -
selected: boolean
Whether the sub role should be selected (added) (true) or deselected (removed) (false).Example:
false -
ServerHostFQDN: string
The server host FQDN.Example:
server.example.com -
serverID: integer
The server ID.Example:
1 -
subrole: string
The name of the sub role to select or de-select.Example:
Internal -
version: string
The version of the server.Example:
6.0.4
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulAddOperation
The response body for a successful add operation.
-
object
type
Nested Schema : SuccessfulAddOperation
Type:
objectThe response body for a successful add operation.
Show Source
-
message: string
The response message.Example:
Added record -
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
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:
arrayThe list of errors reported. Validation errors will be keyed by record field.
Show Source
-
Array of:
object items
An error.
Nested Schema : items
Type:
objectAn error.