Management API Reference for subsystem=batch-jberet

Children (1)

• job

Attributes (1)

• job-xml-names - A list of job XML job descriptors found for the deployment.

  Type	LIST
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of job XML job descriptors found for the deployment.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

Operations (3)

• restart-job - Restarts a batch job. Only jobs in a STOPPED or FAILED state can be restarted.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  execution-id	LONG	true	false		The execution id of the job to restart. This must be the most recent job execution id.
  properties	OBJECT	false	false		Optional properties to use when restarting the batch job.

  Reply properties

  Type

  LONG

  Raw DMR model

  { "operation-name" : "restart-job", "description" : "Restarts a batch job. Only jobs in a STOPPED or FAILED state can be restarted.", "request-properties" : { "execution-id" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The execution id of the job to restart. This must be the most recent job execution id.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }, "properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Optional properties to use when restarting the batch job.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } } }, "reply-properties" : {"type" : { "TYPE_MODEL_VALUE" : "LONG" }}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• start-job - Starts a batch job.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  job-xml-name	STRING	true	false		The name of the job XML descriptor to use when starting the job.
  properties	OBJECT	false	false		Optional properties to use when starting the batch job.

  Reply properties

  Type

  LONG

  Raw DMR model

  { "operation-name" : "start-job", "description" : "Starts a batch job.", "request-properties" : { "job-xml-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the job XML descriptor to use when starting the job.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "properties" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Optional properties to use when starting the batch job.", "expressions-allowed" : false, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } } }, "reply-properties" : {"type" : { "TYPE_MODEL_VALUE" : "LONG" }}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• stop-job - Stops a running batch job.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  execution-id	LONG	true	false		The execution id of the job to be stopped.

  Raw DMR model

  { "operation-name" : "stop-job", "description" : "Stops a running batch job.", "request-properties" : {"execution-id" : { "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The execution id of the job to be stopped.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min" : 1, "max" : 2147483647, "stability" : "default" }}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }