7.1.7　即時実行登録API

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

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

実行権限

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

JP1_AJS_Admin権限
JP1_AJS_Manager権限
JP1_AJS_Operator権限

リクエストの形式

リクエスト行

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

メッセージボディ

{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "serviceName":"スケジューラーサービス名",
    "startCondition":起動条件パラメーターのオブジェクト,
    "holding":ジョブネットの実行を保留するかどうか,
    "macro":[マクロ変数のオブジェクト,...]
  }
}

APIのバージョン

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

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

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

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

パラメーター

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

表7‒7　即時実行登録APIのパラメーター一覧
パラメーター	データ型	値の説明	必須・任意
`manager`	string	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`serviceName`	string	スケジューラーサービス名を，1〜30バイトの文字列で指定します。	必須
`startCondition`	object	起動条件を使ってジョブネットを実行する場合，起動条件パラメーターオブジェクトを指定します。起動条件パラメーターオブジェクトの詳細については，「7.3.4 起動条件パラメーターオブジェクト」を参照してください。起動条件を指定しない場合は，このパラメーターを指定しないか，このパラメーターに「`null`」を指定してください。	任意
`holding`	boolean	即時実行登録時にジョブネットの実行を保留するかどうかを指定します。保留する場合は「`true`」を指定します。保留しない場合は「`false`」を指定します。このパラメーターを指定しなかった場合は，「`false`」が仮定されます。	任意
`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サーバ処理エラーが発生しました。

レスポンスの形式

レスポンスのメッセージボディ

{
  "execID":"実行ID"
}

戻り値

ステータスコードが「200」の場合，次の情報を返却します。

メンバー	データ型	説明
`execID`	string	実行IDを「`@[`mmmm`]{`A`〜`Z`}`nnnn」の形式で返却します（例：`@10A200`）。起動条件を指定している場合は監視世代の実行IDを返却します。

使用例1

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

リクエストの例

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

レスポンス（メッセージボディ）の例

{
  "execID": "@A2895"
}

使用例2

起動条件パラメーター（回数）とマクロ変数を指定して，ジョブネットを即時実行登録するAPIの使用例を次に示します。

リクエストの例

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

レスポンス（メッセージボディ）の例

{
  "execID": "@A2897"
}

使用例3

即時実行登録時にジョブネットの実行を保留にするAPIの使用例を次に示します。

リクエストの例

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

レスポンス（メッセージボディ）の例

{
  "execID": "@A100"
}

ページの先頭へ

7.1.7 即時実行登録API

7.1.7　即時実行登録API