Get Jobs
get
/api/broker/Jobs
Gets the jobs that match the specified parameters. If no parameters are specified, all jobs 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 : brokerJobsRead
Type:
Show Source
object
-
ApplicationConfig: array
ApplicationConfig
The array of JSON objects containing all the configuration values for the job.
-
BrokerJobID: integer
The job ID.Example:
1
-
Days: string
Scheduled Job cron-type Days to execute (* or comma delimited ints)Example:
1
-
Decouple: boolean
Allows for different combinations of primary/backup job pairings or pairing jobs 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
-
Hours: string
Scheduled Job cron-type Hours to execute (* or comma delimited ints)Example:
1
-
IsScheduled: integer
Whether the job is scheduled or not Allowed Values: - 0 => Not Scheduled - 1 => ScheduledExample:
0
-
JobArguments: string
The optional job program arguments.Example:
--ssl-ca=/ssl/BundleCA.crt
-
JobDescription: string
The optional human-readable job description.Example:
This is an example description
-
JobName: string
The job reference name.Example:
Data backup
-
JobProgram: string
The job program file location & name (Path of executable relative to $BASEDIR).Example:
/opt/assure1
-
Minutes: string
Scheduled Job cron-type Minutes to execute (* or comma delimited ints)Example:
0
-
Months: string
Scheduled Job cron-type Months to execute (* or comma delimited ints)Example:
2
-
PackageName: string
The package name.Example:
presentation-app
-
PrimaryJobID: integer
The primary job ID specified for failover.Example:
0
-
PrimaryJobServerID: integer
The server ID of the server primarily responsible for the job.Example:
1
-
PrimaryServerID: integer
DatabaseID identifying the primary server of the given server type (presentation, collection, database) in the Assure1.Servers tableExample:
1
-
Privileged:
Whether the process should run as a privileged user Allowed Values: - 0 => No - 1 => Yes type: integerExample:
0
-
ServerID: integer
The server ID specified for job association.Example:
1
-
ServerName: string
The server name.Example:
pgbox.server.com
-
State: string
Indicator of the job stateExample:
Running
-
StateIcon: string
Icon for representing the job StatesExample:
OrbGreenUp.png
-
Status: string
The status based on StatusID. - If StatusID is 0, Status will be "Disabled". - If StatusID is 1, Status will be "Enabled".Example:
Disabled
-
StatusIcon: string
The 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
The status ID. Allowed Values: - 0 => Disabled - 1 => EnabledExample:
0
-
WeekDays: string
Scheduled Job cron-type WeekDays to execute (* or comma delimited ints)Example:
6
Nested Schema : ApplicationConfig
Type:
array
The array of JSON objects containing all the configuration values for the job.
Show Source
Nested Schema : items
Type:
Show Source
object
-
BrokerApplicationConfigName: string
The application configuration name.Example:
LogLevel
-
BrokerApplicationConfigTypeID: integer
The application configuration type ID.Example:
1
-
BrokerApplicationConfigValue: string
The application configuration value.Example:
Error
-
Required: boolean
Indicates if the configuration 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