7.1.8 登録解除API
指定した実行登録中のジョブネットの登録を解除します。
登録解除の詳細については,マニュアル「JP1/Automatic Job Management System 3 導入ガイド 4.5.1 ジョブネットの登録を解除する」を参照してください。
- 実行権限
-
ログインしたJP1ユーザーが,登録解除するユニットに対して,次に示すどれかのJP1権限が与えられている必要があります。
-
JP1_AJS_Admin権限
-
JP1_AJS_Manager権限
-
JP1_AJS_Operator権限
-
- リクエストの形式
-
- リクエスト行
POST /application/component/apiVersion/objects/definitions/unitName/actions/cancelRegistration/invoke httpVersion
- メッセージボディ
{ "parameters":{ "manager":"マネージャーホスト名またはIPアドレス", "serviceName":"スケジューラーサービス名", "dateType":"暦日または実行日" "begin":"登録解除する期間の開始日" "end":"登録解除する期間の終了日" } }
- APIのバージョン
-
v1
- リソースを一意に識別する情報
-
リソースを一意に識別する情報を次の表に示します。
なお,パラメーターの指定に誤りがある場合,またはパラメーターを指定しなかった場合は,リソースを一意に識別できないため,ステータスコード「404」のエラーになります。
リソースを一意に識別する情報
データ型
説明
必須・任意
unitName
string
要求対象のユニットのユニット完全名を,1〜930バイトの文字列で指定します。
必須
- パラメーター
-
リクエストのメッセージボディのparametersに指定するパラメーターを次の表に示します。
表7‒8 登録解除APIのパラメーター一覧 パラメーター
データ型
値の説明
必須・任意
manager
string
マネージャーホスト名またはIPアドレスを,1〜255バイトの文字列で指定します。
必須
serviceName
string
スケジューラーサービス名を,1〜30バイトの文字列で指定します。
必須
dateType※1
string
実行登録を解除する期間を,暦日で指定するか実行日で指定するか,定数DateTypeに規定されている文字列定数で指定します。定数DateTypeの詳細については,「7.4.1(1) DateType」を参照してください。
実行登録を解除する期間を指定しない場合は,このパラメーターを指定しないか,このパラメーターに「null」を指定してください。
任意
begin※1
string
実行登録を解除する期間の開始日を,「YYYY-MM-DD」の形式で指定します。指定できる値を次に示します。
-
YYYY:年を指定します。
年に指定できる値は,次のとおりです。
JP1/AJS3 - Web Consoleのバージョンが13-00以降,かつ接続先JP1/AJS3 - Managerのバージョンが13-00以降の場合:
1994〜環境設定パラメーターSCHEDULELIMITに設定した値(単位:年)※2
上記以外の場合:
1994〜2036(単位:年)
-
MM:月を指定します。
月に指定できる値は,01〜12(単位:月)です。
-
DD:日にちを指定します。
日にちに指定できる値は,01〜指定した月の最終日(単位:日)です。
指定する年月日は,要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。
実行登録を解除する期間を指定しない場合は,このパラメーターを指定しないか,このパラメーターに「null」を指定してください。
任意
end※1
string
実行登録を解除する期間の終了日を,「YYYY-MM-DD」の形式で指定します。指定できる値を次に示します。
-
YYYY:年を指定します。
年に指定できる値は,次のとおりです。
JP1/AJS3 - Web Consoleのバージョンが13-00以降,かつ接続先JP1/AJS3 - Managerのバージョンが13-00以降の場合:
1994〜環境設定パラメーターSCHEDULELIMITに設定した値(単位:年)※2
上記以外の場合:
1994〜2036(単位:年)
-
MM:月を指定します。
月に指定できる値は,01〜12(単位:月)です。
-
DD:日にちを指定します。
日にちに指定できる値は,01〜指定した月の最終日(単位:日)です。
指定する年月日は,要求先JP1/AJS3 - Managerのスケジューラーサービスローカル日時で指定してください。
なお,このパラメーターには,パラメーターbeginで指定した年月日以降の値を指定してください。それより前の値を指定した場合は,エラーになります。
実行登録を解除する期間を指定しない場合は,このパラメーターを指定しないか,このパラメーターに「null」を指定してください。
任意
- 注※1
-
パラメーターdateType,begin,およびendをすべて省略した場合,指定したすべてのジョブネットの実行登録が解除されます。
期間を指定して実行登録を解除する場合は,パラメーターdateType,begin,およびendをすべて指定してください。どれか一つでも省略した場合,エラーになります。
- 注※2
-
接続先JP1/AJS3 - Managerの環境設定パラメーターSCHEDULELIMITの詳細については,マニュアル「JP1/Automatic Job Management System 3 構築ガイド 20.4.2(123) SCHEDULELIMIT」を参照してください。
また,JP1/AJS3 - Web Consoleのバージョンはバージョン情報の取得APIの戻り値(productVersionNumber)を,接続先JP1/AJS3 - Managerのバージョンは,JP1/AJS3 - Managerのプロトコルバージョンの取得APIの戻り値(protocolVersionNumber)を確認してください。
バージョン情報の取得APIの詳細については,「7.1.37 バージョン情報の取得API」を参照してください。
JP1/AJS3 - Managerのプロトコルバージョンの取得APIの詳細については,「7.1.38 JP1/AJS3 - Managerのプロトコルバージョンの取得API」を参照してください。
-
- ステータスコード
-
レスポンスで返却するステータスコードを次の表に示します。
ステータスコード
テキスト記述
説明
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/cancelRegistration/invoke HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja Content-type: application/json X-AJS-Authorization: dXNlcjpwYXNzd29yZA== { "parameters":{ "manager":"HOSTM", "serviceName":"AJSROOT1" } }
- 使用例2
-
期間を指定して,実行登録中のジョブネットの登録を解除するAPIの使用例を次に示します。
- リクエストの例
POST /ajs/api/v1/objects/definitions/%2FJobGroup%2FJobnet/actions/cancelRegistration/invoke HTTP/1.1 Host: HOSTW:22252 Accept-Language: ja Content-type: application/json X-AJS-Authorization: dXNlcjpwYXNzd29yZA== { "parameters":{ "manager":"HOSTM", "serviceName":"AJSROOT1", "dateType":"CALENDAR_DATE", "begin":"2015-09-09", "end":"2015-09-11" } }