1. REST API for Unified Assurance Core
  2. Tasks
  3. Broker Control
  4. Jobs

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
  • 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.
    • Default Value: OR
      Allowed Values: [ "AND", "OR" ]
      The conjunction between filters.
      Example: AND
    • 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
    • The name of the field to filter on.
      Example: name
    • The value of the field to filter on.
      Example: test
  • The number of records to limit results by. If you do not also set the start parameter, records start at 0.
    Example:
    100
  • 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" }
    Example:
    [
    {
        "property":"Name",
        "direction":"ASC"
    },
    {
        "property":"Value",
        "direction":"DESC"
    }
]
  • 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.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : brokerJobsRead
Type: object
Show Source
  • ApplicationConfig
    The array of JSON objects containing all the configuration values for the job.
  • The job ID.
    Example: 1
  • The days when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or * to indicate every day.
    Example: 1
  • Allows for different combinations of primary/backup job pairings or pairing jobs across servers that are not tied together.
    Example: 1
  • The failover Type ID. Allowed Values:
    • 0: Standalone
    • 1: Primary
    • 2: Backup
    Example: 0
  • The failover type name.
    Example: Standalone
  • The hours when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or * to indicate every hour.
    Example: 1
  • Whether the job is scheduled (1) or not (0).
    Example: 0
  • The optional job program arguments.
    Example: --ssl-ca=/ssl/BundleCA.crt
  • The optional human-readable job description.
    Example: This is an example description
  • The job reference name.
    Example: Data backup
  • The job program file location and name (path of executable relative to $BASEDIR).
    Example: /opt/assure1
  • The minutes when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or * to indicate every minute.
    Example: 0
  • The months when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or * to indicate every month.
    Example: 2
  • The package name.
    Example: presentation-app
  • The primary job ID specified for failover.
    Example: 0
  • The server ID of the server primarily responsible for the job.
    Example: 1
  • The database ID that identifies the primary server of the given server type (presentation, collection, database) in Assure1.Servers table.
    Example: 1
  • Whether the process should be run as a privileged user (1) or not (o).
    Example: 0
  • The server ID specified for job association.
    Example: 1
  • The server name.
    Example: example.com
  • The indicator of the job state.
    Example: Running
  • The icon for representing the job states.
    Example: OrbGreenUp.png
  • 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
  • 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
  • The job status ID. Either 0 (disabled) or 1 (enabled).
    Example: 0
  • The weekdays when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or * to indicate every weekday.
    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: object
Show Source

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
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
An error.
Back to Top