7.1.20　実行順序制御方式の変更API

ルートジョブネットの実行順序制御方式を一時的に変更します。

実行順序制御方式の詳細については，マニュアル「JP1/Automatic Job Management System 3 設計ガイド（業務設計編）　2.2.4 ジョブネットコネクタを使用したルートジョブネットの実行順序制御」を参照してください。

このAPIは，JP1/AJS3 - Web Consoleのバージョンが12-50以降のときに使用できます。バージョン情報の取得APIの戻り値（productVersionNumber）が125000以上であることを確認して，使用してください。

実行権限

ログインしたJP1ユーザーが，実行順序制御方式を変更するルートジョブネットに対して，次に示すどれかのJP1権限レベルが与えられている必要があります。

JP1_AJS_Admin権限
JP1_AJS_Manager権限
JP1_AJS_Operator権限

リクエストの形式

リクエスト行

POST /application/component/apiVersion/objects/statuses/unitName:execID/actions/changeExecOrderMethod/invoke httpVersion

メッセージボディ

{
  "parameters":{
    "manager":"マネージャーホスト名またはIPアドレス",
    "serviceName":"スケジューラーサービス名",
    "execOrderMethod":"変更後の実行順序制御方式"
  }
}

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）。

必須

パラメーター

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

表7‒20　実行順序制御方式の変更APIのパラメーター一覧
パラメーター	データ型	値の説明	必須・任意
`manager`	string	マネージャーホスト名またはIPアドレスを，1〜255バイトの文字列で指定します。	必須
`serviceName`	string	スケジューラーサービス名を，1〜30バイトの文字列で指定します。	必須
`execOrderMethod`	string	実行順序制御方式を同期に変更するか非同期に変更するかを，定数`ChangeExecOrderMethod`に規定されている文字列定数で指定します。定数`ChangeExecOrderMethod`の詳細については「7.4.15(1) ChangeExecOrderMethod」を参照してください。	必須

ステータスコード

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

ステータスコード	テキスト記述	説明
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/statuses/%2FJobGroup%2FJobnet:%40A111/actions/changeExecOrderMethod/invoke HTTP/1.1
Host: HOSTW:22252
Accept-Language: ja
Content-Type: application/json
X-AJS-Authorization: dXNlcjpwYXNzd29yZA==
 
{
  "parameters":{
    "manager":"HOSTM",
    "serviceName":"AJSROOT1",
    "execOrderMethod":"SYNC"
  }
}

ページの先頭へ

7.1.20 実行順序制御方式の変更API

7.1.20　実行順序制御方式の変更API