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
-
conjunction:
string
-
limit: integer(int32)
The number of records to limit results by.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
-
direction(required):
string
-
start: integer(int32)
The page of results to start from.Default Value:
0
Example:1
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 : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : brokerServicesRead
Type:
Show Source
object
-
ApplicationConfig: array
ApplicationConfig
Array of JSON objects having all the configuration values for the service
-
BrokerServiceID: integer
The service ID.Example:
1
-
ClusterID: integer
Cluster ID specified for redundancyExample:
0
-
Decouple: boolean
Allows for different combinations of primary/backup service pairings or pairing services across servers that are not tied togetherExample:
1
-
FailoverType: integer
Failover Type ID Allowed Values: - 0 => Standalone - 1 => Primary - 2 => BackupExample:
0
-
FailoverTypeName: string
The failover type name.Example:
Standalone
-
Last PID: integer
Last Process ID of the running serviceExample:
4404
-
PackageName: string
The package name.Example:
presentation-app
-
PrimaryServerID: integer
DatabaseID identifying the primary server of the given server type (presentation, collection, database) in the Assure1.Servers tableExample:
1
-
PrimaryServiceID: integer
Primary Service ID specified for failoverExample:
0
-
PrimaryServiceServerID: integer
ServerID of the server primarily responsible for the serviceExample:
1
-
Privileged: integer
Whether the process should run as a privileged user Allowed Values: - 0 => No - 1 => YesExample:
0
-
ServerID: integer
The server ID the service belongs to.Example:
1
-
ServerName: string
The server name.Example:
pgbox.server.com
-
ServiceArguments: string
The optional service arguments.Example:
--ssl-ca=/ssl/BundleCA.crt
-
ServiceDescription: string
Optional Service human-readable descriptionExample:
This is an example description
-
ServiceName: string
Service reference NameExample:
Data backup
-
ServiceProgram: string
Service program file location & name relative to the Assure1 install directory.Example:
/opt/assure1
-
State: string
Indicator of the service stateExample:
Running
-
StateIcon: string
Icon for representing the Service state.Example:
OrbGreenUp.png
-
Status: string
Status based on StatusID. - If StatusID is 0, Status will be "Disabled" - If StatusID is 1, Status will be "Enabled"Example:
Disabled
-
StatusIcon: string
Status image name based on StatusID. - If StatusID is 0, StatusIcon will be "OrbRed.png" - If StatusID is 1, StatusIcon will be "OrbGreen.png"Example:
OrbRed.png
-
StatusID: integer
Status ID Allowed Values: - 0 => Disabled - 1 => EnabledExample:
0
Nested Schema : ApplicationConfig
Type:
array
Array of JSON objects having all the configuration values for the service
Show Source
Nested Schema : items
Type:
Show Source
object
-
BrokerApplicationConfigName: string
Name of the configuration option.Example:
LogLevel
-
BrokerApplicationConfigTypeID: integer
Broker Application Config Type IDExample:
1
-
BrokerApplicationConfigValue: string
The value saved for the configuration optionExample:
Error
-
Required: boolean
Indicates if the config value can be left blankExample:
0
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