• 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/brokerJobsRead"
                    }
                }
            }
        }
    ]
}

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

• data: array data

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

• Array of: object brokerJobsRead

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

• 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
  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
• 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
  The failover Type ID. Allowed Values:

  • 0: Standalone
  • 1: Primary
  • 2: Backup

  Example: 0
• FailoverTypeName: string
  The failover type name.

  Example: Standalone
• Hours: string
  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
• IsScheduled: integer
  Whether the job is scheduled (1) or not (0).

  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 and name (path of executable relative to $BASEDIR).

  Example: /opt/assure1
• Minutes: string
  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
• Months: string
  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
• 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
  The database ID that identifies the primary server of the given server type (presentation, collection, database) in Assure1.Servers table.

  Example: 1
• Privileged: integer
  Whether the process should be run as a privileged user (1) or not (o).

  Example: 0
• ServerID: integer
  The server ID specified for job association.

  Example: 1
• ServerName: string
  The server name.

  Example: example.com
• State: string
  The indicator of the job state.

  Example: Running
• StateIcon: string
  The icon for representing the job states.

  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 job status ID. Either 0 (disabled) or 1 (enabled).

  Example: 0
• WeekDays: string
  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

{
    "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":"example.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 and 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 (<b>1</b>) or not (<b>0</b>).",
            "type":"integer",
            "example":"0"
        },
        "Minutes":{
            "description":"The minutes when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or <b>*</b> to indicate every minute.",
            "type":"string",
            "example":"0"
        },
        "Hours":{
            "description":"The hours when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or <b>*</b> to indicate every hour.",
            "type":"string",
            "example":"1"
        },
        "Days":{
            "description":"The days when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or <b>*</b> to indicate every day.",
            "type":"string",
            "example":"1"
        },
        "Months":{
            "description":"The months when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or <b>*</b> to indicate every month.",
            "type":"string",
            "example":"2"
        },
        "WeekDays":{
            "description":"The weekdays when the job is scheduled to run, in cron format. Can be a comma-separated list of integers, or <b>*</b> to indicate every weekday.",
            "type":"string",
            "example":"6"
        },
        "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"
        },
        "PrimaryJobID":{
            "description":"The primary job ID specified for failover.",
            "type":"integer",
            "example":"0"
        },
        "StatusID":{
            "description":"The job 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>o</b>).",
            "type":"integer",
            "example":"0"
        },
        "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"
        },
        "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":"The indicator of the job state.",
            "type":"string",
            "example":"Running"
        },
        "StateIcon":{
            "description":"The icon for representing the job states.",
            "type":"string",
            "example":"OrbGreenUp.png"
        }
    },
    "type":"object"
}

• 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":"Whether the configuration value can be left blank or not.",
                "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
            }
        }
    }
}

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

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

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