7.1.16 Interrupt API

This API interrupts the specified root jobnet being executed.

For details about interruption, see 4.5.9 Interrupting a 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 interrupted:

• 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/interrupt/invoke httpVersion

Message Body

{
  "parameters":{
    "manager":"manager-host-name-or-IP-address",
    "serviceName":"scheduler-service-name"
  }
}

API version

v1

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‒16: List of parameters for the interrupt 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

Legend:

Y: Required

Status code

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

Status code	Text description	Description
200	OK	The unit was interrupted 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

The following shows an example of using the API that interrupts the specified root jobnet being executed.

Example request:

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

To Page Top