7.1.4　待ち合わせ条件の状態一覧の取得API

指定されたユニットの待ち合わせ条件と，待ち合わせ条件に設定されている待ち合わせ対象ユニットの状態の一覧を取得します。

待ち合わせの詳細については，マニュアル「JP1/Automatic Job Management System 3 設計ガイド（業務設計編）　2.2.5 待ち合わせ条件を使用したユニットの実行順序制御」を参照してください。

実行権限

ログインしたJP1ユーザーが，待ち合わせ条件の状態一覧を取得するユニットに対して，次に示すどれかのJP1権限が与えられている必要があります。

JP1_AJS_Admin権限
JP1_AJS_Manager権限
JP1_AJS_Editor権限
JP1_AJS_Operator権限
JP1_AJS_Guest権限

リクエストの形式

リクエスト行

GET /application/component/apiVersion/objects/waiting/unitName:execID?query httpVersion

APIのバージョン

リソースを一意に識別する情報

リソースを一意に識別する情報を次の表に示します。

なお，パラメーターの指定に誤りがある場合，またはパラメーターを指定しなかった場合は，リソースを一意に識別できないため，ステータスコード「404」のエラーになります。

リソースを一意に識別する情報	データ型	説明	必須・任意
unitName	string	要求対象のユニットのユニット完全名を，1〜930バイトの文字列で指定します。	必須
execID	string	実行IDを，文字列で指定します。指定する形式は「`@[`mmmm`]{`A〜Z`}`nnnn」です（例：`@10A200`）。	必須

リソースを一意に識別する情報

データ型

説明

必須・任意

unitName

string

要求対象のユニットのユニット完全名を，1〜930バイトの文字列で指定します。

必須

execID

string

実行IDを，文字列で指定します。

指定する形式は「@[mmmm]{A〜Z}nnnn」です（例：@10A200）。

必須

パラメーター

「query」に指定するパラメーターを次の表に示します。

表7‒4　待ち合わせ条件の状態一覧の取得APIのパラメーター一覧
パラメーター	値の説明	必須・任意
`manager`	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`serviceName`	スケジューラーサービス名を，1〜30バイトの文字列で指定します。	必須

ステータスコード

レスポンスで返却するステータスコードを次の表に示します。

ステータスコード	メッセージ	説明
200	OK	待ち合わせ条件の状態一覧の取得に成功しました。
400	Bad Request	クエリ文字列が不正です。
401	Unauthorized	認証が必要です。
403	Forbidden	実行権限がありません。
404	Not found	リソースにアクセスする権限がありません。または，リソースがありません。
409	Conflict	リクエストは現在のリソースの状態と矛盾しているため，処理を続行できません。
412	Precondition failed	Web Consoleサーバが利用できません。
500	Server-side error	Web Consoleサーバ処理エラーが発生しました。

レスポンスの形式

メッセージボディ

待ち合わせのリソース

戻り値

ステータスコードが「200」の場合，待ち合わせのリソースを返却します。待ち合わせのリソースの詳細については，「7.2.2 待ち合わせのリソース」を参照してください。

使用例

指定したユニットの待ち合わせ条件の状態一覧を取得するAPIの使用例を次に示します。

リクエストの例

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==

レスポンスの例

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":""
}

ページの先頭へ

7.1.4 待ち合わせ条件の状態一覧の取得API

7.1.4　待ち合わせ条件の状態一覧の取得API