Create a Job
post
/api/broker/Jobs
Creates a new job.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ApplicationConfig: array
ApplicationConfig
The array of JSON objects containing all the configuration values for the job.
-
Days: string
Scheduled Job cron-type Days to execute (* or comma delimited ints)Example:
1
-
FailoverType: integer
The failover type ID. Allowed Values: - 0 => Standalone - 1 => Primary - 2 => BackupExample:
0
-
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
-
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
-
StatusID: integer
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
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulAddOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Added record
-
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