Jump to

• Request
• Response

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

  {
      "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.

  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"
  }

• 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 Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/brokerJobsRead"
                    }
                },
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object brokerJobsRead

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

Nested Schema : brokerJobsRead

Type: object

Show Source

• 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 together

  Example: 1
• FailoverType: integer
  Failover Type ID Allowed Values: - 0 => Standalone - 1 => Primary - 2 => Backup

  Example: 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 => Scheduled

  Example: 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 table

  Example: 1
• Privileged:
  Whether the process should run as a privileged user Allowed Values: - 0 => No - 1 => Yes type: integer

  Example: 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 state

  Example: Running
• StateIcon: string
  Icon for representing the job States

  Example: 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 => Enabled

  Example: 0
• WeekDays: string
  Scheduled Job cron-type WeekDays to execute (* or comma delimited ints)

  Example: 6

{
    "properties":{
        "BrokerJobID":{
            "description":"The job ID.",
            "type":"integer",
            "example":"1"
        },
        "ServerID":{
            "description":"The server ID specified for job association.",
            "type":"integer",
            "example":"1"
        },
        "ServerName":{
            "description":"The server name.",
            "type":"string",
            "example":"pgbox.server.com"
        },
        "PackageName":{
            "description":"The package name.",
            "type":"string",
            "example":"presentation-app"
        },
        "JobName":{
            "description":"The job reference name.",
            "type":"string",
            "example":"Data backup"
        },
        "JobDescription":{
            "description":"The optional human-readable job description.",
            "type":"string",
            "example":"This is an example description"
        },
        "JobProgram":{
            "description":"The job program file location & name (Path of executable relative to $BASEDIR).",
            "type":"string",
            "example":"/opt/assure1"
        },
        "JobArguments":{
            "description":"The optional job program arguments.",
            "type":"string",
            "example":"--ssl-ca=/ssl/BundleCA.crt"
        },
        "IsScheduled":{
            "description":"Whether the job is scheduled or not\nAllowed Values:\n- 0 => Not Scheduled\n- 1 => Scheduled",
            "type":"integer",
            "example":"0"
        },
        "Minutes":{
            "description":"Scheduled Job cron-type Minutes to execute (* or comma delimited ints)",
            "type":"string",
            "example":"0"
        },
        "Hours":{
            "description":"Scheduled Job cron-type Hours to execute (* or comma delimited ints)",
            "type":"string",
            "example":"1"
        },
        "Days":{
            "description":"Scheduled Job cron-type Days to execute (* or comma delimited ints)",
            "type":"string",
            "example":"1"
        },
        "Months":{
            "description":"Scheduled Job cron-type Months to execute (* or comma delimited ints)",
            "type":"string",
            "example":"2"
        },
        "WeekDays":{
            "description":"Scheduled Job cron-type WeekDays to execute (* or comma delimited ints)",
            "type":"string",
            "example":"6"
        },
        "FailoverType":{
            "description":"Failover Type ID\nAllowed Values:\n-  0 => Standalone\n-  1 => Primary\n-  2 => Backup",
            "type":"integer",
            "example":"0"
        },
        "FailoverTypeName":{
            "description":"The failover type name.",
            "type":"string",
            "example":"Standalone"
        },
        "PrimaryJobID":{
            "description":"The primary job ID specified for failover.",
            "type":"integer",
            "example":"0"
        },
        "StatusID":{
            "description":"The status ID.\nAllowed Values:\n-  0 => Disabled\n-  1 => Enabled",
            "type":"integer",
            "example":"0"
        },
        "Status":{
            "description":"The status based on StatusID. \n\n- If StatusID is 0, Status will be \"Disabled\".\n- If StatusID is 1, Status will be \"Enabled\".",
            "type":"string",
            "example":"Disabled"
        },
        "StatusIcon":{
            "description":"The status image name based on StatusID.\n\n- If StatusID is 0, StatusIcon will be \"OrbRed.png\".\n- If StatusID is 1, StatusIcon will be \"OrbGreen.png\".",
            "type":"string",
            "example":"OrbRed.png"
        },
        "Privileged":{
            "description":"Whether the process should run as a privileged user\nAllowed Values:\n- 0 => No\n- 1 => Yes\ntype: integer",
            "example":"0"
        },
        "PrimaryServerID":{
            "description":"DatabaseID identifying the primary server of the given server type (presentation, collection, database) in the Assure1.Servers table",
            "type":"integer",
            "example":"1"
        },
        "PrimaryJobServerID":{
            "description":"The server ID of the server primarily responsible for the job.",
            "type":"integer",
            "example":"1",
            "nullable":true
        },
        "Decouple":{
            "description":"Allows for different combinations of primary/backup job pairings or pairing jobs across servers that are not tied together",
            "type":"boolean",
            "example":"1"
        },
        "ApplicationConfig":{
            "$ref":"#/components/schemas/ApplicationConfig"
        },
        "State":{
            "description":"Indicator of the job state",
            "type":"string",
            "example":"Running"
        },
        "StateIcon":{
            "description":"Icon for representing the job States",
            "type":"string",
            "example":"OrbGreenUp.png"
        }
    },
    "type":"object"
}

Nested Schema : ApplicationConfig

Type: array

The array of JSON objects containing all the configuration values for the job.

Show Source

• Array of: object items

{
    "description":"The array of JSON objects containing all the configuration values for the job.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "Required":{
                "description":"Indicates if the configuration value can be left blank",
                "type":"boolean",
                "example":0
            },
            "BrokerApplicationConfigName":{
                "description":"The application configuration name.",
                "type":"string",
                "example":"LogLevel"
            },
            "BrokerApplicationConfigValue":{
                "description":"The application configuration value.",
                "type":"string",
                "example":"Error"
            },
            "BrokerApplicationConfigTypeID":{
                "description":"The application configuration type ID.",
                "type":"integer",
                "example":1
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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 blank

  Example: 0

{
    "type":"object",
    "properties":{
        "Required":{
            "description":"Indicates if the configuration value can be left blank",
            "type":"boolean",
            "example":0
        },
        "BrokerApplicationConfigName":{
            "description":"The application configuration name.",
            "type":"string",
            "example":"LogLevel"
        },
        "BrokerApplicationConfigValue":{
            "description":"The application configuration value.",
            "type":"string",
            "example":"Error"
        },
        "BrokerApplicationConfigTypeID":{
            "description":"The application configuration type ID.",
            "type":"integer",
            "example":1
        }
    }
}

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