7.1.5　計画実行登録API

指定したジョブネットを計画実行登録します。

計画実行登録の詳細については，マニュアル「JP1/Automatic Job Management System 3 導入ガイド　4.1.1(2) 計画実行登録」を参照してください。

実行権限

ログインしたJP1ユーザーが，計画実行登録するユニットに対して，次に示すどれかのJP1権限が与えられている必要があります。

JP1_AJS_Admin権限
JP1_AJS_Manager権限
JP1_AJS_Operator権限

リクエストの形式

リクエスト行

POST /application/component/apiVersion/objects/definitions/unitName/actions/registerPlannedExec/invoke httpVersion

メッセージボディ

{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "serviceName":"スケジューラーサービス名",
    "passedDaemonStarts":"スケジューラーサービス起動時に予定時刻を超過していた場合の動作",
    "passedRegForExe":"実行登録時に予定時刻を超過していた場合の動作",
    "holding":ジョブネットの実行を保留するかどうか,
    "macro":[マクロ変数のオブジェクト,...]
  }
}

APIのバージョン

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

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

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

リソースを一意に識別する情報	データ型	説明	必須・任意
unitName	string	要求対象のユニットのユニット完全名を，1〜930バイトの文字列で指定します。	必須

パラメーター

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

表7‒5　計画実行登録APIのパラメーター一覧
パラメーター	データ型	値の説明	必須・任意
`manager`	string	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`serviceName`	string	スケジューラーサービス名を，1〜30バイトの文字列で指定します。	必須
`passedDaemonStarts`	string	スケジューラーサービス起動時に予定時刻を超過していた場合の動作を，定数`PlannedTimePassedType`に規定されている文字列定数で指定します。定数`PlannedTimePassedType`の詳細については，「7.4.3(1) PlannedTimePassedType」を参照してください。このパラメーターの指定は，スケジューラーサービスの起動モードがウォームスタートまたはディザスターリカバリースタートの場合だけ有効です。	必須
`passedRegForExe`	string	実行登録時に予定時刻を超過していた場合の動作を，定数`PlannedTimePassedType`に規定されている文字列定数で指定します。定数`PlannedTimePassedType`の詳細については，「7.4.3(1) PlannedTimePassedType」を参照してください。	必須
`holding`	boolean	計画実行登録時にジョブネットの実行を保留するかどうかを指定します。保留する場合は「`true`」を指定します。保留しない場合は「`false`」を指定します。「`true`」を指定した場合は，実行登録時に作成される実行世代に対して保留を設定します。このパラメーターを指定しなかった場合は，「`false`」が仮定されます。このパラメーターは，JP1/AJS3 - Web Consoleのバージョンが11-10以降，かつ接続先JP1/AJS3 - Managerのバージョンが11-10以降の場合だけ指定できます。バージョン情報の取得APIの戻り値（`productVersionNumber`）が111000以上，かつJP1/AJS3 - Managerのプロトコルバージョンの取得APIの戻り値（`protocolVersionNumber`）が1110以上であることを確認して，指定してください。バージョン情報の取得APIの詳細については，「7.1.37 バージョン情報の取得API」を参照してください。 JP1/AJS3 - Managerのプロトコルバージョンの取得APIの詳細については，「7.1.38 JP1/AJS3 - Managerのプロトコルバージョンの取得API」を参照してください。	任意
`macro`	object[]	ルートジョブネット配下のジョブで使用しているマクロ変数に設定する情報を，マクロ変数のオブジェクトの配列で指定します。マクロ変数のオブジェクトの詳細については，「7.3.5 マクロ変数オブジェクト」を参照してください。マクロ変数は32個まで指定できます。複数指定する場合，「マクロ変数名のバイト数＋引き継ぎ情報のバイト数＋4」の値が4,085以内になるよう指定してください。同じマクロ変数を複数指定した場合，最初に指定したマクロ変数の引き継ぎ情報が引き継がれます。マクロ変数を引き継ぐ場合だけ，このパラメーターを指定してください。マクロ変数を引き継がない場合は，このパラメーターを指定しないか，またはこのパラメーターに「`null」`を指定してください。	任意

ステータスコード

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

ステータスコード	テキスト記述	説明
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バイトです）

使用例1

指定したジョブネットを計画実行登録するAPIの使用例を次に示します。

リクエストの例

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

使用例2

マクロ変数を指定して，ジョブネットを計画実行登録するAPIの使用例を次に示します。

リクエストの例

POST /ajs/api/v1/objects/definitions/%2FJobGroup%2FJobnet/actions/registerPlannedExec/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "passedDaemonStarts":"IMMEDIATE",
    "passedRegForExe":"IMMEDIATE",
    "macro":[{"name":"AJS2KEY1","value":"1"},{"name":"AJS2KEY2","value":"2"}]
  }
}

使用例3

計画実行登録時にジョブネットの初回の実行開始を保留にするAPIの使用例を次に示します。

リクエストの例

POST /ajs/api/v1/objects/definitions/%2FJobGroup%2FJobnet/actions/registerPlannedExec/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "passedDaemonStarts":"IMMEDIATE",
    "passedRegForExe":"IMMEDIATE",
    "holding":true
  }
}

ページの先頭へ

7.1.5 計画実行登録API

7.1.5　計画実行登録API