Jump to

• Request
• Response

Update Server Roles

post

/api/broker/Servers/updateServerRoles

Updates the subroles for different roles of a server.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: array

Show Source

• Array of: array brokerServersUpdateServerRoles

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

Nested Schema : brokerServersUpdateServerRoles

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The database ID.",
                "type":"string",
                "example":"model-2"
            },
            "role":{
                "description":"Selected role name for which subrole is updated",
                "type":"string",
                "example":"Presentation"
            },
            "selected":{
                "description":"Denotes whether a particular subrole is selected for addition or de-selected for removal",
                "type":"boolean",
                "example":false
            },
            "ServerHostFQDN":{
                "description":"Server Host FQDN",
                "type":"string",
                "example":"server.example.com"
            },
            "serverID":{
                "description":"Server ID",
                "type":"integer",
                "example":1
            },
            "subrole":{
                "description":"Subrole name which is selected or de-selected",
                "type":"string",
                "example":"Internal"
            },
            "version":{
                "description":"Version of the Server",
                "type":"string",
                "example":"6.0.4"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id: string
  The database ID.

  Example: model-2
• role: string
  Selected role name for which subrole is updated

  Example: Presentation
• selected: boolean
  Denotes whether a particular subrole is selected for addition or de-selected for removal

  Example: false
• ServerHostFQDN: string
  Server Host FQDN

  Example: server.example.com
• serverID: integer
  Server ID

  Example: 1
• subrole: string
  Subrole name which is selected or de-selected

  Example: Internal
• version: string
  Version of the Server

  Example: 6.0.4

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The database ID.",
            "type":"string",
            "example":"model-2"
        },
        "role":{
            "description":"Selected role name for which subrole is updated",
            "type":"string",
            "example":"Presentation"
        },
        "selected":{
            "description":"Denotes whether a particular subrole is selected for addition or de-selected for removal",
            "type":"boolean",
            "example":false
        },
        "ServerHostFQDN":{
            "description":"Server Host FQDN",
            "type":"string",
            "example":"server.example.com"
        },
        "serverID":{
            "description":"Server ID",
            "type":"integer",
            "example":1
        },
        "subrole":{
            "description":"Subrole name which is selected or de-selected",
            "type":"string",
            "example":"Internal"
        },
        "version":{
            "description":"Version of the Server",
            "type":"string",
            "example":"6.0.4"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "message":{
                                "type":"string"
                            }
                        },
                        "example":{
                            "message":"InstallRole started"
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

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

{
    "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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "message":{
                        "type":"string"
                    }
                },
                "example":{
                    "message":"InstallRole started"
                }
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "message":{
                "type":"string"
            }
        },
        "example":{
            "message":"InstallRole started"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• message: string

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        }
    },
    "example":{
        "message":"InstallRole started"
    }
}

Example:

{
    "message":"InstallRole started"
}

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