7.1.20 Execution order control method change API
This API temporarily changes the execution order control method for the specified root jobnet.
For details about methods for controlling the execution order, see 2.2.4 Using jobnet connectors to control the order of root jobnet execution in the JP1/Automatic Job Management System 3 System Design (Work Tasks) Guide.
- Execution privileges
-
The logged-in JP1 user must have one of the following JP1 permissions for the root jobnet for which the execution order control method is to be changed:
-
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/changeExecOrderMethod/invoke httpVersion
- Message Body
{ "parameters":{ "manager":"manager-host-name-or-IP-address", "serviceName":"scheduler-service-name", "execOrderMethod":"new-execution-order-control-method" } }
- 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 of the value
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
- Parameter
-
The following table lists and describes the parameters that can be specified for parameters in the request message body.
Table 7‒20: List of parameters for the Execution order control method change 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
execOrderMethod
string
Specify whether to change the execution order control method to the synchronous method or the asynchronous method by using a character string constant that is supported by the ChangeExecOrderMethod constant. For details about the ChangeExecOrderMethod constant, see 7.4.15(1) ChangeExecOrderMethod.
Y
- Status code
-
The following table lists and describes the status codes returned as a response:
Status code
Message
Description
200
OK
The execution order control method was changed 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 to change the execution order control method for the specified root jobnet to synchronous method.
- Example request:
POST /ajs/api/v1/objects/statuses/%2FJobGroup%2FJobnet:%40A111/actions/changeExecOrderMethod/invoke HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja Content-Type: application/json X-AJS-Authorization: dXNlcjpwYXNzd29yZA== { "parameters":{ "manager":"HOSTM", "serviceName":"AJSROOT1", "execOrderMethod":"SYNC" } }
- Example response:
HTTP/1.1 200 OK Content-Type: application/json Cache-Control: no-store, no-cache, max-age=0 Date: Wed, 26 Aug 2020 06:10:42 GMT Expires: Thu, 01 Jan 1970 00:00:00 GMT Pragma: no-cache Server: Cosminexus HTTP Server