7.1.18 Rerun API

This API reruns the specified unit.

For details on rerunning a unit, see 4.5.11 Rerunning a job or jobnet in the manual JP1/Automatic Job Management System 3 Overview.

You can use this API only when the JP1/AJS3 - Web Console version is 11-10 or later. Before using this API, make sure that the return value of the version information acquisition API (productVersionNumber) is 111000 or greater.

Execution privileges

The logged in JP1 user must have one of the following JP1 permissions for the unit to be rerun:

JP1_AJS_Admin privileges
JP1_AJS_Manager privileges
JP1_AJS_Operator privileges

Request format

Request line

POST /application/component/apiVersion/objects/statuses/unitName:execID/actions/rerun/invoke httpVersion

Message Body

{
  "parameters":{
    "manager":"manager-host-name-or-IP-address",
    "serviceName":"scheduler-service-name",
    "rerunMethod":"rerun-method",
    "rerunOptions":["rerun-options",...]
  }
}

API version

Information that uniquely identifies a resource

The table below describes the information that uniquely identifies a resource.

If a parameter is not specified or is specified incorrectly, an error with the status code 404 occurs because the resource cannot be uniquely identified.

Information that uniquely identifies a resource	Data type	Description	Required?
`unitName`	string	Specify the full name of the unit to be requested, by using a character string in the range from 1 to 930 bytes.	Y
`execID`	string	Specify the execution ID by using a character string in the format of `@[mmmm]{A` to `Z}nnnn` (for example, `@10A200`).	Y

Legend:: Y: Required

Parameter

The following table lists and describes the parameters that can be specified for parameters in the request message body.

Table 7‒18: List of parameters for the rerun API
Parameter	Data type	Description of the value	Required?
`manager`	string	Specify the manager host name or IP address by using a character string in the range from 1 to 255 bytes.	Y
`serviceName`	string	Specify the scheduler service name by using a character string in the range from 1 to 30 bytes.	Y
`rerunMethod`	string	Specify the rerun method by using a character constant. If the unit to rerun is a root jobnet, use a character string constant specified for the `RootRerunType` constant. For details about the `RootRerunType` constant, see 7.4.10(1) RootRerunType. If the unit to rerun is a nested jobnet or job, use a character string constant specified for the `RerunType` constant. For details about the `RerunType` constant, see 7.4.10(2) RerunType. If the specified value is not appropriate for the unit type, an error occurs.	Y
`rerunOptions`	string[]	Specify whether to hold the unit to rerun or place an abnormal preceding unit in the Ended with warning status, by using an array of the character constant specified for `RerunOption`. If you do not want to specify the rerun option, specify a null string array. For details about the `RerunOption` constant, see 7.4.10(3) RerunOption. If you do not specify this parameter or specify `null` for this parameter, the system assumes that none of the rerun options are specified. If a value that cannot be specified with the rerun method (`rerunMethod`) is specified or if the specified value is not appropriate for the unit type, an error occurs.	--

Legend:

Y: Required

--: Optional

Status code

The following table lists and describes the status codes returned as a response:

Status code	Message	Description
200	OK	The unit was rerun successfully.
400	Bad Request	The argument is invalid.
401	Unauthorized	Authentication is required.
403	Forbidden	The operator does not have execution permission.
404	Not found	The operator does not have access permission for the resource, or the resource does not exist.
409	Conflict	The processing cannot be continued because the request is inconsistent with the current resource status.
412	Precondition failed	The Web Console server is not available.
500	Server-side error	A processing error occurred in the Web Console server.

Return values

None (The size of the response message body is 0 bytes.)

Example 1

The following shows an example of using the API that reruns jobs from the first job of the specified root jobnet.

Example request:

POST /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet:%40A100/actions/rerun/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "rerunMethod":"TOP",
    "rerunOptions":[]
  }
}

Example response:

HTTP/1.1 200 OK
Content-Type: text/plain
Cache-Control: no-store, no-cache, max-age=0
Date: Mon, 08 Aug 2016 09:39:28 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server

Example 2

The following shows an example of using the API that reruns jobs by specifying the rerun options.

Example request:

POST /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet%2FJob:%40A100/actions/rerun/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "rerunMethod":"FROM",
    "rerunOptions":["HOLD","WARNING"]
  }
}

Example response:

HTTP/1.1 200 OK
Content-Type: text/plain
Cache-Control: no-store, no-cache, max-age=0
Date: Mon, 08 Aug 2016 09:39:28 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server

To Page Top