Hitachi

JP1 Version 12 JP1/Automatic Job Management System 3 コマンドリファレンス


7.1.19 待ち合わせ状態の変更API

指定したユニットと,待ち合わせ条件で指定した待ち合わせ対象ユニットとの待ち合わせ状態を一時的に変更します。

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

実行権限

ログインしたJP1ユーザーが,待ち合わせ状態を変更するユニットに対して,次に示すどれかのJP1権限レベルが与えられている必要があります。

  • JP1_AJS_Admin権限

  • JP1_AJS_Manager権限

  • JP1_AJS_Operator権限

リクエストの形式
リクエスト行
POST /application/component/apiVersion/objects/waiting/unitName:execID/actions/changeWaiting/invoke httpVersion
メッセージボディ
{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "serviceName":"スケジューラーサービス名",
    "waitingTargetUnitName":"待ち合わせ対象ユニットのユニット完全名",
    "waitingStatusAction":"待ち合わせの有効化または無効化"
  }
}
APIのバージョン

v1

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

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

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

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

データ型

値の説明

必須・任意

unitName

string

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

必須

execID

string

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

指定する形式は「@[mmmm]{A〜Z}nnnn」です(例:@10A200

必須

パラメーター

リクエストのメッセージボディのparametersに指定するパラメーターを次の表に示します。

表7‒19 待ち合わせ状態の変更APIのパラメーター一覧

パラメーター

データ型

値の説明

必須・任意

manager

string

マネージャーホスト名またはIPアドレスを,1〜255バイトの文字列で指定します。

必須

serviceName

string

スケジューラーサービス名を,1〜30バイトの文字列で指定します。

必須

waitingTargetUnitName

string

待ち合わせ対象のユニットのユニット完全名を,1〜930バイトの文字列で指定します。

必須

waitingStatusAction

string

待ち合わせを有効にするか無効にするかを,定数WaitingStatusActionに規定されている文字列定数で指定します。定数WaitingStatusActionの詳細については「7.4.13(4) WaitingStatusAction」を参照してください。

必須

ステータスコード

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

ステータスコード

メッセージ

説明

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サーバ処理エラーが発生しました。

戻り値

なし(レスポンスのメッセージボディのサイズは0バイトです)

使用例

待ち合わせ状態を変更するAPIの使用例を次に示します。

リクエストの例
POST /ajs/api/v1/objects/waiting/%2FJobGroup%2FJobnet01:%40A104/actions/changeWaiting/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-Type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "waitingTargetUnitName":"/JobGroup/Jobnet02",
    "waitingStatusAction":"DISABLE"
  }
}
レスポンスの例
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-store, no-cache, max-age=0
Date: Wed, 26 Aug 2020 02:52:52 GMT
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Pragma: no-cache
Server: Cosminexus HTTP Server