REST API for Unified Assurance Core

Get Broker Services

get

/api/broker/Services

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

Response

Supported Media Types

application/json

200 Response

Successful operation

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

Nested Schema : data

Type: array

Show Source

Array of: object brokerServicesRead

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

Nested Schema : brokerServicesRead

Type: object

Show Source

ApplicationConfig: array ApplicationConfig

The array of JSON objects with the configuration values for the service.
BrokerServiceID: integer

The service ID.

Example: 1
ClusterID: integer

The cluster ID specified for redundancy.

Example: 0
Decouple: boolean

Allows for different combinations of primary/backup service pairings or pairing services across servers that are not tied together

Example: 1
FailoverType: integer
The failover type ID. Allowed Values:
- 0: Standalone
- 1: Primary
- 2: Backup
Example: 0
FailoverTypeName: string

The failover type name.

Example: Standalone
Last PID: integer

The last process ID of the running service.

Example: 4404
PackageName: string

The package name.

Example: presentation-app
PrimaryServerID: integer

The database ID that identifies the primary server of the given server type (presentation, collection, database) in Assure1.Servers table.

Example: 1
PrimaryServiceID: integer

The primary service ID specified for failover.

Example: 0
PrimaryServiceServerID: integer

The server ID of the server primarily responsible for the service.

Example: 1
Privileged: integer

Whether the process should be run as a privileged user (1) or not (0).

Example: 0
ServerID: integer

The server ID to which the service belongs.

Example: 1
ServerName: string

The server name.

Example: example.com
ServiceArguments: string

The optional service arguments.

Example: --ssl-ca=/ssl/BundleCA.crt
ServiceDescription: string

The optional service human-readable description.

Example: This is an example description
ServiceName: string

The service reference name.

Example: Data backup
ServiceProgram: string

The service program file location and the name relative to the Unified Assurance install directory.

Example: /opt/assure1
State: string

The service state.

Example: Running
StateIcon: string

The icon representing the service state.

Example: OrbGreenUp.png
Status: string

The status, based on the value of the StatusID property. When StatusID is 0, Status is Disabled. When StatusID is 1, Status is Enabled.

Example: Disabled
StatusIcon: string

The status image name based on the the statusID. If the statusID is 0, then the StatusIcon is OrbRed.png. If the statusID is 1, then the StatusIcon is OrbGreen.png.

Example: OrbRed.png
StatusID: integer

The server status ID. Either 0 (disabled) or 1 (enabled).

Example: 0

{
    "properties":{
        "BrokerServiceID":{
            "description":"The service ID.",
            "type":"integer",
            "example":"1"
        },
        "ServerID":{
            "description":"The server ID to which the service belongs.",
            "type":"integer",
            "example":"1"
        },
        "ServerName":{
            "description":"The server name.",
            "type":"string",
            "example":"example.com"
        },
        "PackageName":{
            "description":"The package name.",
            "type":"string",
            "example":"presentation-app"
        },
        "ServiceName":{
            "description":"The service reference name.",
            "type":"string",
            "example":"Data backup"
        },
        "ServiceDescription":{
            "description":"The optional service human-readable description.",
            "type":"string",
            "example":"This is an example description"
        },
        "ServiceProgram":{
            "description":"The service program file location and the name relative to the Unified Assurance install directory.",
            "type":"string",
            "example":"/opt/assure1"
        },
        "ServiceArguments":{
            "description":"The optional service arguments.",
            "type":"string",
            "example":"--ssl-ca=/ssl/BundleCA.crt"
        },
        "FailoverType":{
            "description":"The failover type ID.\nAllowed Values:\n<ul><li><b>0</b>: Standalone</li>\n<li><b>1</b>: Primary</li>\n<li><b>2</b>: Backup</li></ul>",
            "type":"integer",
            "example":"0"
        },
        "FailoverTypeName":{
            "description":"The failover type name.",
            "type":"string",
            "example":"Standalone"
        },
        "ClusterID":{
            "description":"The cluster ID specified for redundancy.",
            "type":"integer",
            "example":"0"
        },
        "PrimaryServiceID":{
            "description":"The primary service ID specified for failover.",
            "type":"integer",
            "example":"0"
        },
        "StatusID":{
            "description":"The server status ID. Either <b>0</b> (disabled) or <b>1</b> (enabled).",
            "type":"integer",
            "example":"0"
        },
        "Status":{
            "description":"The status, based on the value of the <b>StatusID</b> property. When <b>StatusID</b> is <b>0</b>, <b>Status</b> is <b>Disabled</b>. When <b>StatusID</b> is <b>1</b>, <b>Status</b> is <b>Enabled</b>.",
            "type":"string",
            "example":"Disabled"
        },
        "StatusIcon":{
            "description":"The status image name based on the the <b>statusID</b>. If the <b>statusID</b> is <b>0</b>, then the <b>StatusIcon</b> is <b>OrbRed.png</b>. If the <b>statusID</b> is <b>1</b>, then the <b>StatusIcon</b> is <b>OrbGreen.png</b>.",
            "type":"string",
            "example":"OrbRed.png"
        },
        "Privileged":{
            "description":"Whether the process should be run as a privileged user (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "Last PID":{
            "description":"The last process ID of the running service.",
            "type":"integer",
            "example":"4404"
        },
        "PrimaryServerID":{
            "description":"The database ID that identifies the primary server of the given server type (presentation, collection, database) in Assure1.Servers table.",
            "type":"integer",
            "example":"1"
        },
        "PrimaryServiceServerID":{
            "description":"The server ID of the server primarily responsible for the service.",
            "type":"integer",
            "example":"1",
            "nullable":true
        },
        "Decouple":{
            "description":"Allows for different combinations of primary/backup service pairings or pairing services across servers that are not tied together",
            "type":"boolean",
            "example":"1"
        },
        "ApplicationConfig":{
            "description":"The array of JSON objects with the configuration values for the service.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "Required":{
                        "description":"Whether the configuration value can be left blank or not.",
                        "type":"boolean",
                        "example":0
                    },
                    "BrokerApplicationConfigName":{
                        "description":"Name of the configuration option.",
                        "type":"string",
                        "example":"LogLevel"
                    },
                    "BrokerApplicationConfigValue":{
                        "description":"The value saved for the configuration option.",
                        "type":"string",
                        "example":"Error"
                    },
                    "BrokerApplicationConfigTypeID":{
                        "description":"The broker application configuration type ID.",
                        "type":"integer",
                        "example":1
                    }
                }
            }
        },
        "State":{
            "description":"The service state.",
            "type":"string",
            "example":"Running"
        },
        "StateIcon":{
            "description":"The icon representing the service state.",
            "type":"string",
            "example":"OrbGreenUp.png"
        }
    },
    "type":"object"
}

Nested Schema : ApplicationConfig

Type: array

The array of JSON objects with the configuration values for the service.

Show Source

Array of: object items

{
    "description":"The array of JSON objects with the configuration values for the service.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Required":{
                "description":"Whether the configuration value can be left blank or not.",
                "type":"boolean",
                "example":0
            },
            "BrokerApplicationConfigName":{
                "description":"Name of the configuration option.",
                "type":"string",
                "example":"LogLevel"
            },
            "BrokerApplicationConfigValue":{
                "description":"The value saved for the configuration option.",
                "type":"string",
                "example":"Error"
            },
            "BrokerApplicationConfigTypeID":{
                "description":"The broker application configuration type ID.",
                "type":"integer",
                "example":1
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

BrokerApplicationConfigName: string

Name of the configuration option.

Example: LogLevel
BrokerApplicationConfigTypeID: integer

The broker application configuration type ID.

Example: 1
BrokerApplicationConfigValue: string

The value saved for the configuration option.

Example: Error
Required: boolean

Whether the configuration value can be left blank or not.

Example: 0

{
    "type":"object",
    "properties":{
        "Required":{
            "description":"Whether the configuration value can be left blank or not.",
            "type":"boolean",
            "example":0
        },
        "BrokerApplicationConfigName":{
            "description":"Name of the configuration option.",
            "type":"string",
            "example":"LogLevel"
        },
        "BrokerApplicationConfigValue":{
            "description":"The value saved for the configuration option.",
            "type":"string",
            "example":"Error"
        },
        "BrokerApplicationConfigTypeID":{
            "description":"The broker application configuration type ID.",
            "type":"integer",
            "example":1
        }
    }
}

Default Response

Failed operation

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.