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

Create a Job

post

/api/broker/Jobs

Creates a new job.
The minimum required properties in the request body are:
  • ServerID
  • PackageName
  • JobName
  • JobProgram
  • IsScheduled
  • Minutes
  • Hours
  • Days
  • Months
  • WeekDays
  • StatusID
  • FailoverType
  • Privileged
  • ApplicationConfig

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • ApplicationConfig
    The array of JSON objects containing all the configuration values for the job.
  • The days when the job is scheduled to run, in cron format. Use a comma-separated list of integers, or * to indicate every day.
    Example: 1
  • The failover type ID. Allowed Values:
    • 0: Standalone
    • 1: Primary
    • 2: Backup
    Example: 0
  • The hours when the job is scheduled to run, in cron format. Use 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.
    To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.
    Example: Data backup
  • The job program file location & name (Path of executable relative to $BASEDIR).
    Example: /opt/assure1
  • The minutes when the job is scheduled to run, in cron format. Use 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. Use 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
  • Whether the process should be run as a privileged user (1) or not (0).
    Example: 0
  • The server ID specified for job association.
    Example: 1
  • The job status ID. Either 0 (disabled) or 1 (enabled).
    Example: 0
  • The weekdays when the job is scheduled to run, in cron format. Use 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
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulAddOperation
Type: object
The response body for a successful add 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