Hitachi

JP1 Version 12 JP1/Automatic Job Management System 3 Command Reference


7.1.4 Wait condition status list acquisition API

This API acquires a list of the wait conditions of the specified unit and the statuses of the units that are set in the wait conditions as the units to be waited for.

For details about waiting, see 2.2.5 Using wait conditions to control the order of unit 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 unit for which a list of the statuses of wait conditions is to be acquired:

  • JP1_AJS_Admin privileges

  • JP1_AJS_Manager privileges

  • JP1_AJS_Editor privileges

  • JP1_AJS_Operator privileges

  • JP1_AJS_Guest privileges

Request format
Request line
GET /application/component/apiVersion/objects/waiting/unitName:execID?query httpVersion
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

Parameter

The following table lists and describes the parameters that can be specified for query.

Table 7‒4: List of parameters for the Wait condition status list acquisition API

Parameter

Description of the value

Required?

manager

Specify the manager host name or IP address by using a character string in the range from 1 to 255 bytes.

Y

serviceName

Specify the scheduler service name by using a character string in the range from 1 to 30 bytes.

Y

Status code

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

Status code

Message

Description

200

OK

A list of the statuses of wait condition was acquired successfully.

400

Bad Request

The query character string 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.

Response format
Message Body
Wait resource
Return values

If the status code is 200, the wait resource is returned. For details about wait resource, see 7.2.2 Wait resource.

Example

The following shows an example of using the API to acquire a list of the statuses of wait conditions for the specified unit.

Example request:
GET /ajs/api/v1/objects/waiting/%2FJobGroup%2FJobnet01:%40A102?manager=HOSTM&serviceName=AJSROOT1 HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
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 02:07:28 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server
 
{
    "status":"NORMAL",
    "startDelayStatus":"NO",
    "nestStartDelayStatus":"NO",
    "endDelayStatus":"NO",
    "nestEndDelayStatus":"NO",
    "execSchedule":"NONE",
    "waitMethod":"AND",
    "noGenerationAction":"NOT_EXECUTE",
    "unmonitoredEndedAction":"NOT_EXECUTE",
    "abnomalEndedAction":"NOT_EXECUTE",
    "waitingTargetUnits":
    [
        {
            "status":"NORMAL",
            "startDelayStatus":"NO",
            "nestStartDelayStatus":"NO",
            "endDelayStatus":"NO",
            "nestEndDelayStatus":"NO",
            "execSchedule":"NONE",
            "unitName":"/JobGroup/Jobnet02",
            "execID":"@A103",
            "holdPlan":"NONE",
            "unitComment":"",
            "waitingStatus":"COMPLETE"
        }
    ],
    "unitName":"/JobGroup/Jobnet01",
    "execID":"@A102",
    "holdPlan":"NONE",
    "unitComment":""
}