Start a Job
get
/api/broker/Jobs/executeStart
Starts the job that matches the specified JobID and JobName.
Request
Query Parameters
-
id: integer
The job ID.Example:
24 -
name: string
The job name.Example:
Test Job
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
objectThe response body for a successful get operation.
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
Nested Schema : type
Type:
Show Source
object-
data: object
data
Additional Properties Allowed: additionalProperties
Nested Schema : data
Type:
objectAdditional Properties Allowed
Show Source
-
string
Uses the format "ServerName/JobName" as the property or key and status of the job or process as the value.
Example:
{
"server.com/testJobName":"Process queued to start"
}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:
arrayThe list of errors reported. Validation errors will be keyed by record field.
Show Source
-
Array of:
object items
An error.
Nested Schema : items
Type:
objectAn error.