Management API Reference for execution

The execution information for the job with the value of the path being the execution id.

Stability Level: default

Attributes (7)

batch-status - The status of the execution.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The status of the execution.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

create-time - The time the execution was created in ISO 8601 format.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The time the execution was created in ISO 8601 format.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

end-time - The time, in ISO 8601 format, the execution entered a status of: COMPLETED, STOPPED or FAILED

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The time, in ISO 8601 format, the execution entered a status of: COMPLETED, STOPPED or FAILED", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

exit-status - The exit status of the execution.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The exit status of the execution.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

instance-id - The instance id for the execution.

Type	LONG
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LONG" }, "description" : "The instance id for the execution.", "expressions-allowed" : false, "required" : true, "nillable" : false, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

last-updated-time - The time the execution was last updated in ISO 8601 format.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The time the execution was last updated in ISO 8601 format.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

start-time - The time the execution entered the STARTED status in ISO 8601 format.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The time the execution entered the STARTED status in ISO 8601 format.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

Operations (2)

restart-job - Restarts a batch job. Only jobs in a STOPPED or FAILED state can be restarted. This must also be the most recent job execution.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
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. This must also be the most recent job execution.",
    "request-properties" : {"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
}

stop-job - Stops a running batch job.

Raw DMR model


{
    "operation-name" : "stop-job",
    "description" : "Stops a running batch job.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}